API Reference - Clients

Clients are objects that store general information about top level "parent" clients.  If you are looking for specific information, such as addresses and phone numbers, Client Locations will provide this data.

Listing Clients

Returns a collection of client records, optionally filtered by the available request parameters.

GET /api/v1/clients

 

Available Request Parameters:

Name Type Required Description
id integer no ID of the case.
name string no Name of the client.
salesperson integer no ID of the default salesperson assigned to this client.
created_from timestamp no Created on or after the date.
created_to timestamp no Created on or before the date.
updated_from timestamp no Updated on or after the date.
updated_to timestamp no Updated on or before the date.

 Note: All timestamp parameters are queried and returned in UTC.

Getting a Client

Returns a single client record, based on the numeric ID.

GET /api/v1/clients/{client_id}

Was this article helpful?
0 out of 0 found this helpful
Have more questions? Submit a request