customerIdstring(uuid)required
The Central Dispatch customer ID of the customer.
Example:d5c62b14-cbd1-11ee-9a0e-0242ac110002
Get Customer by ID
Get a customer by ID
get
https://membership-api.centraldispatch.com/customers/id/{customerId}
Path Parameters
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
Response
application/json
OK. Successful request.
CustomerResponse
A customer record.
companyNamestring | null
The name of the company.
Example:Smart Logistics
establishedInstring | null
The year the company was established. This value will be returned only if customer-management scope is used.
Example:1998
emailstring | null
The email address of the contact. Must be a valid email address format.
Example:contact@aculogistics.com
joinedOnstring | null(date-time)
The date the company joined the platform, in UTC/ISO 8601 format. This value will be returned only if customer-management scope is used.
Example:2024-10-31T00:00:00Z
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}
Authentication
Path Parameters
Headers
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
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}
Authentication
Path Parameters
Headers
application/json
Get My Users
Get all the users that are associated with the customer in the Bearer token.
get
https://membership-api.centraldispatch.com/users/mine
Query Parameters
limit(startingPoint,numberOfResults)string
The maximum number of items to be returned in the response.
startingPointis 1-based integer, default 1.numberOfResultsis 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
Response
application/json
OK. Successful request.
UserCollection
A paginated collection of users.
hrefstring
The URL used to query the current collection of the resource.
Example:https://membership-api.centraldispatch.com/users/mine?limit(5,1)
itemsarray[object]
A user record.
Show Child Parameters
limitinteger(int32)
The maximum number of items to be returned in the response.
Example:1
nextstring | null
The URL to the next page of the collection, if available.
Example:https://membership-api.centraldispatch.com/users/mine?limit(6,1)
previousstring | null
The URL to the previous page of the collection, if available.
Example:https://membership-api.centraldispatch.com/users/mine?limit(4,1)
firststring | null
The URL to the first page of the collection.
Example:https://membership-api.centraldispatch.com/users/mine?limit(1,1)
countinteger(int32)
The total count of resources in the collection.
Example:23
get/users/mine
Authentication
Query Parameters
Headers
application/json