Company

Operations

GET/companiesGET/companies/countGET/companies/findOneGET/companies/{id}GET/companies/{id}/accountsGET/companies/{id}/accounts/countGET/companies/{id}/accounts/{fk}GET/companies/{id}/configurationGET/companies/{id}/customersGET/companies/{id}/customers/countGET/companies/{id}/customers/{fk}GET/companies/{id}/devicesGET/companies/{id}/devices/countGET/companies/{id}/devices/{fk}GET/companies/{id}/existsGET/companies/{id}/plantsGET/companies/{id}/plants/countGET/companies/{id}/plants/{fk}GET/companies/{id}/ticketFormatsGET/companies/{id}/ticketFormats/countGET/companies/{id}/ticketFormats/{fk}GET/companies/{id}/trucksGET/companies/{id}/trucks/countGET/companies/{id}/trucks/{fk}

---

GET /companies

GET

/companies

Find all instances of the model matched by filter from the data source.

Parameters

Query Parameters

filter

Filter defining fields, where, include, order, offset, and limit

Typestring

Responses

Request was successful

Content-Type

application/json

[

{

"name": "string",

"email": "string",

"fax": "string",

"taxId": "string",

"slug": "string",

"phoneNumber": "string",

"type": "string",

"id": "string",

"createdAt": "string",

"updatedAt": "string",

"address": "string"

}

]

GET

/companies

Playground

Variables

Key

Value

filter

Samples

cURL

JavaScript

PHP

Python

---

GET /companies/count

GET

/companies/count

Count instances of the model matched by where from the data source.

Parameters

Query Parameters

where

Criteria to match model instances

Typestring

Responses

Request was successful

Content-Type

application/json

{

"count": 0

}

GET

/companies/count

Playground

Variables

Key

Value

where

Samples

cURL

JavaScript

PHP

Python

---

GET /companies/findOne

GET

/companies/findOne

Find first instance of the model matched by filter from the data source.

Parameters

Query Parameters

filter

Filter defining fields, where, include, order, offset, and limit

Typestring

Responses

Request was successful

Content-Type

application/json

{

"name": "string",

"email": "string",

"fax": "string",

"taxId": "string",

"slug": "string",

"phoneNumber": "string",

"type": "string",

"id": "string",

"createdAt": "string",

"updatedAt": "string",

"address": "string"

}

GET

/companies/findOne

Playground

Variables

Key

Value

filter

Samples

cURL

JavaScript

PHP

Python

---

GET /companies/{id}

GET

/companies/{id}

Find a model instance by {{id}} from the data source.

Parameters

Path Parameters

id*

Model id

Typestring

Required

Query Parameters

filter

Filter defining fields and include

Typestring

Responses

Request was successful

Content-Type

application/json

{

"name": "string",

"email": "string",

"fax": "string",

"taxId": "string",

"slug": "string",

"phoneNumber": "string",

"type": "string",

"id": "string",

"createdAt": "string",

"updatedAt": "string",

"address": "string"

}

GET

/companies/{id}

Playground

Variables

Key

Value

id*

filter

Samples

cURL

JavaScript

PHP

Python

---

GET /companies/{id}/accounts

GET

/companies/{id}/accounts

Queries accounts of Company.

Parameters

Path Parameters

id*

PersistedModel id

Typestring

Required

Query Parameters

filter

Typestring

Responses

Request was successful

Content-Type

application/json

[

{

"type": "string",

"subType": "string",

"sysdyneId": "string",

"realm": "string",

"username": "string",

"credentials": {

},

"challenges": {

},

"email": "string",

"emailVerified": true,

"status": "string",

"created": "string",

"lastUpdated": "string",

"id": "string",

"createdAt": "string",

"updatedAt": "string",

"companyId": "string",

"divisionId": "string",

"employeeId": "string"

}

]

GET

/companies/{id}/accounts

Playground

Variables

Key

Value

id*

filter

Samples

cURL

JavaScript

PHP

Python

---

GET /companies/{id}/accounts/count

GET

/companies/{id}/accounts/count

Counts accounts of Company.

Parameters

Path Parameters

id*

PersistedModel id

Typestring

Required

Query Parameters

where

Criteria to match model instances

Typestring

Responses

Request was successful

Content-Type

application/json

{

"count": 0

}

GET

/companies/{id}/accounts/count

Playground

Variables

Key

Value

id*

where

Samples

cURL

JavaScript

PHP

Python

---

GET /companies/{id}/accounts/{fk}

GET

/companies/{id}/accounts/{fk}

Find a related item by id for accounts.

Parameters

Path Parameters

fk*

Foreign key for accounts

Typestring

Required

id*

PersistedModel id

Typestring

Required

