Retrieve a Field

Retrieves a single custom field by its id.

GEThttps://api.audienceful.com/v2/fields/{id}

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

{
  "id": "o4i4TNZnWsq2f2ZWVqNNWY",
  "name": "Plan",
  "data_name": "plan",
  "type": "string",
  "editable": true,
  "internal": false,
  "required": false
}

Requires the fields:read scope.

Path parameters

idstringrequired

The id of the field.

Response

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.

Last updated: July 11, 2026

List Fields

Create a Field