Operation Definitions
GET /companies/COMPANY_ID/people
Request Parameters
In | Field Name | Type | Required | Description |
|---|---|---|---|---|
header |
| string | Yes | An integrator or access token |
query |
| string | Yes | The company identifier provided by us |
query |
| integer (int32) | Yes | The maximum number of records to return |
query |
| integer (int32) | Yes | The number of records to skip before returning records |
query |
| string | No | A substring of the name attribute |
query |
| boolean | No | A boolean that sets whether to include deactivated accounts in the response. Set the value to "True" to include inactive accounts. |
Responses
Code | Description | Schema |
|---|---|---|
200 | Success Response Content: Items array of people objects | |
403 | Error Response Message: Permission denied | |
404 | Error Response Message: Site not found | |
Default | Error Response Message: Unexpected error |
Sample Success Response Body
{
"total": 2,
"items": [
{
"receives_notifications": false,
"roles": [
{
"role_name": "Register Login Only",
"role_id": "9999999999999999"
}
],
"email": "pos@company.com",
"is_confirmed": true,
"id": "9999999999999999",
"name": "PC101",
"preferred_language": "en-US"
},
{
"receives_notifications": false,
"roles": [
{
"role_name": "Operator",
"role_id": "9999999999999999"
},
{
"role_name": "Company Owner",
"role_id": "9999999999999999"
}
],
"email": "user.user@company.com",
"is_confirmed": true,
"id": "9999999999999999",
"name": "9999999999",
"preferred_language": "en-US"
}
]
}GET /companies/COMPANY_ID/sites
Request Parameters
In | Field Name | Type | Required | Description |
|---|---|---|---|---|
header |
| string | Yes | An integrator or access token |
query |
| string | Yes | The company identifier provided by us |
query |
| integer (int32) | Yes | The maximum number of records to return |
query |
| integer (int32) | Yes | The number of records to skip before returning records |
query |
| string | No | A substring of the name attribute |
query |
| boolean | No | A boolean that sets whether to include deactivated sites in the response. Set the value to "True" to include inactive sites. |
Responses
Code | Description | Schema |
|---|---|---|
200 | Success Response Content: Items array of site objects | |
403 | Error Response Message: Permission denied | |
404 | Error Response Message: Site not found | |
Default | Error Response Message: Unexpected error |
Sample Success Response Body
{
"total": 2,
"items": [
{
"id": 0,
"name": "string",
"phone_settings": {
"code": "string",
"number": "string",
"country": "string"
},
"website": "string",
"email": "user@example.com",
"store_number": "string",
"company": {
"id": "string",
"name": "string",
"is_active": true,
"created_at": "string",
"created_by": "string",
"updated_at": "string",
"updated_by": "string",
"subscriptions": [
{
"product": "string",
"count": 0,
"name": "string",
"external_data": {},
"is_active": true,
"active": true
}
]
},
"subscriptions": [
"string"
],
"location": {
"address_1": "string",
"address_2": "string",
"city": "string",
"state": "string",
"zip": "string",
"formatted_address": "string",
"country": "string"
},
"access_code": "string",
"automatic_updates": true,
"apps": {
"additionalProp1": {
"preferred_version": {
"version": "string",
"uri": "string"
},
"installed_version": {
"version": "string",
"uri": "string"
}
},
"additionalProp2": {
"preferred_version": {
"version": "string",
"uri": "string"
},
"installed_version": {
"version": "string",
"uri": "string"
}
},
"additionalProp3": {
"preferred_version": {
"version": "string",
"uri": "string"
},
"installed_version": {
"version": "string",
"uri": "string"
}
}
},
"connected_devices": [
{
"app_code": "string",
"devices": [
{
"terminal_id": "string",
"device_uuid": "string",
"installed_version": "string",
"date": "string"
}
]
}
],
"timezone": "string",
"is_demo": true,
"is_active": true,
"edm_sync": true
},
{
"id": 1,
"name": "string",
"phone_settings": {
"code": "string",
"number": "string",
"country": "string"
},
"website": "string",
"email": "user@example.com",
"store_number": "string",
"company": {
"id": "string",
"name": "string",
"is_active": true,
"created_at": "string",
"created_by": "string",
"updated_at": "string",
"updated_by": "string",
"subscriptions": [
{
"product": "string",
"count": 0,
"name": "string",
"external_data": {},
"is_active": true,
"active": true
}
]
},
"subscriptions": [
"string"
],
"location": {
"address_1": "string",
"address_2": "string",
"city": "string",
"state": "string",
"zip": "string",
"formatted_address": "string",
"country": "string"
},
"access_code": "string",
"automatic_updates": true,
"apps": {
"additionalProp1": {
"preferred_version": {
"version": "string",
"uri": "string"
},
"installed_version": {
"version": "string",
"uri": "string"
}
},
"additionalProp2": {
"preferred_version": {
"version": "string",
"uri": "string"
},
"installed_version": {
"version": "string",
"uri": "string"
}
},
"additionalProp3": {
"preferred_version": {
"version": "string",
"uri": "string"
},
"installed_version": {
"version": "string",
"uri": "string"
}
}
},
"connected_devices": [
{
"app_code": "string",
"devices": [
{
"terminal_id": "string",
"device_uuid": "string",
"installed_version": "string",
"date": "string"
}
]
}
],
"timezone": "string",
"is_demo": true,
"is_active": true,
"edm_sync": true
}
]
}