Responses

Request was successful

Content-Type

application/json

{

"type": "string",

"subType": "string",

"sysdyneId": "string",

"realm": "string",

"username": "string",

"credentials": {

},

"challenges": {

},

"email": "string",

"emailVerified": true,

"status": "string",

"created": "string",

"lastUpdated": "string",

"id": "string",

"createdAt": "string",

"updatedAt": "string",

"companyId": "string",

"divisionId": "string",

"employeeId": "string"

}

GET

/companies/{id}/accounts/{fk}

Playground

Variables

Key

Value

fk*

id*

Samples

cURL

JavaScript

PHP

Python

---

GET /companies/{id}/configuration

GET

/companies/{id}/configuration

Get company configuration including Division settings

Parameters

Path Parameters

id*

PersistedModel id

Typestring

Required

Responses

Request was successful

Content-Type

application/json

{

"companyLogo": "string",

"ticketLogo": "string",

"ticketAgreement": "string",

"ticketEmails": [

"string"

],

"invoiceEmails": [

"string"

],

"needsClockInVerification": true,

"allowLateClockIn": true,

"clockInRequired": true,

"dvirRequired": false,

"dvirTimeLimit": 0,

"useSatelliteView": true,

"useGoogleMap": true,

"allowBreaks": true,

"emailNotificationsEnabled": true,

"units": "string",

"timeZone": "America/New_York",

"timeZoneAbbr": "EST",

"timeZoneOffset": "-0500",

"countryCode": "US",

"clockInTime": "string",

"manualTicketStatusChange": "warn",

"maxWorkingHours": 18,

"locationAccuracy": "high",

"clockInAfterMarginInMinutes": 10,

"clockInBeforeMarginInMinutes": 5,

"allowUnlimitedUTO": false,

"statusUpdateMinSpeed": 0,

"maxAttachmentSize": 0,

"merchantId": "string",

"simpleClockIn": true,

"enableIntegratedPayroll": false,

"weekStartingDay": 1,

"allowEndOfDayFlag": false,

"endOfDayTimer": 0,

"clockInPublicQROnly": false,

"integrations": {

},

"pouringStatusRequired": true,

"unassignTruckOnClockOut": false,

"autoselectEmailsOnDevice": false,

"formEntryExpireAfterDays": 0,

"allowPriceChangesOnTickets": true,

"dayStartsAt": 0,

"weighmasterVerbiage": "string",

"splitOvernightHoursInTimekeepingView": false,

"id": "string",

"companyId": "string",

"createdAt": "string",

"updatedAt": "string"

}

GET

/companies/{id}/configuration

Playground

Variables

Key

Value

id*

Samples

cURL

JavaScript

PHP

Python

---

GET /companies/{id}/customers

GET

/companies/{id}/customers

Queries customers of Company.

Parameters

Path Parameters

id*

PersistedModel id

Typestring

Required

Query Parameters

filter

Typestring

Responses

Request was successful

Content-Type

application/json

[

{

"number": "string",

"name": "string",

"allowViewBatchWeights": true,

"allowViewPhotos": true,

"allowViewDriverNotes": true,

"allowOrderRequest": false,

"allowViewWaterDetails": true,

"allowAcceptRejectLoad": true,

"externalId": "string",

"id": "string",

"companyId": "string",

"divisionId": "string",

"contractorCompanyId": "string",

"createdAt": "string",

"updatedAt": "string",

"contacts": "string",

"customFields": [

{

"name": "string",

"value": "string",

"id": "string"

}

]

}

]

GET

/companies/{id}/customers

Playground

Variables

Key

Value

id*

filter

Samples

cURL

JavaScript

PHP

Python

---

GET /companies/{id}/customers/count

GET

/companies/{id}/customers/count

Counts customers of Company.

Parameters

Path Parameters

id*

PersistedModel id

Typestring

Required

Query Parameters

where

Criteria to match model instances

Typestring

Responses

Request was successful

Content-Type

application/json

{

"count": 0

}

GET

/companies/{id}/customers/count

Playground

Variables

Key

Value

id*

where

Samples

cURL

JavaScript

PHP

Python

---

GET /companies/{id}/customers/{fk}

GET

/companies/{id}/customers/{fk}

Find a related item by id for customers.

Parameters

Path Parameters

fk*

Foreign key for customers

Typestring

Required

id*

PersistedModel id

Typestring

Required

Responses

Request was successful

Content-Type

application/json

