API Reference - Client Contacts

Client contacts are the individual user accounts that are configured in your system.  Personal information about these individuals, such as there phone numbers and email address are stored in these objects.

Listing Client Contacts

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

GET /api/v1/client/contacts

 

Available Request Parameters:

Name Type Required Description
id integer no ID of the case.
last_name string no Last name of the contact.
first_name string no First name of the contact.
email string no Email address of the contact.
client string no ID of the parent (root) client.
client_location integer no ID of the client location for this contact.
role integer no ID of the role this contact belongs to.
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 Contact

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

GET /api/v1/client/contacts/{client_contact_id}

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