Skip to content

List individuals

GET
/audience/management/v1/individuals
curl --request GET \
--url 'https://api.ebitex.io/audience/management/v1/individuals?page=1&pageSize=25' \
--header 'Authorization: Bearer <token>'

Lists the people in the organization, in name order, 25 to a page by default. A person merged into another is not listed.

search finds people whose name, or any identity value, starts with the text. source limits the list to one source kind (person, import, key, app or connector). page starts at 1 and pageSize is at most 100.

Key: an Audience management key with audience.management.read (write also needs read; erase needs both).

search
string
source
string
page
integer | string format: int32
default: 1 /^-?(?:0|[1-9]\d*)$/
pageSize
integer | string format: int32
default: 25 /^-?(?:0|[1-9]\d*)$/

{ "items": [ { "id", "name", … } ], "totalCount", "page", "pageSize" }.

missing_api_key or invalid_api_key: no key was sent, or it is unknown, revoked or expired, or it was not created from the Audience settings page.

payment_required: the organization’s subscription needs attention.

scope_denied: the key lacks this route’s scope. ip_denied: the caller’s address is outside the key’s allowed ranges. app_not_available: Audience is not enabled for the organization.

not_found: no such route.

rate_limited: the key spent its requests-per-minute budget; Retry-After says how long to wait. too_many_failed_authentications: too many bad keys from this address.