Skip to main content
List Custom Fields
curl --request GET \
  --url https://integration.getmateo.com/api/v1/custom_field \
  --header 'Authorization: Bearer <token>'
[
  {
    "id": "random uuid",
    "created_at": "now()",
    "updated_at": "now()",
    "organisation_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "name": "<string>",
    "description": "<string>",
    "type": "string",
    "key": "<string>",
    "entity": "contact"
  }
]

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

​
Range
string

Limiting and Pagination

​
Range-Unit
string
default:items

Limiting and Pagination

Query Parameters

​
id
string

Custom field ID

​
created_at
string

Custom field creation date

​
updated_at
string

Latest update

​
organisation_id
string

Organisation ID

​
name
string

Name of custom field

​
description
string

Custom field description

​
type
string

Typ of custom field

​
key
string

Custom field key

​
entity
string
​
select
string

Filtering Columns

​
offset
string

Limiting and Pagination

​
limit
string

Limiting and Pagination

Response

200 - application/json

OK

​
id
string<uuid>
default:random uuid

Custom field ID

​
created_at
string<timestamp with time zone>
default:now()

Custom field creation date

​
updated_at
string<timestamp with time zone>
default:now()

Latest update

​
organisation_id
string<uuid> | null

Organisation ID

​
name
string<text>

Name of custom field

​
description
string<text> | null

Custom field description

​
type
enum<string>

Typ of custom field

Available options:
string,
datetime,
boolean,
number,
date,
string_list
​
key
string<text>

Custom field key

​
entity
enum<string>
default:contact
Available options:
contact,
deal,
appointment