Search
K
Membership API

Customers

Search Customers

Get a collection of operational customers based on the specified search criteria.

get
https://membership-api.centraldispatch.com/customers

Query Parameters

marketplaceinteger(int32)required

The ID of the Central Dispatch Marketplace. There are three types of Marketplaces:

  • Public: The public Marketplace ID is 10000.
  • Test: Test Marketplace IDs will be provided to you by Central Dispatch.
  • Private: Private Marketplace IDs will be provided to you by Central Dispatch, if necessary.

Example:10000

namestring | null

The company name of the customer. If supplied, must be at least 3 characters in length.

Default:null

>= 3 characters

Example:The Transport Co.

mcNumberstring | null

Motor carrier number (MC Number) or authority number.

Default:null

Example:MC 123456

phoneNumberstring | null

The phone number of the customer.

Default:null

Example:800-555-9090

emailstring | null

The email address of the contact. Must be a valid email address format.

Default:null

Example:trans-port@notgmail.com

usDotNumberstring | null

The US Department of Transportation (USDOT) number.

Default:null

Example:USDOT 1234567

limit(startingPoint,numberOfResults)string

The maximum number of items to be returned in the response.

  • startingPoint is 1-based integer, default 1.
  • numberOfResults is an integer, default 25, maximum 500.

Example:limit(1,10)

Headers

Acceptstringrequired

The major version of the API to make a request against. This is a custom MIME type that contains vnd.coxauto.v[#]+. For example, to request a resource from version 1.x.x of an API, the Accept header should be set to application/vnd.coxauto.v1+json.

Example:application/vnd.coxauto.v1+json

Response

application/json

OK. Successful request.

CustomerSearchCollection

A collection of customers.

hrefstringrequired

The URL used to query the current collection of the resource.

Example:https://membership-api.centraldispatch.com/customers/?start=5&limit=1&name=acu

countinteger(int32)required

The total count of resources in the collection.

Example:23

itemsarray[object]required

A customer record.

Show Child Parameters
limitinteger(int32)required

The maximum number of items to be returned in the response.

Example:1

get/customers
 
application/json

Get Customer by ID

Get a customer by ID

get
https://membership-api.centraldispatch.com/customers/id/{customerId}

Path Parameters

customerIdstring(uuid)required

The Central Dispatch customer ID of the customer.

Example:d5c62b14-cbd1-11ee-9a0e-0242ac110002

Headers

Acceptstringrequired

The major version of the API to make a request against. This is a custom MIME type that contains vnd.coxauto.v[#]+. For example, to request a resource from version 1.x.x of an API, the Accept header should be set to application/vnd.coxauto.v1+json.

Example:application/vnd.coxauto.v1+json

Response

application/json

OK. Successful request.

CustomerResponse

A customer record.

companyNamestring | null

The name of the company.

Example:Smart Logistics

emailstring | null

The email address of the contact. Must be a valid email address format.

Example:contact@aculogistics.com

phoneNumbersarray | null[object]

Details of a customer’s phone number.

Show Child Parameters
addressesarray | null[object]

Details of a customer’s address.

Show Child Parameters
customerAuthorityNumbersarray | null[object]

Details of a customer’s authority number.

Show Child Parameters
customerIdstring | null(uuid)

The Central Dispatch customer ID of the customer.

Example:d5c62b14-cbd1-11ee-9a0e-0242ac110002

accessPausedboolean | null

Indicates if the company has temporarily lost access to their account due to security reasons.

Example:true

get/customers/id/{customerId}
 
application/json

Users

Get User

Get a user by ID.

get
https://membership-api.centraldispatch.com/users/id/{userId}

Path Parameters

userIdstring(uuid)required

The Central Dispatch user ID.

Example:d71b5750-e89b-12d3-a456-426614174000

Headers

Acceptstringrequired

The major version of the API to make a request against. This is a custom MIME type that contains vnd.coxauto.v[#]+. For example, to request a resource from version 1.x.x of an API, the Accept header should be set to application/vnd.coxauto.v1+json.

Example:application/vnd.coxauto.v1+json

Response

application/json

OK. Successful request.

UserResponse

A user record.

hrefstring

The fully qualified URL of the user record.

Example:https://membership-api.centraldispatch.com/users/id/d71b5750-e89b-12d3-a456-426614174000

userIdstring(uuid)

The ID of the user.

Example:d71b5750-e89b-12d3-a456-426614174000

firstNamestring | null

The preferred first name of the user.

Example:Mickey

lastNamestring

The legal last name of the user.

Example:Smith

legalFirstNamestring

The legal first name of the user.

Example:Michael

emailAddressstring | null

The email address of the user.

Example:mickey@snoogle.com

usernamestring

The username of the user.

Example:msmith

isActiveboolean

Indicates if the user is active.

Example:true

createdOnstring(date-time)

The creation date of the user (UTC/ISO 8601).

Example:2024-10-31T00:00:00Z

updatedOnstring(date-time)

The last updated date of the user (UTC/ISO 8601).

Example:2024-10-15T00:00:00Z

phoneNumberstring | null

The phone number of the user.

Example:949-555-1323

get/users/id/{userId}
 
application/json