Custom Fields

Get all custom fields.

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

Query parameters

Response

200400404500

Body

application/json

dataarray of CustomFieldDefinition (object)

The data payload of the response.

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

200400404500

{
  "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"
    }
  ],
  "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

200400404500

Body

application/json

dataCustomFieldDefinition (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

200400404500

{
  "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"
  },
  "request_id": "text"
}

Create a custom field.

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

Body

application/json

default_valuestring

The default value for single-valued custom fields.

default_valuesarray of string

The default values for multi-valued custom fields.

descriptionstring

The description of the custom field.

label*string

The label of the custom field.

object_type*string

The object type of the custom field. Can be "account", "issue", or "contact"

select_optionsarray of CustomFieldDefinitionSelectOption (object)

The list options of the select custom field. This is only present for select and multiselect custom fields.

slugstring

The slug of the custom field.

type*string

The type of the custom field. Can be one of text, number, decimal, boolean, date, datetime, user, url, select, or multiselect.

Response

200400404500

Body

application/json

dataCustomFieldDefinition (object)

request_idstring

The request ID for tracking.

Request

JavaScriptCurlPython

const response = await fetch('https://api.usepylon.com/custom-fields', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "label": "text",
      "object_type": "text",
      "type": "text"
    }),
});
const data = await response.json();

Response

200400404500

{
  "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"
  },
  "request_id": "text"
}

Update a custom field.

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

Path parameters

id*string

The ID of the custom field.

Body

application/json

default_valuestring

The default value for single-valued custom fields.

default_valuesarray of string

The default values for multi-valued custom fields.

descriptionstring

The description of the custom field.

labelstring

The label of the custom field.

select_optionsarray of CustomFieldDefinitionSelectOption (object)

The list options of the select custom field. This is only present for select and multiselect custom fields.

slugstring

The slug of the custom field.

Response

200400404500

Body

application/json

dataCustomFieldDefinition (object)

request_idstring

The request ID for tracking.

Request

JavaScriptCurlPython

const response = await fetch('https://api.usepylon.com/custom-fields/{id}', {
    method: 'PATCH',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

200400404500

{
  "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"
  },
  "request_id": "text"
}