POST
List contacts

Authorizations

Authorization
string
header
required

A key from Settings → API keys. It starts with gd_key_.

Body

application/json
limit
integer
default:25
Required range: 1 <= x <= 100
cursor
string | null
sort
enum<string>
Available options:
createdAt,
displayName,
lifecycleChangedAt
order
enum<string>
Available options:
asc,
desc
q
string

search query

Maximum string length: 200
filters
object[]
Maximum array length: 20

Response

A page of contacts

message
string
required
Example:

"Contacts listed"

metaData
object
required
data
object
required