Custom Objects

get

Custom objects

Authorizations

businessId & userId & apiKey

X-BUSINESS-IDstringRequired

X-USER-IDstringRequired

X-API-KEYstringRequired

Query parameters

allow_relationsbooleanOptional

custom_onlybooleanOptional

Filter Custom Objects for the Client object (is_custom field)

Default: true

default_on_activitiesbooleanOptional

is_custombooleanOptional

namestringOptional

object_namestringOptional

object_typestring · enumOptional

• pipeline - pipeline
• standard - standard

Possible values:

orderingstring · enumOptional

Which field to use when ordering the results. Prepend with '-' for descending order.

Possible values:

pageintegerOptional

A page number within the paginated result set.

page_sizeintegerOptional

Number of results to return per page.

searchstringOptional

A search term.

Responses

200Success

application/json

get

/api/custom-objects

HTTPcURLJavaScriptPython

GET /api/custom-objects HTTP/1.1
Host: 
X-BUSINESS-ID: YOUR_API_KEY
X-USER-ID: YOUR_API_KEY
X-API-KEY: YOUR_API_KEY
Accept: */*

200Success

{
  "count": 123,
  "next": "http://api.example.org/accounts/?page=4",
  "previous": "http://api.example.org/accounts/?page=2",
  "results": [
    {
      "fetch_url": "text",
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "name": "text",
      "object_type": "pipeline",
      "object_name": "text",
      "entity_name": "text",
      "rollup_related_leadsources": true,
      "association_source": "direct",
      "has_commerce_data": true,
      "default_on_activities": true,
      "owner": {
        "id": "123e4567-e89b-12d3-a456-426614174000",
        "first_name": "text",
        "last_name": "text",
        "email": "[email protected]",
        "full_name": "text",
        "picture": {
          "id": "text",
          "created": "2026-01-17T07:09:40.741Z",
          "key": "text",
          "name": "text",
          "url": "text",
          "thumbnail_url": "text",
          "size_bytes": "text",
          "content_type": "text",
          "size_formatted": "text",
          "is_public": true
        }
      },
      "description": "text",
      "is_custom": true,
      "allow_relations": true,
      "created": "2026-01-17T07:09:40.741Z",
      "access": {
        "view": true,
        "edit": true,
        "remove": true
      },
      "track_entity_value": true,
      "include_percentage_to_close": true,
      "use_ai_to_update_percentage": true,
      "ai_confidence_threshold": "text",
      "allow_on_forms": true,
      "default_color": "text",
      "default_icon": "text"
    }
  ],
  "errors": [
    "error message"
  ]
}

get

Custom object with fields and categories

Authorizations

businessId & userId & apiKey

X-BUSINESS-IDstringRequired

X-USER-IDstringRequired

X-API-KEYstringRequired

Path parameters

object_pkstring · uuidRequired

Responses

200Success

application/json

get

/api/custom-objects/{object_pk}/detail

HTTPcURLJavaScriptPython

GET /api/custom-objects/{object_pk}/detail HTTP/1.1
Host: 
X-BUSINESS-ID: YOUR_API_KEY
X-USER-ID: YOUR_API_KEY
X-API-KEY: YOUR_API_KEY
Accept: */*

