Skip to main content
GET
/
v1
/
fields
/
objects
/
all
Get All Objects and Fields
curl --request GET \
  --url http://localhost:4000/v1/fields/objects/all \
  --header 'Authorization: Bearer <token>'
{
  "data": {
    "CONTACT": [
      {
        "id": 123,
        "name": "<string>",
        "identifier": "<string>",
        "inputType": "<string>",
        "type": "<string>",
        "configuration": {
          "dateTimeFormat": "12Hour",
          "dateType": "US",
          "includedTime": true
        },
        "isSystemField": true,
        "hidden": true,
        "slug": "<string>",
        "CustomFieldOptions": [
          {
            "id": 123,
            "name": "<string>",
            "color": "<string>",
            "displayIndex": 123,
            "isArchived": true,
            "icon": "<string>",
            "isDefault": true,
            "category": "<string>"
          }
        ]
      }
    ],
    "CALL": [
      {
        "id": 123,
        "name": "<string>",
        "identifier": "<string>",
        "inputType": "<string>",
        "type": "<string>",
        "configuration": {
          "dateTimeFormat": "12Hour",
          "dateType": "US",
          "includedTime": true
        },
        "isSystemField": true,
        "hidden": true,
        "slug": "<string>",
        "CustomFieldOptions": [
          {
            "id": 123,
            "name": "<string>",
            "color": "<string>",
            "displayIndex": 123,
            "isArchived": true,
            "icon": "<string>",
            "isDefault": true,
            "category": "<string>"
          }
        ]
      }
    ],
    "EVENT": [
      {
        "id": 123,
        "name": "<string>",
        "identifier": "<string>",
        "inputType": "<string>",
        "type": "<string>",
        "configuration": {
          "dateTimeFormat": "12Hour",
          "dateType": "US",
          "includedTime": true
        },
        "isSystemField": true,
        "hidden": true,
        "slug": "<string>",
        "CustomFieldOptions": [
          {
            "id": 123,
            "name": "<string>",
            "color": "<string>",
            "displayIndex": 123,
            "isArchived": true,
            "icon": "<string>",
            "isDefault": true,
            "category": "<string>"
          }
        ]
      }
    ],
    "DEAL": [
      {
        "id": 123,
        "name": "<string>",
        "identifier": "<string>",
        "inputType": "<string>",
        "type": "<string>",
        "configuration": {
          "dateTimeFormat": "12Hour",
          "dateType": "US",
          "includedTime": true
        },
        "isSystemField": true,
        "hidden": true,
        "slug": "<string>",
        "CustomFieldOptions": [
          {
            "id": 123,
            "name": "<string>",
            "color": "<string>",
            "displayIndex": 123,
            "isArchived": true,
            "icon": "<string>",
            "isDefault": true,
            "category": "<string>"
          }
        ]
      }
    ],
    "USER": [
      {
        "id": 123,
        "name": "<string>",
        "identifier": "<string>",
        "inputType": "<string>",
        "type": "<string>",
        "configuration": {
          "dateTimeFormat": "12Hour",
          "dateType": "US",
          "includedTime": true
        },
        "isSystemField": true,
        "hidden": true,
        "slug": "<string>",
        "CustomFieldOptions": [
          {
            "id": 123,
            "name": "<string>",
            "color": "<string>",
            "displayIndex": 123,
            "isArchived": true,
            "icon": "<string>",
            "isDefault": true,
            "category": "<string>"
          }
        ]
      }
    ],
    "UNIFIED_INBOX": [
      {
        "id": 123,
        "name": "<string>",
        "identifier": "<string>",
        "inputType": "<string>",
        "type": "<string>",
        "configuration": {
          "dateTimeFormat": "12Hour",
          "dateType": "US",
          "includedTime": true
        },
        "isSystemField": true,
        "hidden": true,
        "slug": "<string>",
        "CustomFieldOptions": [
          {
            "id": 123,
            "name": "<string>",
            "color": "<string>",
            "displayIndex": 123,
            "isArchived": true,
            "icon": "<string>",
            "isDefault": true,
            "category": "<string>"
          }
        ]
      }
    ],
    "INVITEE_QUESTION": [
      {
        "id": 123,
        "name": "<string>",
        "identifier": "<string>",
        "inputType": "<string>",
        "type": "<string>",
        "configuration": {
          "dateTimeFormat": "12Hour",
          "dateType": "US",
          "includedTime": true
        },
        "isSystemField": true,
        "hidden": true,
        "slug": "<string>",
        "CustomFieldOptions": [
          {
            "id": 123,
            "name": "<string>",
            "color": "<string>",
            "displayIndex": 123,
            "isArchived": true,
            "icon": "<string>",
            "isDefault": true,
            "category": "<string>"
          }
        ]
      }
    ],
    "ISCORE": [
      {
        "id": 123,
        "name": "<string>",
        "identifier": "<string>",
        "inputType": "<string>",
        "type": "<string>",
        "configuration": {
          "dateTimeFormat": "12Hour",
          "dateType": "US",
          "includedTime": true
        },
        "isSystemField": true,
        "hidden": true,
        "slug": "<string>",
        "CustomFieldOptions": [
          {
            "id": 123,
            "name": "<string>",
            "color": "<string>",
            "displayIndex": 123,
            "isArchived": true,
            "icon": "<string>",
            "isDefault": true,
            "category": "<string>"
          }
        ]
      }
    ]
  }
}

Authorizations

​
Authorization
string
header
required

API key required in Authorization header. Format: iclosed-<token>

Query Parameters

​
page
integer
Required range: x >= 0
​
limit
integer
default:20
Required range: 1 <= x <= 100
​
search
string
Maximum string length: 1000
​
inputType
enum<string>
Available options:
NUMBER,
TEXT,
TEXT_AREA,
DATE,
USER,
USERS_MULTIPLE,
URL,
SINGLE_SELECT,
MULTIPLE_SELECT,
EMAIL,
RATING
​
showSystemFields
enum<string>
Available options:
true,
false
​
inviteeQuestions
enum<string>
Available options:
true,
false

Response

Custom fields grouped by object type

​
data
object
required