GET
/
v1
/
custom-field
cURL
curl --request GET \
  --url https://platform.thena.ai/v1/custom-field \
  --header 'x-api-key: <api-key>'
{
  "data": [
    {
      "name": "<string>",
      "uid": "<string>",
      "slug": "<string>",
      "organizationId": "<string>",
      "source": "ticket",
      "fieldType": "single_line",
      "options": [
        "<string>"
      ],
      "metadata": {},
      "createdAt": "2023-11-07T05:31:56Z",
      "updatedAt": "2023-11-07T05:31:56Z",
      "isActive": true,
      "teamId": "<string>",
      "autoAddToAllForms": true,
      "hintText": "<string>",
      "placeholderText": "<string>",
      "mandatoryOnCreation": true,
      "mandatoryOnClose": true,
      "visibleToCustomer": true,
      "editableByCustomer": true,
      "defaultValue": "<string>"
    }
  ],
  "status": true,
  "message": "<string>",
  "timestamp": "2023-11-07T05:31:56Z"
}

Authorizations

x-api-key
string
header
required

Enter your API key

Query Parameters

limit
number

Number of results per page

Example:

10

page
number

Page number (0-based)

Example:

0

teamId
string

Filter by specific team ID

Example:

"team_01jb4xm9qr3kv5w8n2p7s9t1"

source
enum<string>

Filter by custom field source

Available options:
ticket,
account,
custom_object,
customer_contact
onlyTeamFields
boolean

Show only team-specific fields

Example:

false

Response

Operation successful

data
object[]
required
status
boolean
required
message
string
required
timestamp
string<date-time>
required