200Success

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "object_type": "pipeline",
  "entity_name": "text",
  "object_name": "text",
  "has_commerce_data": false,
  "default_on_activities": true,
  "owner": {
    "picture_url": "text",
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "first_name": "text",
    "last_name": "text",
    "email": "[email protected]",
    "display_name": "text"
  },
  "name": "text",
  "description": "text",
  "ai_description": "text",
  "is_custom": true,
  "fetch_url": "text",
  "allow_relations": true,
  "meta": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "related_objects": [
    {
      "related_object": "123e4567-e89b-12d3-a456-426614174000",
      "relation_type": "one_to_one",
      "rollup_timeline": false,
      "rollup_leadsources": true,
      "object_type": "text",
      "object_name": "text",
      "entity_name": "text",
      "field_id": "123e4567-e89b-12d3-a456-426614174000"
    }
  ],
  "created": "2026-01-17T07:09:40.741Z",
  "access": {
    "view": true,
    "edit": true,
    "remove": true
  },
  "entity_access": true,
  "rollup_related_leadsources": true,
  "quick_filtering_enabled": true,
  "record_layouts": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "name": "text",
      "config": {
        "ANY_ADDITIONAL_PROPERTY": "anything"
      },
      "tabs": {
        "ANY_ADDITIONAL_PROPERTY": "anything"
      },
      "order": 1
    }
  ],
  "association_source": "direct",
  "association_source_fields": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "name": "text",
      "related_field": "text",
      "related_object": "text"
    }
  ],
  "field_categories": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "name": "text",
      "order": 1
    }
  ],
  "fields": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "name": "text",
      "category": "123e4567-e89b-12d3-a456-426614174000",
      "display_name": "text",
      "canonical_display_name": "text",
      "is_default": true,
      "field_type": "checkbox",
      "is_required": true,
      "is_read_only": true,
      "is_hidden": true,
      "is_deletable": true,
      "is_hideable": true,
      "is_suppressed": true,
      "include_in_short_form": "text",
      "allows_nulls": true,
      "allows_empty": true,
      "order": 1,
      "meta": {
        "ANY_ADDITIONAL_PROPERTY": "anything"
      },
      "description": "text",
      "description_visibility": "all",
      "properties": {
        "ANY_ADDITIONAL_PROPERTY": "anything"
      },
      "access": {
        "view": true,
        "edit": true,
        "remove": true
      },
      "options": [
        {
          "id": "123e4567-e89b-12d3-a456-426614174000",
          "code": "text",
          "name": "text",
          "order": 1,
          "meta": {
            "ANY_ADDITIONAL_PROPERTY": "anything"
          },
          "percentage_chance_to_close": 1,
          "chance_to_close_percentage": 1,
          "status": "open"
        }
      ],
      "relation": {
        "related_field": "123e4567-e89b-12d3-a456-426614174000",
        "related_object": "123e4567-e89b-12d3-a456-426614174000",
        "related_category": "123e4567-e89b-12d3-a456-426614174000",
        "related_name": "text",
        "related_object_name": "text",
        "related_object_object_name": "text",
        "related_entity_name": "text",
        "relation_type": "one_to_one",
        "cardinality": "one_to_one",
        "fetch_url": "text",
        "rollup_timeline": true,
        "rollup_leadsources": true,
        "inverse_relation_rollup_timeline": true,
        "inverse_relation_rollup_leadsources": true,
        "inverse_relation_suppressed": true,
        "related_object_default_on_activities": "text"
      },
      "allow_on_forms": true
    }
  ],
  "pipeline": {
    "stages": [
      {
        "id": "123e4567-e89b-12d3-a456-426614174000",
        "name": "text",
        "status": "open",
        "percentage_chance_to_close": 1,
        "order": 1
      }
    ],
    "track_entity_value": true,
    "include_percentage_to_close": true,
    "use_ai_to_update_percentage": true
  },
  "browser_js_actions": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "api_name": "text",
      "name": "text",
      "script": "text",
      "plugin_app": {
        "id": "123e4567-e89b-12d3-a456-426614174000",
        "api_name": "text",
        "base_config": {
          "ANY_ADDITIONAL_PROPERTY": "anything"
        }
      }
    }
  ],
  "browser_route_scripts": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "api_name": "text",
      "name": "text",
      "routes": {
        "ANY_ADDITIONAL_PROPERTY": "anything"
      },
      "script": "text",
      "blocking": true,
      "custom_object": {
        "id": "123e4567-e89b-12d3-a456-426614174000",
        "name": "text",
        "object_name": "text"
      },
      "plugin_app": {
        "id": "123e4567-e89b-12d3-a456-426614174000",
        "api_name": "text",
        "base_config": {
          "ANY_ADDITIONAL_PROPERTY": "anything"
        }
      }
    }
  ],
  "custom_actions": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "name": "text",
      "description": "text",
      "action": "text",
      "automation": {
        "id": "123e4567-e89b-12d3-a456-426614174000",
        "api_name": "text",
        "name": "text"
      },
      "order": 1
    }
  ]
}

