Skip to main content

List Customers

GET /customers

List and filter customers.

Roles

Users with the following roles may access this endoint:

Admin
ClientCustomer
CrmUser
Dispatcher
Driver
ThirdPartyDispatcher
ThirdPartyDriver

Breaking Changes

No breaking changes.

Request

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

Path Parameters

note

No path parameters.

Query Parameters

active Boolean, Optional

Default Value: NULL

If true, return only active records. If false, return only inactive records. 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.

is_parent Boolean, Optional

Default Value: NULL

If true, return accounts with no parent. If false, return accounts with a parent. If null, all records 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.

location_id Integer, Optional

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


name String, Optional

Name (free text).

  • At least 1 and no more than 64 characters.

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.

parent_id Integer, Optional

Default Value: NULL

If specified, return only children of the specified parent_id.

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 CustomerListModel 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[CustomerModel]

Refer to CustomerModel.


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/customers