Skip to main content
GET
List custom data fields

Authorizations

x-bigco-hmac-sha256
string
header
required

Base64-encoded HMAC-SHA256 signature of the request. Every request must also include the x-bigco-hmac-username and x-date headers, and POST/PUT requests must include x-digest. See the Authentication guide for the full signing procedure.

Response

Your brand's custom data fields.

field_name
string
required

The custom data field name. Lowercase and snake-case it (and prefix with custom_ for CSV imports) when supplying values.

Example:

"loyalty_tier"

custom_data_type
enum<integer>
required

The data type of the field: 1 = INTEGER, 2 = FLOAT, 3 = STRING, 4 = LIST, 5 = BOOLEAN, 6 = DATE.

Available options:
1,
2,
3,
4,
5,
6
Example:

3

id
integer | null
Example:

42

description
string | null
Example:

"The customer's loyalty program tier."

subtype
integer | null

For LIST fields, the type code of the list elements.

Example:

3

available_enum_values
string[] | null

If set, only these values are accepted for the field.

Example:
include_in_ai_prompt
boolean | null
default:false
include_user_answers
boolean | null
default:false
is_append
boolean | null
default:false
is_auto_collected
boolean | null
default:false
extraction_prompt
string | null
is_emphasize_current
boolean | null
default:true
is_emphasize_personal
boolean | null
default:true