Skip to main content
GET
/
v1
/
custom-fields
/
{idOrName}
Get custom field by id or name
curl --request GET \
  --url https://app.chatbotx.io/api/v1/custom-fields/{idOrName} \
  --header 'Authorization: Bearer <token>'
{
  "id": "<string>",
  "name": "<string>",
  "description": "<string>"
}

Authorizations

​
Authorization
string
header
required

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

Path Parameters

​
idOrName
string
required

Response

OK

​
id
string
required
​
name
string
required
​
type
enum<string>
required
Available options:
shortText,
email,
phoneNumber,
number,
date,
datetime,
boolean,
longText
​
description
string | null
required