Entity Endpoint Summary
Find Entity(s)
GET
https://companyid.infinisuite.com/api/account
Retrieves one or many entities.
Path Parameters
Name | Type | Description |
---|---|---|
rowid | number | RowID for this entity. If the RowID is omitted all entities are returned. If a filter is present then only entities that meet the filter criteria are returned. |
Query Parameters
Name | Type | Description |
---|---|---|
apikey | string | An apikey created by a system admin. Either a valid apikey or token are required. |
rowid | number | RowID for this entity |
filter | object | A valid REST Filter in JSON format. |
Headers
Name | Type | Description |
---|---|---|
apikey | string | An apikey created by a system admin. Either a valid apikey or token are required. The API Key can also be passed as a query parameter. |
token | string | Authentication token created with /login/gettoken using valid user credentials for the company you want to access: companyid, userid, password. The user must be setup as an 'API only' user. Either a valid token or apikey are required. |
Create Entity
POST
https://companyid.infinisuite.com/api/account
Headers
Name | Type | Description |
---|---|---|
token | string | Authentication token created with /login/gettoken using valid user credentials for the company you want to access: companyid, userid, password. The user must be setup as an 'API only' user. Either a valid token or apikey are required. |
apikey | string | An apikey created by a system admin. Either a valid apikey or token are required. The API Key can also be passed as a query parameter. |
Request Body
Name | Type | Description |
---|---|---|
{fields} | object | An JSON object containing any field or fields for this entity. |
Update Entity
PUT
https://companyid.infinisuite.com/api/account
Path Parameters
Name | Type | Description |
---|---|---|
string |
Headers
Name | Type | Description |
---|---|---|
token | string | Authentication token created with /login/gettoken using valid user credentials for the company you want to access: companyid, userid, password. The user must be setup as an 'API only' user. Either a valid token or apikey are required. |
apikey | string | An apikey created by a system admin. Either a valid apikey or token are required. The API Key can also be passed as a query parameter. |
Request Body
Name | Type | Description |
---|---|---|
{fields} | string | An JSON object containing any field or fields for this entity. The object must contain the RowID. |
Delete Entity
DELETE
https://companyid.infinisuite.com/api/account
Path Parameters
Name | Type | Description |
---|---|---|
RowID | string | The RowID of the entity. |
Headers
Name | Type | Description |
---|---|---|
apikey | string | An apikey created by a system admin. Either a valid apikey or token are required. The API Key can also be passed as a query parameter. |
token | string | Authentication token created with /login/gettoken using valid user credentials for the company you want to access: companyid, userid, password. The user must be setup as an 'API only' user. Either a valid token or apikey are required. |
Count Entities
GET
https://companyid.infinisuite.com/api/account/count
Headers
Name | Type | Description |
---|---|---|
apikey | string | An apikey created by a system admin. Either a valid apikey or token are required. The API Key can also be passed as a query parameter. |
token | string | Authentication token created with /login/gettoken using valid user credentials for the company you want to access: companyid, userid, password. The user must be setup as an 'API only' user. Either a valid token or apikey are required. |
Last updated