Skip to main content
GET
/
settings
/
custom-fields
List Custom Fields
curl --request GET \
  --url https://api.getoutbox.ai/settings/custom-fields/ \
  --header 'Authorization: Bearer <token>'
[
  {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "name": "<string>",
    "label": "<string>",
    "field_type": "<string>",
    "description": "<string>",
    "options": [
      {}
    ],
    "created_at": "2023-11-07T05:31:56Z"
  }
]

Authorizations

​
Authorization
string
header
required

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

Response

200 - application/json
​
id
string<uuid>
required
​
name
string
required
​
label
string
required
​
field_type
string
required

text, number, date, select, etc.

​
description
string
required
​
options
object[]
required

Empty unless field_type=select.

​
created_at
string<date-time>
required