List active custom-field definitions

GET

/api/v1/custom-fields

GET

/api/v1/custom-fields

Authorization

bearerAuth custom_fields.read

headerAuthorizationBearer <API key or OAuth 2.1 access token>

Send Authorization: Bearer <credential>. Create API keys in AirTrail Security settings. OAuth clients use authorization code with PKCE S256 and a resource identifier matching /api/v1.

Scope: custom_fields.read

Response Body

Definitions.

application/json

response

data*array<>

Example Request

curl -X GET 'https://your-instance.example/api/v1/custom-fields'

Example Request

curl -X GET 'https://your-instance.example/api/v1/custom-fields'

Example ResponseSchema

{
  "data": [
    {
      "id": 0,
      "entityType": "flight",
      "key": "string",
      "label": "string",
      "description": "string",
      "fieldType": "text",
      "required": true,
      "order": 0,
      "defaultValue": null,
      "options": null
    }
  ]
}

{  "data": [    {      "id": 0,      "entityType": "flight",      "key": "string",      "label": "string",      "description": "string",      "fieldType": "text",      "required": true,      "order": 0,      "defaultValue": null,      "options": null    }  ]}

List active custom-field definitions

AuthorizationCopy Anchor Link

Response BodyCopy Anchor Link

Authorization

Response Body