List field options

get

Lists field options for single or multi-select fields, such as dynamic tags, checkboxes, dropdown, radio, etc

Authorizations

businessId & userId & apiKey

X-BUSINESS-IDstringRequired

X-USER-IDstringRequired

X-API-KEYstringRequired

Path parameters

field_pkstring · uuidRequired

object_pkstring · uuidRequired

Query parameters

include_entity_countbooleanOptional

Includes entity_count in response and makes the response paginated.

orderingstring · enumOptional

Which field to use when ordering the results. Prepend with '-' for descending order.

Possible values:

pageintegerOptional

A page number within the paginated result set.

page_sizeintegerOptional

Number of results to return per page.

searchstringOptional

A search term.

Responses

200Success

application/json

get

/api/custom-objects/{object_pk}/fields/{field_pk}/options

HTTPcURLJavaScriptPython

GET /api/custom-objects/{object_pk}/fields/{field_pk}/options HTTP/1.1
Host: 
X-BUSINESS-ID: YOUR_API_KEY
X-USER-ID: YOUR_API_KEY
X-API-KEY: YOUR_API_KEY
Accept: */*

200Success

{
  "count": 123,
  "next": "http://api.example.org/accounts/?page=4",
  "previous": "http://api.example.org/accounts/?page=2",
  "results": [
    {
      "id": "06fe6c54-ea50-469e-b7fd-898a6b1b51b2",
      "code": "",
      "name": "Option 1",
      "order": 1,
      "meta": {}
    }
  ],
  "errors": [
    "error message"
  ]
}

post

Search fields

Authorizations

businessId & userId & apiKey

X-BUSINESS-IDstringRequired

X-USER-IDstringRequired

X-API-KEYstringRequired

Path parameters

object_pkstringRequired

Query parameters

categorystring · uuidOptional

field_typestring · enumOptional

• checkbox - Checkbox
• checkboxes - Checkboxes
• choices - Choices
• date - Date
• datetime - Datetime
• decimal - Decimal Number
• dropdown - Dropdown
• dynamictags - Dynamic Tags
• email - Email
• files - Files
• integer - Whole Number
• longtext - Long Text
• money - Money
• phonenumber - Phone Number
• radio - Radio
• rating - Rating
• relationship - Relationship
• selector - Selector
• status - Status
• team_selector - Team Selector
• text - Text
• timezone - Timezone
• wysiwyg - Wysiwyg
• yesnomaybe - Yes / No / Maybe Question

Possible values:

field_type__instring[]Optional

Multiple values may be separated by commas.

is_defaultbooleanOptional

numericbooleanOptional

orderingstring · enumOptional

Which field to use when ordering the results. Prepend with '-' for descending order.

Possible values:

searchstringOptional

A search term.

Body

application/json

idstring · uuidRequired

namestring · min: 1Required

categorystring · uuidRequired

display_namestring · min: 1Required

canonical_display_namestring · min: 1Required

is_defaultbooleanRequired

field_typestring · enumRequired

• checkbox - Checkbox
• checkboxes - Checkboxes
• choices - Choices
• date - Date
• datetime - Datetime
• decimal - Decimal Number
• dropdown - Dropdown
• dynamictags - Dynamic Tags
• email - Email
• files - Files
• integer - Whole Number
• longtext - Long Text
• money - Money
• phonenumber - Phone Number
• radio - Radio
• rating - Rating
• relationship - Relationship
• selector - Selector
• status - Status
• team_selector - Team Selector
• text - Text
• timezone - Timezone
• wysiwyg - Wysiwyg
• yesnomaybe - Yes / No / Maybe Question

Possible values:

is_requiredbooleanRequired

is_read_onlybooleanRequired

is_hiddenbooleanRequired

is_deletablebooleanRequired

is_hideablebooleanRequired

is_suppressedbooleanRequired

include_in_short_formstring · min: 1Required

allows_nullsbooleanRequired

allows_emptybooleanRequired

orderintegerRequired

descriptionstring · min: 1Required

description_visibilitystring · enumRequired

• all - All Labels
• create_only - Only on Create
• settings_only - Only in Settings

Possible values:

allow_on_formsbooleanRequired

Responses

200Success

application/json

post

/api/custom-objects/{object_pk}/fields/search

HTTPcURLJavaScriptPython

POST /api/custom-objects/{object_pk}/fields/search HTTP/1.1
Host: 
X-BUSINESS-ID: YOUR_API_KEY
X-USER-ID: YOUR_API_KEY
X-API-KEY: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 1188

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "name": "text",
  "category": "123e4567-e89b-12d3-a456-426614174000",
  "display_name": "text",
  "canonical_display_name": "text",
  "is_default": true,
  "field_type": "checkbox",
  "is_required": true,
  "is_read_only": true,
  "is_hidden": true,
  "is_deletable": true,
  "is_hideable": true,
  "is_suppressed": true,
  "include_in_short_form": "text",
  "allows_nulls": true,
  "allows_empty": true,
  "order": 1,
  "meta": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "description": "text",
  "description_visibility": "all",
  "properties": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "access": {
    "view": true,
    "edit": true,
    "remove": true
  },
  "options": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "code": "text",
      "name": "text",
      "order": 1,
      "meta": {
        "ANY_ADDITIONAL_PROPERTY": "anything"
      },
      "percentage_chance_to_close": 1,
      "chance_to_close_percentage": 1,
      "status": "open"
    }
  ],
  "relation": {
    "related_object": "123e4567-e89b-12d3-a456-426614174000",
    "related_category": "123e4567-e89b-12d3-a456-426614174000",
    "related_name": "text",
    "relation_type": "one_to_one",
    "rollup_timeline": true,
    "rollup_leadsources": true,
    "inverse_relation_rollup_timeline": true,
    "inverse_relation_rollup_leadsources": true,
    "inverse_relation_suppressed": true
  },
  "allow_on_forms": true
}

200Success

[
  {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "name": "text",
    "category": "123e4567-e89b-12d3-a456-426614174000",
    "display_name": "text",
    "canonical_display_name": "text",
    "is_default": true,
    "field_type": "checkbox",
    "is_required": true,
    "is_read_only": true,
    "is_hidden": true,
    "is_deletable": true,
    "is_hideable": true,
    "is_suppressed": true,
    "include_in_short_form": "text",
    "allows_nulls": true,
    "allows_empty": true,
    "order": 1,
    "meta": {
      "ANY_ADDITIONAL_PROPERTY": "anything"
    },
    "description": "text",
    "description_visibility": "all",
    "properties": {
      "ANY_ADDITIONAL_PROPERTY": "anything"
    },
    "access": {
      "view": true,
      "edit": true,
      "remove": true
    },
    "options": [
      {
        "id": "123e4567-e89b-12d3-a456-426614174000",
        "code": "text",
        "name": "text",
        "order": 1,
        "meta": {
          "ANY_ADDITIONAL_PROPERTY": "anything"
        },
        "percentage_chance_to_close": 1,
        "chance_to_close_percentage": 1,
        "status": "open"
      }
    ],
    "relation": {
      "related_field": "123e4567-e89b-12d3-a456-426614174000",
      "related_object": "123e4567-e89b-12d3-a456-426614174000",
      "related_category": "123e4567-e89b-12d3-a456-426614174000",
      "related_name": "text",
      "related_object_name": "text",
      "related_object_object_name": "text",
      "related_entity_name": "text",
      "relation_type": "one_to_one",
      "cardinality": "one_to_one",
      "fetch_url": "text",
      "rollup_timeline": true,
      "rollup_leadsources": true,
      "inverse_relation_rollup_timeline": true,
      "inverse_relation_rollup_leadsources": true,
      "inverse_relation_suppressed": true,
      "related_object_default_on_activities": "text"
    },
    "allow_on_forms": true
  }
]

get

Get Custom object by ID

Authorizations

businessId & userId & apiKey

X-BUSINESS-IDstringRequired

X-USER-IDstringRequired

X-API-KEYstringRequired

Path parameters

idstring · uuidRequired

A UUID string identifying this Custom Object.

Query parameters

orderingstring · enumOptional

Which field to use when ordering the results. Prepend with '-' for descending order.

Possible values:

Responses

200Success

application/json

get

/api/custom-objects/{id}

HTTPcURLJavaScriptPython

GET /api/custom-objects/{id} HTTP/1.1
Host: 
X-BUSINESS-ID: YOUR_API_KEY
X-USER-ID: YOUR_API_KEY
X-API-KEY: YOUR_API_KEY
Accept: */*

