Clients
Header Parameters
Content-Typestring
Authorizationstring
Query Parameters
limitinteger
Number of clients to return per page. Must be between 5 and 50
sortstring
Field name for sorting
statusstring
Filter by client status
categorystring
Filter by client category
businessUnitIdstring
Filters clients by business unit IDs. These IDs can be retrieved from the getBusinessUnitsList endpoint.
userIdstring
Filter by user ID for business unit access control
modifiedAfterstring
Filters clients based on the date they were last modified. Only clients that were modified after the specified date and time will be returned
modifiedBeforestring
Filters clients based on the date they were last modified. Only clients that were modified before the specified date and time will be returned
Response
200
Object
Response Attributes
idstring
namestring
countrystring
statestring
citystring
zipcodestring
websitestring
ownershipstring
statusstring
categorystring
created_bystring
created_atstring
updated_atstring
industry_expstring
primary_business_unitnumber
accessible_business_unitsstring
400
Object
{
"message": "Invalid parameters or filters."
}
401
Object
Please provide the access token.
403
Object
Your company access is temporarily disabled.
404
Object
Data not found.
429
Object
Request limit exceeded. Please try again later.
Was this section helpful?
What made this section helpful for you?
What made this section unhelpful for you?
Response
Was this section helpful?