Filtering clients

Below is a list of attributes available for filtering clients.

AttributeType

type

string

email

string

joinedDate

string

mobile

string

telephone

string

personDetails.firstName

string

personDetails.middleName

string

personDetails.lastName

string

personDetails.dob

string

personDetails.gender

string

personDetails.nationality

string

personDetails.birthCountry

string

companyDetails.name

string

companyDetails.website

string

companyDetails.registrationNumber

string

companyDetails.incorporationType

string

companyDetails.incorporationCountry

string

metadata.{yourCustomKey}

string

Example - Get all clients for one type

In the example below, we will request to get all clients that are of type company.

curl -X GET https://api.complycube.com/v1/clients?type=company \
     -H 'Authorization: <YOUR_API_KEY>'

Last updated