Custom Objects

List custom objects

get

Returns paginated custom objects of the given type.

Rate limit: 60 requests per minute

Authorizations

bearerAuth

AuthorizationstringRequired

Authorization: Bearer

Path parameters

typestringRequired

The type slug of the custom object (e.g. "companies").

Query parameters

cursorstringOptional

Pagination cursor for the next page.

limitinteger · int64Optional

Number of results per page. Defaults to 25, max 100.

Responses

200Success

application/json

request_idstringOptional

400Error

application/json

404Error

application/json

500Error

application/json

get/custom-objects/{type}

HTTPcURLJavaScriptPython

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

{
  "data": [
    {
      "created_at": "text",
      "custom_fields": {
        "ANY_ADDITIONAL_PROPERTY": {
          "slug": "text",
          "value": "text",
          "values": [
            "text"
          ]
        }
      },
      "id": "text",
      "name": "text",
      "relations": [
        {
          "object_id": "text",
          "object_type": "text"
        }
      ],
      "type": "text",
      "updated_at": "text"
    }
  ],
  "pagination": {
    "cursor": "text",
    "has_next_page": true
  },
  "request_id": "text"
}

Get a custom object

get

Returns a single custom object by ID, including its custom field values.

Rate limit: 60 requests per minute

Authorizations

bearerAuth

AuthorizationstringRequired

Authorization: Bearer

Path parameters

typestringRequired

The type slug of the custom object (e.g. "companies").

idstringRequired

The ID of the custom object.

Responses

200Success

application/json

request_idstringOptional

404Error

application/json

500Error

application/json

get/custom-objects/{type}/{id}

HTTPcURLJavaScriptPython

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

{
  "data": {
    "created_at": "text",
    "custom_fields": {
      "ANY_ADDITIONAL_PROPERTY": {
        "slug": "text",
        "value": "text",
        "values": [
          "text"
        ]
      }
    },
    "id": "text",
    "name": "text",
    "relations": [
      {
        "object_id": "text",
        "object_type": "text"
      }
    ],
    "type": "text",
    "updated_at": "text"
  },
  "request_id": "text"
}

Search for custom objects by a given filter

post

Currently, the following fields are filterable for custom objects:

• name. Allowed operators: equals, in, not_in, string_contains, string_does_not_contain, is_set, is_unset

• created_at (in RFC3339 format). Allowed operators: time_is_after, time_is_before, time_range

• updated_at (in RFC3339 format). Allowed operators: time_is_after, time_is_before, time_range

• custom fields (pass in the slug of the custom field)

Rate limit: 20 requests per minute

Authorizations

bearerAuth

AuthorizationstringRequired

Authorization: Bearer

Path parameters

typestringRequired

The type slug of the custom object (e.g. "companies").

Body

application/json

cursorstringOptional

The cursor to use for pagination.

limitinteger · int64Optional

The number of results to fetch. Defaults to 25, max 100.

Responses

200Success

application/json

request_idstringOptional

400Error

application/json

404Error

application/json

500Error

application/json

post/custom-objects/{type}/search

HTTPcURLJavaScriptPython

POST /custom-objects/{type}/search HTTP/1.1
Host: api.usepylon.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 312

{
  "cursor": "text",
  "filter": {
    "field": "text",
    "operator": "equals",
    "subfilters": [
      {
        "field": "text",
        "operator": "equals",
        "subfilters": [
          {
            "field": "text",
            "operator": "equals",
            "subfilters": "[Circular Reference]",
            "value": "text",
            "values": [
              "text"
            ]
          }
        ],
        "value": "text",
        "values": [
          "text"
        ]
      }
    ],
    "value": "text",
    "values": [
      "text"
    ]
  },
  "limit": 1
}

{
  "data": [
    {
      "created_at": "text",
      "custom_fields": {
        "ANY_ADDITIONAL_PROPERTY": {
          "slug": "text",
          "value": "text",
          "values": [
            "text"
          ]
        }
      },
      "id": "text",
      "name": "text",
      "relations": [
        {
          "object_id": "text",
          "object_type": "text"
        }
      ],
      "type": "text",
      "updated_at": "text"
    }
  ],
  "pagination": {
    "cursor": "text",
    "has_next_page": true
  },
  "request_id": "text"
}

Create a custom object

post

Creates a new custom object instance of the given type. To link the object to an account, pass the built-in Account relationship field in custom_fields: {"name":"Example","custom_fields":{"account":{"value":"account_uuid"}}}.

