Sign in

v1

latestOpenAPI 3.1.02026-08-0612447737.4 KB
Custom Field

List Custom Fields

Retrieve a list of custom fields

get/custom_field

Query parameters

idstring

Custom field ID

created_atstring

Custom field creation date

updated_atstring

Latest update

organisation_idstring

Organisation ID

namestring

Name of custom field

descriptionstring

Custom field description

typestring

Typ of custom field

keystring

Custom field key

entitystring
selectstring

Filtering Columns

offsetstring

Limiting and Pagination

limitstring

Limiting and Pagination

Headers

Rangestring

Limiting and Pagination

Range-Unitstring

Limiting and Pagination

Response

OK

idstring uuid

Custom field ID

created_atstring timestamp with time zone

Custom field creation date

updated_atstring timestamp with time zone

Latest update

organisation_idstring uuid nullable

Organisation ID

namestring text

Name of custom field

descriptionstring text nullable

Custom field description

type'string' | 'datetime' | 'boolean' | 'number' | 'date' | 'string_list' public.field_type

Typ of custom field

keystring text

Custom field key

entity'contact' | 'deal' | 'appointment' public.custom_field_entity