Skip to main content
GET
Retrieve an entity by client customer ID
See Errors for the common errors every v2 endpoint can return.

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

client_customer_id
string
required

The client_customer_id of the entity to retrieve.

Response

A list with the matching entity in objects. objects is empty if no entity matches.

A page of entities matching the query filters.

has_more
boolean
required

Whether more results are available after this page.

objects
(Individual · object | Business · object | Sole Prop · object | Lead · object | Partner · object)[]
required