Skip to main content

List clients

GET 
/clients

Allows retrieving clients. When retrieving a client, all their associated information such as custom field values, addresses and identification documents may also be returned if requested. An empty list is returned if no clients are found.

Any combinations can be used but note that an AND search will be performed.

Please Note! Lookups by names are case sensitive. If an insensitive lookup is required please use the Objects Search API.

Search for a client using query parameters

GET /api/clients?firstName=Trevor&lastName=Linden

Request​

Responses​

ok