Skip to main content
GET
List end users
Returns a page of end-user records. Pass the returned cursor back until isDone is true. Requires a key with the End-users permission. See API authentication.
A first request without a cursor returning a page response, the cursor feeding the next request while isDone is false, and paging finishing when isDone is true
integer
Page size. Default 50, maximum 100.
string
Pagination cursor from the previous response.
string
Return only records carrying this tag.
string
Filter by inbound, imported, or manual.

Response

object[]
A page of end-user records.
string
Pass this back as the cursor query parameter to fetch the next page.
boolean
true when no more pages remain.

Errors

Authorizations

Authorization
string
header
required

API key sent as Authorization: Bearer YOUR_API_KEY. Campaign endpoints use campaign-scoped keys; the rest use organization or agent keys with the matching permission.

Query Parameters

limit
integer
default:50

Page size. Defaults to 50, capped at 100.

Required range: x <= 100
cursor
string

Pagination cursor from a previous response

tag
string

Return only records carrying this tag.

origin
enum<string>

Return only records with this origin.

Available options:
inbound,
imported,
manual

Response

A page of end users

endUsers
object[]
required

This page of end-user records.

isDone
boolean
required

True when this is the last page. Keep paging while it is false.

cursor
string | null

Pass this back as the cursor query parameter to fetch the next page.