v1

latestOpenAPI 3.1.02026-08-0612447737.4 KB

Contact Custom Field

List Contact Custom Fields

Retrieve a list of contact custom fields

get/contact_custom_field

Query parameters

contact_idstring

Contact ID

custom_field_idstring

Custom field ID

created_atstring

Contact custom field creation date

updated_atstring

Latest update

organisation_idstring

Organisation ID

keystring

Contact custom field key

valuestring

Value of contact custom field

date_valuestring

Date value

string_valuestring

String value

number_valuestring

Number value

boolean_valuestring

Boolean value

datetime_valuestring

Datetime value

string_list_valuestring

String list value

selectstring

Filtering Columns

offsetstring

Limiting and Pagination

limitstring

Limiting and Pagination

Headers

Rangestring

Limiting and Pagination

Range-Unitstring

Limiting and Pagination

Response

OK

contact_idstring uuid

Contact ID

custom_field_idstring uuid

Custom field ID

created_atstring timestamp with time zone

Contact custom field creation date

updated_atstring timestamp with time zone

Latest update

organisation_idstring uuid

Organisation ID

keystring text

Contact custom field key

valuestring text nullable

Value of contact custom field

date_valuestring date nullable

Date value

string_valuestring text nullable

String value

number_valuenumber nullable

Number value

boolean_valueboolean nullable

Boolean value

datetime_valuestring timestamp with time zone nullable

Datetime value

string_list_valuestring[] nullable

String list value