Central Dispatch’s Membership API is used for managing membership within Central Dispatch.
🔑 Scope: membership
Production server
Provide your bearer token in the Authorization header when making requests to protected resources.
Example: Authorization: Bearer 123
Get a collection of customers based on the specified search criteria.
Example:10000
The company name of the customer. If supplied, must be at least 3 characters in length.
Default:null
>= 3 characters
Example:The Transport Co.
Motor carrier number (MC Number) or authority number.
Default:null
Example:MC 123456
The phone number of the customer.
Default:null
Example:800-555-9090
The email address of the contact. Must be a valid email address format.
Default:null
Example:trans-port@notgmail.com
The US Department of Transportation (USDOT) number.
Default:null
Example:USDOT 1234567
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)
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
OK. Successful request.
A collection of customers.
The URL used to query the current collection of the resource.
Example:https://membership-api.centraldispatch.com/customers/?start=5&limit=1&name=acu
The total count of resources in the collection.
Example:23
A customer record.
The maximum number of items to be returned in the response.
Example:1
Get a customer by ID
The Central Dispatch customer ID of the customer.
Example:d5c62b14-cbd1-11ee-9a0e-0242ac110002
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
OK. Successful request.
A customer record.
The name of the company.
Example:Smart Logistics
The email address of the contact. Must be a valid email address format.
Example:contact@aculogistics.com
Details of a customer’s phone number.
Details of a customer’s address.
Details of a customer’s authority number.
The Central Dispatch customer ID of the customer.
Example:d5c62b14-cbd1-11ee-9a0e-0242ac110002
Get a user by ID.
The Central Dispatch user ID.
Example:d71b5750-e89b-12d3-a456-426614174000
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
OK. Successful request.
A user record.
The fully qualified URL of the user record.
Example:https://membership-api.centraldispatch.com/users/id/d71b5750-e89b-12d3-a456-426614174000
The ID of the user.
Example:d71b5750-e89b-12d3-a456-426614174000
The first name of the user.
Example:Mickey
The last name of the user.
Example:Smith
The email address of the user.
Example:mickey@snoogle.com
The username of the user.
Example:msmith
Indicates if the user is active.
Example:true
The creation date of the user (UTC/ISO 8601).
Example:2024-10-31T00:00:00Z
The last updated date of the user (UTC/ISO 8601).
Example:2024-10-15T00:00:00Z
The phone number of the user.
Example:949-555-1323