Skip to main content
GET
Find contacts

Query Parameters

platform
string
required

The platform. Every team can use twitter; a team may have others enabled.

Example:

"twitter"

platformId
string[]

Contacts with a profile of this platform ID. Give this or the other identity filter, repeating the key for up to 100. No match is an empty page.

Maximum array length: 100
Minimum string length: 1
username
string[]

Contacts with a profile of this username, without its display prefix. One username may match several contacts. Give this or the other identity filter, repeating the key for up to 100. No match is an empty page.

Maximum array length: 100
Minimum string length: 1
expand
enum<string>[]

Related resources to embed next to their ID field, one path per key, at most 4.

Maximum array length: 4
Available options:
status,
tags,
assignee
limit
integer

Page size, from 1 to 100. Defaults to 50.

Required range: 1 <= x <= 100
cursor
string

The previous page's nextCursor. Opaque, and valid only with the filters it was issued for.

Response

Ordered by createdAt, oldest first.

Ordered by createdAt, oldest first.

data
object[]
required
nextCursor
string | null
required

Pass it back as cursor, with the same filters, to read the next page. Null on the last page.