Skip to main content
GET
/
v3
/
custom-fields
/
{id}
Get Custom Field
curl --request GET \
  --url https://api4.kinbox.com.br/v3/custom-fields/{id} \
  --header 'Authorization: Bearer <token>'
{
  "id": "<string>",
  "_id": "<string>",
  "name": "<string>",
  "description": "<string>",
  "entity": "<string>",
  "placeholder": "<string>",
  "type": "<string>",
  "options": {},
  "isActive": true,
  "isDeleted": true,
  "invisible": true,
  "position": 123,
  "isUniqueIdentifier": true,
  "isIntegration": true,
  "showAlways": true,
  "requiredToResolve": true,
  "resetOnNewCall": true,
  "validate": {},
  "validation_mask": {},
  "validation_type": "<string>",
  "dependency": {},
  "isDependent": true,
  "workspaceId": 123,
  "createdAt": "2023-11-07T05:31:56Z",
  "lastUpdateAt": "2023-11-07T05:31:56Z",
  "updatedAt": "2023-11-07T05:31:56Z"
}

Authorizations

​
Authorization
string
header
required

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

Path Parameters

​
id
number
required

Response

200 - application/json
​
id
string
required
​
name
string
required
​
description
string
required
​
entity
string
required
​
placeholder
string
required
​
type
string
required
​
options
object
required
​
isActive
boolean
required
​
isDeleted
boolean
required
​
invisible
boolean
required
​
position
number
required
​
isUniqueIdentifier
boolean
required
​
isIntegration
boolean
required
​
showAlways
boolean
required
​
requiredToResolve
boolean
required
​
resetOnNewCall
boolean
required
​
validate
object
required
​
validation_mask
object
required
​
validation_type
string
required
​
dependency
object
required
​
isDependent
boolean
required
​
workspaceId
number
required
​
createdAt
string<date-time>
required
​
lastUpdateAt
string<date-time>
required
​
_id
string
​
updatedAt
string<date-time>