200Success

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "object_type": "pipeline",
  "entity_name": "text",
  "object_name": "text",
  "has_commerce_data": false,
  "default_on_activities": true,
  "owner": {
    "picture_url": "text",
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "first_name": "text",
    "last_name": "text",
    "email": "[email protected]",
    "display_name": "text"
  },
  "name": "text",
  "description": "text",
  "ai_description": "text",
  "is_custom": true,
  "fetch_url": "text",
  "allow_relations": true,
  "meta": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "related_objects": [
    {
      "related_object": "123e4567-e89b-12d3-a456-426614174000",
      "relation_type": "one_to_one",
      "rollup_timeline": false,
      "rollup_leadsources": true,
      "object_type": "text",
      "object_name": "text",
      "entity_name": "text",
      "field_id": "123e4567-e89b-12d3-a456-426614174000"
    }
  ],
  "number_of_records": 1,
  "created": "2026-01-17T07:09:40.741Z",
  "access": {
    "view": true,
    "edit": true,
    "remove": true
  },
  "entity_access": true,
  "rollup_related_leadsources": true,
  "quick_filtering_enabled": true,
  "record_layouts": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "name": "text",
      "config": {
        "ANY_ADDITIONAL_PROPERTY": "anything"
      },
      "tabs": {
        "ANY_ADDITIONAL_PROPERTY": "anything"
      },
      "order": 1
    }
  ],
  "association_source": "direct",
  "association_source_fields": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "name": "text",
      "related_field": "text",
      "related_object": "text"
    }
  ],
  "track_entity_value": true,
  "include_percentage_to_close": true,
  "use_ai_to_update_percentage": true,
  "ai_confidence_threshold": "text",
  "pipeline": {
    "stages": [
      {
        "id": "123e4567-e89b-12d3-a456-426614174000",
        "name": "text",
        "status": "open",
        "percentage_chance_to_close": 1,
        "order": 1
      }
    ],
    "track_entity_value": true,
    "include_percentage_to_close": true,
    "use_ai_to_update_percentage": true
  },
  "total_pipeline_value": 1,
  "total_commerce_value": 1,
  "reasons_lost": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "name": "text"
    }
  ],
  "reasons_disqualified": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "name": "text"
    }
  ],
  "undeletable_fields": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "allow_on_forms": true,
  "entity_display_name_pattern_text": "text",
  "entity_display_name_pattern_html": "text",
  "entity_search_text_pattern": "text",
  "default_color": "#085BEE",
  "default_icon": "bars-light",
  "browser_js_actions": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "api_name": "text",
      "name": "text",
      "script": "text",
      "plugin_app": {
        "id": "123e4567-e89b-12d3-a456-426614174000",
        "api_name": "text",
        "base_config": {
          "ANY_ADDITIONAL_PROPERTY": "anything"
        }
      }
    }
  ],
  "browser_route_scripts": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "api_name": "text",
      "name": "text",
      "routes": {
        "ANY_ADDITIONAL_PROPERTY": "anything"
      },
      "script": "text",
      "blocking": true,
      "custom_object": {
        "id": "123e4567-e89b-12d3-a456-426614174000",
        "name": "text",
        "object_name": "text"
      },
      "plugin_app": {
        "id": "123e4567-e89b-12d3-a456-426614174000",
        "api_name": "text",
        "base_config": {
          "ANY_ADDITIONAL_PROPERTY": "anything"
        }
      }
    }
  ],
  "custom_actions": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "name": "text",
      "description": "text",
      "action": "text",
      "automation": {
        "id": "123e4567-e89b-12d3-a456-426614174000",
        "api_name": "text",
        "name": "text"
      },
      "order": 1
    }
  ]
}

