Client Locations are physical or logical "branches" of a client. If you are looking for general information about the parent (root) client, the Client API Reference will provide this data. It is important to note that all clients have at least one location.
Listing Client Locations
Returns a collection of client location records, optionally filtered by the available request parameters.
GET /api/v1/client/locations
Available Request Parameters:
| Name | Type | Required | Description |
| id | integer | no | ID of the case. |
| name | string | no | Name of the client. |
| parent | integer | no | ID of the parent (root) 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 Location
Returns a single client location record, based on the numeric ID.
GET /api/v1/client/locations/{client_location_id}