Rate limit: 20 requests per minute

Authorizations

bearerAuth

AuthorizationstringRequired

Authorization: Bearer

Path parameters

typestringRequired

The type slug of the custom object (e.g. "companies").

Body

application/json

namestringRequired

The name of the custom object.

Responses

200Success

application/json

request_idstringOptional

400Error

application/json

404Error

application/json

500Error

application/json

post/custom-objects/{type}

HTTPcURLJavaScriptPython

POST /custom-objects/{type} HTTP/1.1
Host: api.usepylon.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 108

{
  "custom_fields": {
    "ANY_ADDITIONAL_PROPERTY": {
      "slug": "text",
      "value": "text",
      "values": [
        "text"
      ]
    }
  },
  "name": "text"
}

{
  "data": {
    "created_at": "text",
    "custom_fields": {
      "ANY_ADDITIONAL_PROPERTY": {
        "slug": "text",
        "value": "text",
        "values": [
          "text"
        ]
      }
    },
    "id": "text",
    "name": "text",
    "relations": [
      {
        "object_id": "text",
        "object_type": "text"
      }
    ],
    "type": "text",
    "updated_at": "text"
  },
  "request_id": "text"
}

Update a custom object

patch

Updates a custom object. Only provided fields are modified. To update the linked account, pass the built-in Account relationship field in custom_fields: {"custom_fields":{"account":{"value":"account_uuid"}}}.

Rate limit: 20 requests per minute

Authorizations

bearerAuth

AuthorizationstringRequired

Authorization: Bearer

Path parameters

typestringRequired

The type slug of the custom object (e.g. "companies").

idstringRequired

The ID of the custom object.

Body

application/json

namestringOptional

The name of the custom object.

Responses

200Success

application/json

request_idstringOptional

400Error

application/json

404Error

application/json

500Error

application/json

patch/custom-objects/{type}/{id}

HTTPcURLJavaScriptPython

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

{
  "custom_fields": {
    "ANY_ADDITIONAL_PROPERTY": {
      "slug": "text",
      "value": "text",
      "values": [
        "text"
      ]
    }
  },
  "name": "text"
}

{
  "data": {
    "created_at": "text",
    "custom_fields": {
      "ANY_ADDITIONAL_PROPERTY": {
        "slug": "text",
        "value": "text",
        "values": [
          "text"
        ]
      }
    },
    "id": "text",
    "name": "text",
    "relations": [
      {
        "object_id": "text",
        "object_type": "text"
      }
    ],
    "type": "text",
    "updated_at": "text"
  },
  "request_id": "text"
}

Bulk update custom objects

patch

Applies the same update to multiple custom objects of the given type in a single request. Pass between 1 and 100 IDs and the custom field values to set; only the provided fields are modified on each object. To update the linked account, pass the built-in Account relationship field in custom_fields: {"ids":["object_uuid"],"custom_fields":{"account":{"value":"account_uuid"}}}. To unset a field, pass its slug with an empty value.

Rate limit: 20 requests per minute

Authorizations

bearerAuth

AuthorizationstringRequired

Authorization: Bearer

Path parameters

typestringRequired

The type slug of the custom object (e.g. "opportunity").

Body

application/json

idsstring[]Required

The IDs of the custom objects to update. Must be between 1 and 100 IDs.

Responses

200Success

application/json

request_idstringOptional

successbooleanOptional

updated_idsstring[]Optional

400Error

application/json

404Error

application/json

500Error

application/json

patch/custom-objects/{type}

HTTPcURLJavaScriptPython

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

{
  "custom_fields": {
    "ANY_ADDITIONAL_PROPERTY": {
      "slug": "text",
      "value": "text",
      "values": [
        "text"
      ]
    }
  },
  "ids": [
    "text"
  ]
}

{
  "request_id": "text",
  "success": true,
  "updated_ids": [
    "text"
  ]
}

Delete a custom object

delete

Deletes a custom object instance.

Rate limit: 20 requests per minute

Authorizations

bearerAuth

AuthorizationstringRequired

Authorization: Bearer

Path parameters

typestringRequired

The type slug of the custom object (e.g. "companies").

idstringRequired

The ID of the custom object.

Responses

200Success

application/json

request_idstringOptional

404Error

application/json

500Error

application/json

delete/custom-objects/{type}/{id}

HTTPcURLJavaScriptPython

DELETE /custom-objects/{type}/{id} HTTP/1.1
Host: api.usepylon.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "request_id": "text"
}