GET api/Clients?client_ref={client_ref}&creation_date={creation_date}&modified_since={modified_since}&page={page}&page_size={page_size}
Retrieve Client list
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| client_ref |
Client Reference (Optional) |
string |
Default value is |
| creation_date |
Filter by client creation date, format yyyyMMdd (Optional) |
string |
Default value is |
| modified_since |
Return only clients modified on or after this date, format yyyyMMdd (Optional). Useful for incremental sync. |
string |
Default value is |
| page |
Page number (default 1) |
integer |
Default value is 1 |
| page_size |
Page size (default 50, max 500) |
integer |
Default value is 50 |
Body Parameters
None.
Response Information
Resource Description
a list of clients
HttpResponseMessage| Name | Description | Type | Additional information |
|---|---|---|---|
| Version | Version |
None. |
|
| Content | HttpContent |
None. |
|
| StatusCode | HttpStatusCode |
None. |
|
| ReasonPhrase | string |
None. |
|
| Headers | Collection of Object |
None. |
|
| RequestMessage | HttpRequestMessage |
None. |
|
| IsSuccessStatusCode | boolean |
None. |