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": "encrypted-id-123",
    "name": "Custom Field Example",
    "type": 0,
    "description": "An example custom field"
  },
  {
    "id": "encrypted-id-456",
    "name": "Another Custom Field",
    "type": 1,
    "description": "Another example custom field"
  }
]

Authorizations

​
X-Team-ApiKey
string
header
required

Query Parameters

​
offset
integer
required

Offset for pagination.

Example:

0

​
limit
integer
required

Limit for pagination.

Example:

10

​
search
string

Search term for filtering results.

Example:

"example search"

Response

200
application/json

List of custom fields retrieved successfully.

The response is of type object[].