Skip to main content
GET
Get all custom fields
📊 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:

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 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"