Custom Fields

Get all custom fields

get

Returns all custom field definitions for the specified object type.

Rate limit: 60 requests per minute

Authorizations

bearerAuth

AuthorizationstringRequired

Authorization: Bearer

Query parameters

object_typestringRequired

The object type of the custom fields. Can be "account", "issue", "contact", "task", "project", or "call_recording".

Responses

200Success

application/json

request_idstringOptional

The request ID for tracking.

400Error

application/json

404Error

application/json

500Error

application/json

get

/custom-fields

HTTPcURLJavaScriptPython

GET /custom-fields?object_type=text HTTP/1.1
Host: api.usepylon.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "data": [
    {
      "created_at": "text",
      "default_value": "text",
      "default_values": [
        "text"
      ],
      "description": "text",
      "id": "text",
      "is_read_only": true,
      "label": "text",
      "number_metadata": {
        "currency": "text",
        "decimal_places": 1,
        "format": "with_commas"
      },
      "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": true
  },
  "request_id": "text"
}

Get a custom field by its ID

get

Returns a single custom field definition by ID.

Rate limit: 60 requests per minute

Authorizations

bearerAuth

AuthorizationstringRequired

Authorization: Bearer

Path parameters

idstringRequired

The ID of the custom field.

Responses

200Success

application/json

request_idstringOptional

The request ID for tracking.

400Error

application/json

404Error

application/json

500Error

application/json

get

/custom-fields/{id}

HTTPcURLJavaScriptPython

GET /custom-fields/{id} HTTP/1.1
Host: api.usepylon.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "data": {
    "created_at": "text",
    "default_value": "text",
    "default_values": [
      "text"
    ],
    "description": "text",
    "id": "text",
    "is_read_only": true,
    "label": "text",
    "number_metadata": {
      "currency": "text",
      "decimal_places": 1,
      "format": "with_commas"
    },
    "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

post

Creates a new custom field definition for the specified object type.

Rate limit: 20 requests per minute

Authorizations

bearerAuth

AuthorizationstringRequired

Authorization: Bearer

Body

application/json

default_valuestringOptional

The default value for single-valued custom fields.

default_valuesstring[]Optional

The default values for multi-valued custom fields.

descriptionstringOptional

The description of the custom field.

labelstringRequired

The label of the custom field.

object_typestringRequired

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

slugstringOptional

The slug of the custom field.

typestringRequired

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

Responses

200Success

application/json

request_idstringOptional

The request ID for tracking.

400Error

application/json

404Error

application/json

500Error

application/json

post

/custom-fields

HTTPcURLJavaScriptPython

POST /custom-fields HTTP/1.1
Host: api.usepylon.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 185

{
  "default_value": "text",
  "default_values": [
    "text"
  ],
  "description": "text",
  "label": "text",
  "object_type": "text",
  "select_options": [
    {
      "label": "text",
      "slug": "text"
    }
  ],
  "slug": "text",
  "type": "text"
}

{
  "data": {
    "created_at": "text",
    "default_value": "text",
    "default_values": [
      "text"
    ],
    "description": "text",
    "id": "text",
    "is_read_only": true,
    "label": "text",
    "number_metadata": {
      "currency": "text",
      "decimal_places": 1,
      "format": "with_commas"
    },
    "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

patch

Updates a custom field definition. Only provided fields are modified.

Rate limit: 20 requests per minute

Authorizations

bearerAuth

AuthorizationstringRequired

Authorization: Bearer

Path parameters

idstringRequired

The ID of the custom field.

Body

application/json

default_valuestringOptional

The default value for single-valued custom fields.

default_valuesstring[]Optional

The default values for multi-valued custom fields.

descriptionstringOptional

The description of the custom field.

labelstringOptional

The label of the custom field.

slugstringOptional

The slug of the custom field.

Responses

200Success

application/json

request_idstringOptional

The request ID for tracking.

400Error

application/json

404Error

application/json

500Error

application/json

patch

/custom-fields/{id}

HTTPcURLJavaScriptPython

PATCH /custom-fields/{id} HTTP/1.1
Host: api.usepylon.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 150

{
  "default_value": "text",
  "default_values": [
    "text"
  ],
  "description": "text",
  "label": "text",
  "select_options": [
    {
      "label": "text",
      "slug": "text"
    }
  ],
  "slug": "text"
}

{
  "data": {
    "created_at": "text",
    "default_value": "text",
    "default_values": [
      "text"
    ],
    "description": "text",
    "id": "text",
    "is_read_only": true,
    "label": "text",
    "number_metadata": {
      "currency": "text",
      "decimal_places": 1,
      "format": "with_commas"
    },
    "object_type": "text",
    "select_metadata": {
      "options": [
        {
          "label": "text",
          "slug": "text"
        }
      ]
    },
    "slug": "text",
    "source": "text",
    "type": "text",
    "updated_at": "text"
  },
  "request_id": "text"
}