Custom Fields

Get all custom fields.

GEThttps://api.usepylon.com/custom-fields

Query parameters

Response

200

Body

application/json

dataarray of CustomFieldDefinition (object)

The data payload of the response.

errorsarray of string

The list of errors, if any.

paginationPagination (object)

request_idstring

The request ID for tracking.

Request

JavaScriptCurlPython

const response = await fetch('https://api.usepylon.com/custom-fields?object_type=text', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200

{
  "data": [
    {
      "created_at": "text",
      "default_value": "text",
      "default_values": [
        "text"
      ],
      "description": "text",
      "id": "text",
      "is_read_only": false,
      "label": "text",
      "object_type": "text",
      "select_metadata": {
        "options": [
          {
            "label": "text",
            "slug": "text"
          }
        ]
      },
      "slug": "text",
      "source": "text",
      "type": "text",
      "updated_at": "text"
    }
  ],
  "errors": [
    "text"
  ],
  "pagination": {
    "cursor": "text",
    "has_next_page": false
  },
  "request_id": "text"
}

Get a custom field by its ID.

GEThttps://api.usepylon.com/custom-fields/{id}

Path parameters

id*string

The ID of the custom field.

Response

200

Body

application/json

dataCustomFieldDefinition (object)

errorsarray of string

The list of errors, if any.

paginationPagination (object)

request_idstring

The request ID for tracking.

Request

JavaScriptCurlPython

const response = await fetch('https://api.usepylon.com/custom-fields/{id}', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200

{
  "data": {
    "created_at": "text",
    "default_value": "text",
    "default_values": [
      "text"
    ],
    "description": "text",
    "id": "text",
    "is_read_only": false,
    "label": "text",
    "object_type": "text",
    "select_metadata": {
      "options": [
        {
          "label": "text",
          "slug": "text"
        }
      ]
    },
    "slug": "text",
    "source": "text",
    "type": "text",
    "updated_at": "text"
  },
  "errors": [
    "text"
  ],
  "pagination": {
    "cursor": "text",
    "has_next_page": false
  },
  "request_id": "text"
}