post

Search custom objects

Authorizations

businessId & userId & apiKey

X-BUSINESS-IDstringRequired

X-USER-IDstringRequired

X-API-KEYstringRequired

Query parameters

allow_relationsbooleanOptional

custom_onlybooleanOptional

Filter Custom Objects for the Client object (is_custom field)

Default: true

default_on_activitiesbooleanOptional

is_custombooleanOptional

namestringOptional

object_namestringOptional

object_typestring · enumOptional

• pipeline - pipeline
• standard - standard

Possible values:

orderingstring · enumOptional

Which field to use when ordering the results. Prepend with '-' for descending order.

Possible values:

pageintegerOptional

A page number within the paginated result set.

page_sizeintegerOptional

Number of results to return per page.

searchstringOptional

A search term.

Body

application/json

object_idsstring · uuid[]Optional

Responses

200Success

application/json

post

/api/custom-objects/search

HTTPcURLJavaScriptPython

POST /api/custom-objects/search HTTP/1.1
Host: 
X-BUSINESS-ID: YOUR_API_KEY
X-USER-ID: YOUR_API_KEY
X-API-KEY: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 55

{
  "object_ids": [
    "123e4567-e89b-12d3-a456-426614174000"
  ]
}

200Success

{
  "count": 123,
  "next": "http://api.example.org/accounts/?page=4",
  "previous": "http://api.example.org/accounts/?page=2",
  "results": [
    {
      "fetch_url": "text",
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "name": "text",
      "object_type": "pipeline",
      "object_name": "text",
      "entity_name": "text",
      "rollup_related_leadsources": true,
      "association_source": "direct",
      "has_commerce_data": true,
      "default_on_activities": true,
      "owner": {
        "id": "123e4567-e89b-12d3-a456-426614174000",
        "first_name": "text",
        "last_name": "text",
        "email": "[email protected]",
        "full_name": "text",
        "picture": {
          "id": "text",
          "created": "2026-01-17T07:09:40.741Z",
          "key": "text",
          "name": "text",
          "url": "text",
          "thumbnail_url": "text",
          "size_bytes": "text",
          "content_type": "text",
          "size_formatted": "text",
          "is_public": true
        }
      },
      "description": "text",
      "is_custom": true,
      "allow_relations": true,
      "created": "2026-01-17T07:09:40.741Z",
      "access": {
        "view": true,
        "edit": true,
        "remove": true
      },
      "track_entity_value": true,
      "include_percentage_to_close": true,
      "use_ai_to_update_percentage": true,
      "ai_confidence_threshold": "text",
      "allow_on_forms": true,
      "default_color": "text",
      "default_icon": "text"
    }
  ],
  "errors": [
    "error message"
  ]
}