/client/search

get https://api.clientsuccess.com/v2/client/search

Search for clients using parameters

time	status	user agent
Retrieving recent requests…

Loading…

Query Params

ids

array of int64s

Set of clients ids

ids

uuids

array of strings

Set of clients uuids

uuids

name

string

Client name

status

array of strings

Client status (can include more than 1)

status

region

array of objects

Customer region (can include more than 1)

region

externalSystemType

string

Type of external system client is associated with

externalSystemId

string

Client External System ID

stripeId

string

Client Stripe ID

clientTypeId

int64

≥ 0

ClientSuccess system ID of client type

regionId

int64

≥ 0

ClientSuccess system ID of customer region

assignedCsmId

int64

≥ 0

ClientSuccess system ID of the employee who is client's assigned CSM

createdBefore

date

Client Created Before Date

createdAfter

date

Client Created After Date

modifiedBefore

date

Client Modified Before Date

modifiedAfter

date

Client Modified After Date

sortBy

string

Criteria to sort by (default 'createdTime')

sortDirection

string

Sort direction (default 'desc')

page

int32

≥ 0

Result page index (default 0)

size

int32

≥ 1

Number of results per page (default 100)

Response

Language

Credentials

Header


xxxxxxxxxx
1
curl --request GET \
2
     --url https://api.clientsuccess.com/v2/client/search \
3
     --header 'accept: */*'

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

*/*

200OK