{

"number": "string",

"name": "string",

"allowViewBatchWeights": true,

"allowViewPhotos": true,

"allowViewDriverNotes": true,

"allowOrderRequest": false,

"allowViewWaterDetails": true,

"allowAcceptRejectLoad": true,

"externalId": "string",

"id": "string",

"companyId": "string",

"divisionId": "string",

"contractorCompanyId": "string",

"createdAt": "string",

"updatedAt": "string",

"contacts": "string",

"customFields": [

{

"name": "string",

"value": "string",

"id": "string"

}

]

}

GET

/companies/{id}/customers/{fk}

Playground

Variables

Key

Value

fk*

id*

Samples

cURL

JavaScript

PHP

Python

---

GET /companies/{id}/devices

GET

/companies/{id}/devices

Queries devices of Company.

Parameters

Path Parameters

id*

PersistedModel id

Typestring

Required

Query Parameters

filter

Typestring

Responses

Request was successful

Content-Type

application/json

[

{

"uniqueId": "string",

"pushId": "string",

"name": "string",

"type": "string",

"model": "string",

"appVersion": "string",

"phoneNumber": "string",

"active": true,

"features": {

},

"location": "string",

"locationData": {

},

"speed": 0,

"course": 0,

"metricsDate": "string",

"lastAccess": "string",

"id": "string",

"companyId": "string",

"createdAt": "string",

"updatedAt": "string",

"divisionId": "string",

"settingsDivisionId": "string",

"truckId": "string",

"plantId": "string",

"employeeId": "string",

"sensor": "string"

}

]

GET

/companies/{id}/devices

Playground

Variables

Key

Value

id*

filter

Samples

cURL

JavaScript

PHP

Python

---

GET /companies/{id}/devices/count

GET

/companies/{id}/devices/count

Counts devices of Company.

Parameters

Path Parameters

id*

PersistedModel id

Typestring

Required

Query Parameters

where

Criteria to match model instances

Typestring

Responses

Request was successful

Content-Type

application/json

{

"count": 0

}

GET

/companies/{id}/devices/count

Playground

Variables

Key

Value

id*

where

Samples

cURL

JavaScript

PHP

Python

---

GET /companies/{id}/devices/{fk}

GET

/companies/{id}/devices/{fk}

Find a related item by id for devices.

Parameters

Path Parameters

fk*

Foreign key for devices

Typestring

Required

id*

PersistedModel id

Typestring

Required

Responses

Request was successful

Content-Type

application/json

{

"uniqueId": "string",

"pushId": "string",

"name": "string",

"type": "string",

"model": "string",

"appVersion": "string",

"phoneNumber": "string",

"active": true,

"features": {

},

"location": "string",

"locationData": {

},

"speed": 0,

"course": 0,

"metricsDate": "string",

"lastAccess": "string",

"id": "string",

"companyId": "string",

"createdAt": "string",

"updatedAt": "string",

"divisionId": "string",

"settingsDivisionId": "string",

"truckId": "string",

"plantId": "string",

"employeeId": "string",

"sensor": "string"

}

GET

/companies/{id}/devices/{fk}

Playground

Variables

Key

Value

fk*

id*

Samples

cURL

JavaScript

PHP

Python

---

GET /companies/{id}/exists

GET

/companies/{id}/exists

Check whether a model instance exists in the data source.

Parameters

Path Parameters

id*

Model id

Typestring

Required

Responses

Request was successful

Content-Type

application/json

{

"exists": true

}

GET

/companies/{id}/exists

Playground

Variables

Key

Value

id*

Samples

cURL

JavaScript

PHP

Python

---

GET /companies/{id}/plants

GET

/companies/{id}/plants

Queries plants of Company.

Parameters

Path Parameters

id*

PersistedModel id

Typestring

Required

Query Parameters

filter

Typestring

Responses

Request was successful

Content-Type

application/json

[

{

"number": "string",

"description": "string",

"address": "string",

"region": {

},

"location": "string",

"radius": 100,

"dvirEmails": [

"string"

],

"timeZone": "string",

"id": "string",

"companyId": "string",

"createdAt": "string",

"updatedAt": "string",

"plantRegionId": "string",

"addressDetails": "string"

}

]

GET

/companies/{id}/plants

Playground

Variables

Key

Value

id*

filter

Samples

cURL

JavaScript

PHP

Python

---

GET /companies/{id}/plants/count

GET

/companies/{id}/plants/count

Counts plants of Company.

Parameters

Path Parameters

id*

PersistedModel id

Typestring

Required

Query Parameters

where

Criteria to match model instances

Typestring

Responses

Request was successful

Content-Type

application/json

{

"count": 0

}

GET

/companies/{id}/plants/count

Playground

Variables

Key

Value

id*

where

Samples

cURL

JavaScript

PHP

Python

---

GET /companies/{id}/plants/{fk}

GET

/companies/{id}/plants/{fk}

Find a related item by id for plants.

Parameters

Path Parameters

