Custom Fields

List and create organization-level custom field definitions for contacts

Get Custom Fields

get

Get all custom field definitions for the organization. Supports pagination with page and page_size query parameters.

Authorizations

OrganizationApiToken

AuthorizationstringRequired

Organization API Token.

Paste only your token in the field below — the Bearer prefix is added automatically by the docs UI and in every generated code sample. The final header sent is:

Authorization: Bearer {orgId}.{secretToken}

Token format: {orgId}.{secretToken} — example: 15c94c3c-1873-4a09-bfbb-03357c29ea50.abc123xyz.

JWT tokens are NOT accepted.

Query parameters

pageintegerOptional

Page number

page_sizeintegerOptional

Number of results per page (max 100)

Responses

200

List of organization-level custom field definitions

application/json

Other propertiesanyOptional

get/api/account/custom-fields

HTTPcURLJavaScriptPython

GET /api/account/custom-fields HTTP/1.1
Host: api.agentalk.io
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200

List of organization-level custom field definitions

{
  "customFields": [
    {
      "id": "f1e2d3c4-b5a6-7890-abcd-ef1234567890",
      "key": "city",
      "label": "City",
      "type": "text",
      "options": null,
      "required": false,
      "created_at": "2025-01-01T00:00:00Z",
      "updated_at": "2025-01-01T00:00:00Z"
    }
  ]
}

Create Custom Field

post

Create a new custom field definition at organization level. The key will be used as 'custom.{key}' when setting values on contacts.

Authorizations

OrganizationApiToken

AuthorizationstringRequired

Organization API Token.

Paste only your token in the field below — the Bearer prefix is added automatically by the docs UI and in every generated code sample. The final header sent is:

Authorization: Bearer {orgId}.{secretToken}

Token format: {orgId}.{secretToken} — example: 15c94c3c-1873-4a09-bfbb-03357c29ea50.abc123xyz.

JWT tokens are NOT accepted.

Body

application/json

keystringRequired

Field key (required, used as custom.key)

Example: city

labelstringRequired

Display label (required)

Example: City

typestring · enumOptional

Field type

Example: textPossible values:

optionsstring[]Optional

Options for select types

Example: ["Option 1","Option 2"]

Responses

201

Custom field created successfully

application/json

Other propertiesanyOptional

409

Custom field with this key already exists

application/json

post/api/account/custom-fields

HTTPcURLJavaScriptPython

POST /api/account/custom-fields HTTP/1.1
Host: api.agentalk.io
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 77

{
  "key": "city",
  "label": "City",
  "type": "text",
  "options": [
    "Option 1",
    "Option 2"
  ]
}

{
  "customField": {
    "id": "f1e2d3c4-b5a6-7890-abcd-ef1234567890",
    "key": "city",
    "label": "City",
    "type": "text",
    "options": null,
    "required": false,
    "created_at": "2025-01-01T00:00:00Z",
    "updated_at": "2025-01-01T00:00:00Z"
  }
}