Skip to main content
GET
/
customfield
/
{identifier}
Get custom field by ID
curl --request GET \
  --url https://api.sendx.io/api/v1/rest/customfield/{identifier} \
  --header 'X-Team-ApiKey: <api-key>'
{
  "id": "custom_field_abc123def456ghi789",
  "name": "Account Type",
  "type": 123,
  "description": "Customer account classification"
}

Authorizations

​
X-Team-ApiKey
string
header
required

Team API key for authentication. Find your API key in SendX Settings → Team API Key.

Example:

X-Team-ApiKey: your_team_api_key_here

Path Parameters

​
identifier
string
required

Custom field identifier to update

Pattern: ^(custom_field_)?[a-zA-Z0-9]{22}$

Response

✅ Custom field retrieved successfully

​
id
string

Unique field identifier with custom_field_ prefix

Pattern: ^custom_field_[a-zA-Z0-9]{22}$
Example:

"custom_field_abc123def456ghi789"

​
name
string

Custom field name

Example:

"Account Type"

​
type
integer

Field data type.

Values:

  • 0 - Text (max 255 characters)
  • 1 - Number (integer or decimal)
  • 2 - Date (YYYY-MM-DD format)
  • 3 - Boolean (true/false)
  • 4 - Phone number (international format)
​
description
string

Field description for documentation

Example:

"Customer account classification"