Skip to main content
GET
/
v1
/
fields
/
objects
Get Object and Fields
curl --request GET \
  --url http://localhost:4000/v1/fields/objects \
  --header 'Authorization: Bearer <token>'
{ "count": 123, "data": [ { "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>", "badge": "<string>", "tooltip": "<string>", "displayIndex": 123, "isArchived": true, "icon": "<string>", "isDefault": true, "actionId": 123, "category": "<string>" } ] } ], "hasMore": true, "nextPage": 123 }

Authorizations

​
Authorization
string
header
required

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

Query Parameters

​
objectType
enum<string>
Available options:
CONTACT,
CALL,
EVENT,
DEAL,
USER,
ISCORE,
UNIFIED_INBOX,
INVITEE_QUESTION
​
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
​
identifiers
string
Maximum string length: 500

Response

Paginated custom fields for the object type

​
count
number
required
​
data
object[]
required
​
hasMore
boolean
required
​
nextPage
number