Skip to main content
POST
Find Customers

Authorizations

Authorization
string
header
required

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

Headers

Idempotency-Key
string

The idempotency key that will be used to ensure the request is only performed once

Path Parameters

company_id
string
required

The company ID with the prefix 'cmp_'.

Body

application/json
pagination
object
required

The pagination parameters for the request

include_meta
boolean | null

Whether to include additional metadata in the pagination response such the number of total results

query
object | null

The query criteria for the request

sort_key
enum<string>
default:createdAtDesc
Available options:
createdAtDesc,
createdAtAsc,
updatedAtAsc,
updatedAtDesc,
aToZ,
zToA,
mrrAsc,
mrrDesc,
orgAToZ,
orgZToA

Response

200 - application/json

OK

pagination
object
results
object[] | null