Skip to content

List accounts

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

Lists the organization’s accounts in name order, 25 to a page by default. search finds accounts whose name, any word of it, or external id starts with the text. page starts at 1 and pageSize is at most 100.

Accounts are optional and off until the organization turns them on in Audience settings; every account route answers 409 accounts_not_enabled until then. An account is a group of people the organization tracks as one thing (a company, a household, a school). It is identified by an external id you supply (for example your own customer id), which is case-sensitive and unique in the organization: there is no fuzzy matching, so two accounts are the same account only when the external id is the same. A person can belong to any number of accounts, with an optional role in each.

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

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

{ "items": [ … ], "totalCount", "page", "pageSize" }, each item as an account.

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.

accounts_not_enabled: the organization has not turned accounts on.

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.