Custom Fields

Get all custom fields

get

Returns all custom field definitions for the specified object type.

Rate limit: 60 requests per minute

Authorizations

AuthorizationstringRequired

Authorization: Bearer

Query parameters

object_typestring · enumRequired

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

Possible values:

Responses

200Success

application/json

request_idstringOptional

The request ID for tracking.

400

The request was invalid or could not be completed.

application/json

404Error

application/json

500

An unexpected internal error occurred.

application/json

get/custom-fields

GET /custom-fields?object_type=account 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,
        "duration_display_format": "text",
        "duration_input_unit": "text",
        "format": "with_commas"
      },
      "object_type": "account",
      "select_metadata": {
        "options": [
          {
            "ai_description": "text",
            "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

AuthorizationstringRequired

Authorization: Bearer

Path parameters

idstringRequired

The ID of the custom field.

Responses

200Success

application/json

request_idstringOptional

The request ID for tracking.

400

The request was invalid or could not be completed.

application/json

404Error

application/json

500

An unexpected internal error occurred.

application/json

get/custom-fields/{id}

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,
      "duration_display_format": "text",
      "duration_input_unit": "text",
      "format": "with_commas"
    },
    "object_type": "account",
    "select_metadata": {
      "options": [
        {
          "ai_description": "text",
          "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

AuthorizationstringRequired

Authorization: Bearer

Body

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_typestring · enumRequired

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

Example: accountPossible values:

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.

Example: text

Responses

200Success

application/json

request_idstringOptional

The request ID for tracking.

400

The request was invalid or could not be completed.

application/json

404Error

application/json

500

An unexpected internal error occurred.

application/json

post/custom-fields

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

{
  "default_value": "text",
  "default_values": [
    "text"
  ],
  "description": "text",
  "label": "text",
  "object_type": "account",
  "select_options": [
    {
      "ai_description": "text",
      "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,
      "duration_display_format": "text",
      "duration_input_unit": "text",
      "format": "with_commas"
    },
    "object_type": "account",
    "select_metadata": {
      "options": [
        {
          "ai_description": "text",
          "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

AuthorizationstringRequired

Authorization: Bearer

Path parameters

idstringRequired

The ID of the custom field.

Body

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.

400

The request was invalid or could not be completed.

application/json

404Error

application/json

500

An unexpected internal error occurred.

application/json

patch/custom-fields/{id}

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

{
  "default_value": "text",
  "default_values": [
    "text"
  ],
  "description": "text",
  "label": "text",
  "select_options": [
    {
      "ai_description": "text",
      "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,
      "duration_display_format": "text",
      "duration_input_unit": "text",
      "format": "with_commas"
    },
    "object_type": "account",
    "select_metadata": {
      "options": [
        {
          "ai_description": "text",
          "label": "text",
          "slug": "text"
        }
      ]
    },
    "slug": "text",
    "source": "text",
    "type": "text",
    "updated_at": "text"
  },
  "request_id": "text"
}