Skip to main content
GET
Get contacts

Authorizations

Authorization
string
header
required

Path Parameters

workspaceID
string
required

Workspace ID

Query Parameters

limit
integer
default:10

Limit

offset
integer
default:0

Offset (cannot be nonzero with cursor pagination)

pagination
enum<string>
default:offset

Pagination mode

Available options:
offset,
cursor
cursor
string

Opaque nextCursor from the preceding response; implies cursor pagination

tag_ids[]
string[]

Filter by tag ids

tagIds
string[]

Alias for tag_ids[]

not_in_sequence_id
string

Filter by contacts not in sequence

notInSequenceId
string

Alias for not_in_sequence_id

validation_statuses[]
enum<string>[]

Filter by validation statuses

Available options:
safe,
valid,
invalid,
disabled,
disposable,
inbox_full,
catch_all,
role_account,
spamtrap,
unknown,
unvalidated
validationStatus
enum<string>[]

Alias for validation_statuses[]

Available options:
safe,
valid,
invalid,
disabled,
disposable,
inbox_full,
catch_all,
role_account,
spamtrap,
unknown,
unvalidated

Response

Contact list in offset or cursor mode; nextCursor is omitted on the last cursor page

data
object[]
required
limit
integer
required
offset
integer
required
total
integer
required