Get All Objects and Fields

curl --request GET \
  --url http://localhost:4000/v1/fields/objects/all \
  --header 'Authorization: Bearer <token>'

import requests

url = "http://localhost:4000/v1/fields/objects/all"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('http://localhost:4000/v1/fields/objects/all', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_PORT => "4000",
  CURLOPT_URL => "http://localhost:4000/v1/fields/objects/all",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "http://localhost:4000/v1/fields/objects/all"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.get("http://localhost:4000/v1/fields/objects/all")
  .header("Authorization", "Bearer <token>")
  .asString();

require 'uri'
require 'net/http'

url = URI("http://localhost:4000/v1/fields/objects/all")

http = Net::HTTP.new(url.host, url.port)

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

{
  "data": {
    "CONTACT": [
      {
        "id": 123,
        "name": "<string>",
        "identifier": "<string>",
        "inputType": "<string>",
        "type": "<string>",
        "configuration": {
          "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": {
          "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": {
          "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": {
          "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": {
          "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": {
          "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": {
          "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": {
          "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>"
          }
        ]
      }
    ]
  }
}

GET

fields

objects

all

Get All Objects and Fields

curl --request GET \
  --url http://localhost:4000/v1/fields/objects/all \
  --header 'Authorization: Bearer <token>'

import requests

url = "http://localhost:4000/v1/fields/objects/all"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('http://localhost:4000/v1/fields/objects/all', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_PORT => "4000",
  CURLOPT_URL => "http://localhost:4000/v1/fields/objects/all",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "http://localhost:4000/v1/fields/objects/all"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.get("http://localhost:4000/v1/fields/objects/all")
  .header("Authorization", "Bearer <token>")
  .asString();

require 'uri'
require 'net/http'

url = URI("http://localhost:4000/v1/fields/objects/all")

http = Net::HTTP.new(url.host, url.port)

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

{
  "data": {
    "CONTACT": [
      {
        "id": 123,
        "name": "<string>",
        "identifier": "<string>",
        "inputType": "<string>",
        "type": "<string>",
        "configuration": {
          "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": {
          "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": {
          "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": {
          "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": {
          "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": {
          "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": {
          "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": {
          "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

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

Show child attributes

Get Object and Fields Get Deals

API v1 Reference

Busy Slots

Contacts

Fields

Deals

Calls

Events

Products

Call Outcomes

Transactions

User Availabilities

Users

Get All Objects and Fields

Authorizations

Query Parameters

Response