/contact/search

get

https://api.clientsuccess.com/v2/contact/search

Search for contacts using parameters

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Query Params

ids

array of int64s

Set of contacts ids

ids

tenantClientId

int64

≥ 0

ClientSuccess system Client ID

status

array of strings

Contact status (can include more than 1)

status

clientStatus

array of strings

Client status (can include more than 1)

clientStatus

name

string

Contact name

string

Contact email

starred

boolean

Whether contact is starred

searchText

string

Search text across contact names, titles, emails, phone numbers, and notes

externalSystemType

string

enum

Type of external system contact is associated with

workatoPushExternalSystemType

string

enum

externalSystemId

string

Contact External System ID

createdBefore

date

Contact Created Before Date

createdAfter

date

Contact Created After Date

modifiedBefore

date

Contact Modified Before Date

modifiedAfter

date

Contact Modified After Date

sortBy

string

Criteria to sort by (default 'createdTime')

sortDirection

string

Sort direction (default 'asc')

page

int32

≥ 0

Result page index (default 0)

size

int32

≥ 1

Number of results per page (default 100)

Response

Language

Credentials

Header

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

*/*

200OK