List Fields

Returns a cursor-paginated list of your custom fields.

GEThttps://api.audienceful.com/v2/fields

curl --location --request GET 'https://api.audienceful.com/v2/fields' \
--header 'Content-Type: application/json' \
--header 'X-Api-Key: <your-api-key>'

{
  "data": [
    {
      "id": "4XJA8RZ6kJRwMJYDBETyZa",
      "name": "Email",
      "data_name": "email",
      "type": "string",
      "editable": false,
      "internal": true,
      "required": false
    },
    {
      "id": "o4i4TNZnWsq2f2ZWVqNNWY",
      "name": "Plan",
      "data_name": "plan",
      "type": "string",
      "editable": true,
      "internal": false,
      "required": false
    }
  ],
  "has_more": false,
  "next_cursor": null
}

Requires the fields:read scope.

Query parameters

page_sizenumberdefault: 100

The number of fields to return per page.

cursorstring

The pagination cursor from a previous response's next_cursor. See Pagination.

Response

dataarray

The page of custom fields.

Properties

idstring

The id of the field. Used to address the field in the retrieve, update, and delete endpoints.

namestring

The human-readable name of the field.

data_namestring

The key used to set and read this field's value on a contact (in extra_data).

typestring

The type of data stored in the field. One of string, boolean, number, tag, datetime, or phone.

editableboolean

Whether the field can be edited. Default fields such as email or tags are not editable.

internalboolean

Whether the field is a built-in, internally managed field.

requiredboolean

Whether a value for this field is required.

has_moreboolean

Whether more fields exist after this page.

next_cursorstring or null

The cursor to pass as ?cursor= to fetch the next page.