List end users
End users
List end users
Page through the end-user records in your organization with cursor pagination and filters.
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.
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
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
Page size. Defaults to 50, capped at 100.
Required range:
x <= 100Pagination cursor from a previous response
Return only records carrying this tag.
Return only records with this origin.
Available options:
inbound, imported, manual 