Skip to main content

List Jobs

GET /locations/{location_id}/jobs

List jobs.

Roles​

Users with the following roles may access this endoint:

Admin
ClientCustomer
CrmUser
Dispatcher
Driver
ThirdPartyDispatcher
ThirdPartyDriver

Breaking Changes​

2021/11/04

Request​

GET /locations/{location_id}/jobs/
Authorization: Bearer {your-auth-token}
Content-Type: application/json
x-tenant-id: {your-tenant-id}

Path Parameters​

location_id Integer, Required

Location identifier.

Query Parameters​

completed Boolean, Optional

If true, return only records marked completed. If false, return only records marked incomplete. If unspecified, return all.

  • One of 0, 1, True, False (case insensitive).

completed_by Integer, Optional

Driver or dispatcher identifier.

completed_by_driver Boolean, Optional

If true, return only records marked completed by a driver. If false, return only records marked incomplete. If unspecified, return all.

  • One of 0, 1, True, False (case insensitive).

created_on_gte String, Optional

Return records created on or after the specified date. If unspecified, return all.

  • Date occurring in the past in an ISO 8601 compatible format.

deleted Boolean, Optional

If true, return only active records. If false, return only inactive records. If unspecified, return all.

  • One of 0, 1, True, False (case insensitive).

driver_id String, Optional

If specified, return only records matching this driver. If unspecified, return all.

failed Boolean, Optional

If true, return only records marked deleted. If false, return only records marked as deleted. If unspecified, return all.

  • One of 0, 1, True, False (case insensitive).

is_dispatched Boolean, Optional

Filter jobs based on dispatch status. If true, records with a valid truck_id (dispatched) are returned. If false, records with no truck_id (not dispatched) are returned. If null, all records are returned.

  • One of 0, 1, True, False (case insensitive).

last_updated_gte String, Optional

Return only records updated after (must be in past). If unspecified, return all.

  • Date occurring in the past in an ISO 8601 compatible format.

page_index Integer, Optional

Paged results page index (starting from 1).

  • Less than or equal to 10000.
  • Greater than or equal to 1.

page_limit Integer, Optional

Maximun number of results per page.

  • Less than or equal to 1000.
  • Greater than or equal to 1.

returned_by Integer, Optional

Driver or dispatcher identifier.

returned_by_driver Boolean, Optional

Return only records returned by driver when TRUE.

  • One of 0, 1, True, False (case insensitive).

schedule_gt String, Optional

Return only jobs scheduled after (must be in past). If unspecified, return all.

  • Date occurring in the past in an ISO 8601 compatible format.

schedule_gte String, Optional

Return only jobs scheduled on or after (must be in past). If unspecified, return all.

  • Date occurring in the past in an ISO 8601 compatible format.

schedule_lt String, Optional

Return only jobs scheduled before.

  • Date in an ISO 8601 compatible format.

schedule_lte String, Optional

Return only jobs scheduled on or before.

  • Date in an ISO 8601 compatible format.

truck_id Integer, Optional

If specified, return only records matching this truck. If unspecified, return all.

Request Headers​

Refer to StandardRequestHeadersModel for more details.

authorization String, Required

Authorization header (bearer with access token). See the Authentication Guide to get started.

  • Matches ^bearer [a-z0-9-_=]+.[a-z0-9-_=]+.?[a-z0-9-_.+/=]*$
  • No longer than 256 characters.
  • At least 1 characters long.

x-api-version String, Optional

Request identifier.

  • At least 1 and no more than 64 characters.
  • Must be a valid API version string (2019/02/08, 2021/04/07, 2021/05/07, 2021/08/02, 2021/11/04, 2023/04/19).

x-tenant-id Integer, Required

Tenant identifier. Contact CRO Software for more info if you don't already have this id. See list tenant ids for info on listing the tenants you have access to.

Request Body​

note

No request body

Response​

Response Headers​

Refer to StandardResponseHeadersModel for more details.

x-api-version String

Request identifier.

  • At least 1 and no more than 64 characters.
  • Must be a valid API version string (2019/02/08, 2021/04/07, 2021/05/07, 2021/08/02, 2021/11/04, 2023/04/19).

x-request-id String

Request identifier.

  • Valid UUID.

Response Body​

Refer to JobListModel for more details.

current_limit Integer

Maximun number of results per page.

  • Less than or equal to 1000.
  • Greater than or equal to 1.

current_page Integer

Paged results page index (starting from 1).

  • Less than or equal to 10000.
  • Greater than or equal to 1.

results Array[JobModel]

Refer to JobModel.

total_count Integer

Paged results total viewable records.

  • Less than or equal to 100000.
  • Greater than or equal to 0.

total_pages Integer

Paged results total pages.

  • Less than or equal to 1000.
  • Greater than or equal to 0.

Code Samples​

curl --request GET --include \
--header "Authorization: Bearer {your-auth-token}" \
--header "Content-Type: application/json" \
--header "x-tenant-id: {your-tenant-id}" \
127.0.0.1:8003/locations/{location_id}/jobs