Fields
List Fields
Fields
List Fields
This endpoint retrieves the list of your custom fields
GET
/
api
/
people
/
fields
/
X-Api-Key
string
*
X-Api-Key
Required
string
curl --location --request GET 'https://app.audienceful.com/api/people/fields/' \
--header 'Content-Type: application/json' \
--header 'X-Api-Key: <token>' \
[
{
"id": "4XJA8RZ6kJRwMJYDBETyZa",
"name": "Email",
"data_name": "email",
"type": "string",
"editable": false
},
{
"id": "o4i4TNZnWsq2f2ZWVqNNWY",
"name": "Tags",
"data_name": "tags",
"type": "tag",
"editable": false
}
]
Response
The list of custom fields
id
string
The id of the field
name
string
The human readable name of the field
data_name
string
The data name of the field is used in subsequent API requests for people
editable
boolean
Allows the field to be edited or not (default fields such as email or tags are not editable)
type
string | boolean | tag | number
The type of data stored in the field
curl --location --request GET 'https://app.audienceful.com/api/people/fields/' \
--header 'Content-Type: application/json' \
--header 'X-Api-Key: <token>' \
[
{
"id": "4XJA8RZ6kJRwMJYDBETyZa",
"name": "Email",
"data_name": "email",
"type": "string",
"editable": false
},
{
"id": "o4i4TNZnWsq2f2ZWVqNNWY",
"name": "Tags",
"data_name": "tags",
"type": "tag",
"editable": false
}
]