Skip to main content
GET
/
customfield
Get all custom fields
curl --request GET \
  --url https://api.sendx.io/api/v1/rest/customfield \
  --header 'X-Team-ApiKey: <api-key>'
[
  {
    "id": "custom_field_abc123def456ghi789",
    "name": "Account Type",
    "type": 0,
    "description": "Customer account classification"
  },
  {
    "id": "custom_field_abc123def456ghi783",
    "name": "Loyalty Points",
    "type": 1,
    "description": "Current loyalty program points"
  },
  {
    "id": "custom_field_abc123def456ghi703",
    "name": "Last Purchase Date",
    "type": 2,
    "description": "Date of most recent purchase"
  }
]
📊 Response includes:
  • Field ID
  • Field name and type
  • Description

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

Query Parameters

​
offset
integer
default:0

Number of fields to skip for pagination

Required range: x >= 0
​
limit
integer
default:10

Maximum number of fields to return

Required range: 1 <= x <= 100
​
search
string

Search custom fields by name (case-insensitive partial matching).

Examples:

  • points - Finds "Loyalty points", "Reward points"
Required string length: 2 - 100

Response

✅ Custom fields 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"