Stage - Membership API
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
AddressResponse
objectDetails of a customer’s address.
streetAddressstring
The street address.
Example:345 W Elm St.
streetAddress2string
Additional street address line.
Example:2nd Floor
citystring
The city.
Example:Anaheim
statestring
The state.
Example:CA
zipcodestring
The ZIP code. Must be a valid United States ZIP code or Canadian postal code.
Example:92802
typestring
The type of address (e.g., PRIMARY, LOCAL, BILLING).
Example:PRIMARY
Example
AuthorityNumberResponse
objectDetails of a customer’s authority number.
numberstring
The authority number assigned to the customer.
Example:DL 01-00673-10
verifiedboolean
Indicates whether the authority number is verified.
Example:true
typestring
The type of authority number.
Example:DEALER_LICENSE
Example
CustomerResponse
objectA customer record.
companyNamestring
The name of the company.
Example:Smart Logistics
establishedInstring
The year the company was established.
Example:1998
emailstring
The email address of the contact. Must be a valid email address format.
Example:contact@aculogistics.com
joinedOnstring(date-time)
The date the company joined the platform, in UTC/ISO 8601 format.
Example:2024-10-31T00:00:00Z
phoneNumbersarray[object]
Details of a customer’s phone number.
Show Child Parameters
addressesarray[object]
Details of a customer’s address.
Show Child Parameters
customerAuthorityNumbersarray[object]
Details of a customer’s authority number.
Show Child Parameters
customerIdstring(uuid)
The Central Dispatch customer ID of the customer.
Example:d5c62b14-cbd1-11ee-9a0e-0242ac110002
accessPausedboolean
Indicates if the company has temporarily lost access to their account due to security reasons.
Example:true
averageOverallRatingnumber(double)
The customer’s average overall rating, from 1.0 to 5.0. 0.0 means the customer has no reviews yet; null means the rating is temporarily unavailable.
Example:4.5
Example
CustomerSearchCollection
objectA 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
Example