Get the custom fields

GET

/audience/management/v1/schema

const url = 'https://api.ebitex.io/audience/management/v1/schema';
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request GET \
  --url https://api.ebitex.io/audience/management/v1/schema \
  --header 'Authorization: Bearer <token>'

Returns the organization’s custom fields for people: each field’s key, label, type, whether it is required and its settings. Values you send in attributes are checked against this.

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

Authorizations

apiKey

Responses

200

{ "fields": [ { "key", "label", "type", … } ], "version" }.

401

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.

402

payment_required: the organization’s subscription needs attention.

403

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.

404

not_found: no such route.

429

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.