fk*

Foreign key for plants

Typestring

Required

id*

PersistedModel id

Typestring

Required

Responses

Request was successful

Content-Type

application/json

{

"number": "string",

"description": "string",

"address": "string",

"region": {

},

"location": "string",

"radius": 100,

"dvirEmails": [

"string"

],

"timeZone": "string",

"id": "string",

"companyId": "string",

"createdAt": "string",

"updatedAt": "string",

"plantRegionId": "string",

"addressDetails": "string"

}

GET

/companies/{id}/plants/{fk}

Playground

Variables

Key

Value

fk*

id*

Samples

cURL

JavaScript

PHP

Python

---

GET /companies/{id}/ticketFormats

GET

/companies/{id}/ticketFormats

Queries ticketFormats of Company.

Parameters

Path Parameters

id*

PersistedModel id

Typestring

Required

Query Parameters

filter

Typestring

Responses

Request was successful

Content-Type

application/json

[

{

"template": "string",

"type": "print",

"externalId": "string",

"id": "string",

"companyId": "string",

"divisionId": "string",

"createdAt": "string",

"updatedAt": "string"

}

]

GET

/companies/{id}/ticketFormats

Playground

Variables

Key

Value

id*

filter

Samples

cURL

JavaScript

PHP

Python

---

GET /companies/{id}/ticketFormats/count

GET

/companies/{id}/ticketFormats/count

Counts ticketFormats of Company.

Parameters

Path Parameters

id*

PersistedModel id

Typestring

Required

Query Parameters

where

Criteria to match model instances

Typestring

Responses

Request was successful

Content-Type

application/json

{

"count": 0

}

GET

/companies/{id}/ticketFormats/count

Playground

Variables

Key

Value

id*

where

Samples

cURL

JavaScript

PHP

Python

---

GET /companies/{id}/ticketFormats/{fk}

GET

/companies/{id}/ticketFormats/{fk}

Find a related item by id for ticketFormats.

Parameters

Path Parameters

fk*

Foreign key for ticketFormats

Typestring

Required

id*

PersistedModel id

Typestring

Required

Responses

Request was successful

Content-Type

application/json

{

"template": "string",

"type": "print",

"externalId": "string",

"id": "string",

"companyId": "string",

"divisionId": "string",

"createdAt": "string",

"updatedAt": "string"

}

GET

/companies/{id}/ticketFormats/{fk}

Playground

Variables

Key

Value

fk*

id*

Samples

cURL

JavaScript

PHP

Python

---

GET /companies/{id}/trucks

GET

/companies/{id}/trucks

Queries trucks of Company.

Parameters

Path Parameters

id*

PersistedModel id

Typestring

Required

Query Parameters

filter

Typestring

Responses

Request was successful

Content-Type

application/json

[

{

"number": "string",

"description": "string",

"location": "string",

"locationData": {

},

"inService": false,

"inYard": false,

"deadhead": "string",

"endOfDay": false,

"lastAccess": "string",

"externalId": "string",

"id": "string",

"companyId": "string",

"divisionId": "string",

"createdAt": "string",

"updatedAt": "string",

"plantId": "string",

"currentPlantId": "string",

"metrics": "string"

}

]

GET

/companies/{id}/trucks

Playground

Variables

Key

Value

id*

filter

Samples

cURL

JavaScript

PHP

Python

---

GET /companies/{id}/trucks/count

GET

/companies/{id}/trucks/count

Counts trucks of Company.

Parameters

Path Parameters

id*

PersistedModel id

Typestring

Required

Query Parameters

where

Criteria to match model instances

Typestring

Responses

Request was successful

Content-Type

application/json

{

"count": 0

}

GET

/companies/{id}/trucks/count

Playground

Variables

Key

Value

id*

where

Samples

cURL

JavaScript

PHP

Python

---

GET /companies/{id}/trucks/{fk}

GET

/companies/{id}/trucks/{fk}

Find a related item by id for trucks.

Parameters

Path Parameters

fk*

Foreign key for trucks

Typestring

Required

id*

PersistedModel id

Typestring

Required

Responses

Request was successful

Content-Type

application/json

{

"number": "string",

"description": "string",

"location": "string",

"locationData": {

},

"inService": false,

"inYard": false,

"deadhead": "string",

"endOfDay": false,

"lastAccess": "string",

"externalId": "string",

"id": "string",

"companyId": "string",

"divisionId": "string",

"createdAt": "string",

"updatedAt": "string",

"plantId": "string",

"currentPlantId": "string",

"metrics": "string"

}

GET

/companies/{id}/trucks/{fk}

Playground

Variables

Key

Value

fk*

id*

Samples

cURL

JavaScript

PHP

Python

---