{ "info": { "_postman_id": "8a1d4c93-1728-4d23-badd-187cb557528b", "name": "Zendesk Custom Objects", "description": "Needs a description.", "schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json", "createdAt": "2026-06-05T15:22:35.000Z", "updatedAt": "2026-06-05T15:22:35.000Z", "lastUpdatedBy": "35240", "uid": "35240-8a1d4c93-1728-4d23-badd-187cb557528b" }, "item": [ { "name": "api", "item": [ { "name": "v2", "item": [ { "name": "custom_objects", "item": [ { "name": "{custom_object_key}", "item": [ { "name": "fields", "item": [ { "name": "{custom_object_field_key_or_id}", "item": [ { "name": "Zendesk Get Api V2 Custom_objects Custom_object_key Fields Custom_object_field_key_or_id", "id": "a8e864e5-e4f6-4293-bee2-aa2ee27b4c30", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v2/custom_objects/:custom_object_key/fields/:custom_object_field_key_or_id", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "custom_objects", ":custom_object_key", "fields", ":custom_object_field_key_or_id" ], "variable": [ { "id": "3e191393-e742-4996-9a2e-9ed93af87924", "key": "custom_object_key" }, { "id": "bfbe4ca0-dfa1-41ce-9e69-777c2d1140a5", "key": "custom_object_field_key_or_id" } ] }, "description": "Returns a custom field for a specific object using a provided key or id of the field.\n#### Allowed For\n* Agents\n" }, "response": [ { "id": "069e82d0-5465-44b5-833c-94b360003fbd", "name": "Custom Object Field", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v2/custom_objects/:custom_object_key/fields/:custom_object_field_key_or_id", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "custom_objects", ":custom_object_key", "fields", ":custom_object_field_key_or_id" ], "variable": [ { "key": "custom_object_key" }, { "key": "custom_object_field_key_or_id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"custom_object_field\": {\n \"value\": \"reference #/components/schemas/CustomObjectField not found in the OpenAPI spec\"\n }\n}", "createdAt": "2026-06-05T15:22:36.000Z", "updatedAt": "2026-06-05T15:22:36.000Z", "uid": "35240-069e82d0-5465-44b5-833c-94b360003fbd" } ], "createdAt": "2026-06-05T15:22:36.000Z", "updatedAt": "2026-06-05T15:22:36.000Z", "uid": "35240-a8e864e5-e4f6-4293-bee2-aa2ee27b4c30" }, { "name": "Zendesk Patch Api V2 Custom_objects Custom_object_key Fields Custom_object_field_key_or_id", "id": "cf8b08ad-61c5-4d1c-8331-65b8d12b8dbd", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "PATCH", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v2/custom_objects/:custom_object_key/fields/:custom_object_field_key_or_id", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "custom_objects", ":custom_object_key", "fields", ":custom_object_field_key_or_id" ], "variable": [ { "id": "9ceda12a-a7d9-4fde-a8da-c732392a2512", "key": "custom_object_key" }, { "id": "19fa8a2e-e11f-4193-a3f3-db2b257bfdf8", "key": "custom_object_field_key_or_id" } ] }, "description": "Updates individual custom object fields. The updating rules are as follows:\n* Takes a `custom_object_field` object that specifies the properties to update\n* The `key` property cannot be updated\n* If updating a standard field, only the `title`, `description`, and `properties` attributes can be updated.\n* The `properties` parameter is comprised of four parts and can't be changed if any records exist for the object.\n * `autoincrement_enabled`: A Boolean that enables and disables autonumbering. Must be false if is_unique is true.\n * `autoincrement_prefix`: A string value that is used as a prefix to the autogenerated numbers. It can't exceed 30 characters.\n * `autoincrement_padding`: An integer specifying the starting number of digits in the autogenerated numbers. This value may be between 0-9. However, if you create records in excess of of these digits, additional digits are added as necessary.\n * `autoincrement_next_sequence`: An integer that will be used as the next number in the autonumbering sequence. It can't be negative or less than the current autonumbering value.\n * `is_unique`: A Boolean that enforces uniqueness for manually entered record names. When true, custom object record names must be unique. Must be false if autoincrement_enabled is true.\n#### Allowed For\n* Admins" }, "response": [ { "id": "378a9bba-4053-468e-bd94-d9e7e4a38498", "name": "Success response", "originalRequest": { "method": "PATCH", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v2/custom_objects/:custom_object_key/fields/:custom_object_field_key_or_id", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "custom_objects", ":custom_object_key", "fields", ":custom_object_field_key_or_id" ], "variable": [ { "key": "custom_object_key" }, { "key": "custom_object_field_key_or_id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"custom_object_field\": {\n \"value\": \"reference #/components/schemas/CustomObjectField not found in the OpenAPI spec\"\n }\n}", "createdAt": "2026-06-05T15:22:36.000Z", "updatedAt": "2026-06-05T15:22:36.000Z", "uid": "35240-378a9bba-4053-468e-bd94-d9e7e4a38498" } ], "createdAt": "2026-06-05T15:22:36.000Z", "updatedAt": "2026-06-05T15:22:36.000Z", "uid": "35240-cf8b08ad-61c5-4d1c-8331-65b8d12b8dbd" }, { "name": "Zendesk Delete Api V2 Custom_objects Custom_object_key Fields Custom_object_field_key_or_id", "id": "168ad26f-484e-41df-8484-4b199e1fc30d", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "DELETE", "header": [], "url": { "raw": "{{baseUrl}}/api/v2/custom_objects/:custom_object_key/fields/:custom_object_field_key_or_id", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "custom_objects", ":custom_object_key", "fields", ":custom_object_field_key_or_id" ], "variable": [ { "id": "7f5279e4-64e6-4452-a3aa-4e3e6cb6bdaf", "key": "custom_object_key" }, { "id": "46b26cc6-3de6-4c79-9b9a-e1021fbc6cce", "key": "custom_object_field_key_or_id" } ] }, "description": "Deletes a field with the specified key. Note: You can't delete standard fields.\n#### Allowed For\n* Admins" }, "response": [ { "id": "5e282ebe-e2b6-4b31-b043-6d86acb33eae", "name": "No content response", "originalRequest": { "method": "DELETE", "header": [], "url": { "raw": "{{baseUrl}}/api/v2/custom_objects/:custom_object_key/fields/:custom_object_field_key_or_id", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "custom_objects", ":custom_object_key", "fields", ":custom_object_field_key_or_id" ], "variable": [ { "key": "custom_object_key" }, { "key": "custom_object_field_key_or_id" } ] } }, "status": "No Content", "code": 204, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:22:36.000Z", "updatedAt": "2026-06-05T15:22:36.000Z", "uid": "35240-5e282ebe-e2b6-4b31-b043-6d86acb33eae" } ], "createdAt": "2026-06-05T15:22:36.000Z", "updatedAt": "2026-06-05T15:22:36.000Z", "uid": "35240-168ad26f-484e-41df-8484-4b199e1fc30d" } ], "id": "742daf7c-27d5-423a-bdea-5550ce73c13d", "createdAt": "2026-06-05T15:22:36.000Z", "updatedAt": "2026-06-05T15:22:36.000Z", "uid": "35240-742daf7c-27d5-423a-bdea-5550ce73c13d" }, { "name": "reorder", "item": [ { "name": "Zendesk Put Api V2 Custom_objects Custom_object_key Fields Reorder", "id": "448b7061-7d0b-4030-9b24-9a821c110ba2", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v2/custom_objects/:custom_object_key/fields/reorder", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "custom_objects", ":custom_object_key", "fields", "reorder" ], "variable": [ { "id": "932586b4-4f51-47f7-9c1b-90f8e9293f4a", "key": "custom_object_key" } ] }, "description": "Sets a preferred order of custom fields for a specific object by providing field ids in the desired order.\n#### Allowed For\n\n* Admins\n" }, "response": [ { "id": "1ba0e06e-4295-4ea8-9be8-0ab4055f4b8e", "name": "Reordered", "originalRequest": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v2/custom_objects/:custom_object_key/fields/reorder", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "custom_objects", ":custom_object_key", "fields", "reorder" ], "variable": [ { "key": "custom_object_key" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "", "createdAt": "2026-06-05T15:22:36.000Z", "updatedAt": "2026-06-05T15:22:36.000Z", "uid": "35240-1ba0e06e-4295-4ea8-9be8-0ab4055f4b8e" } ], "createdAt": "2026-06-05T15:22:36.000Z", "updatedAt": "2026-06-05T15:22:36.000Z", "uid": "35240-448b7061-7d0b-4030-9b24-9a821c110ba2" } ], "id": "9cad9c1d-03a5-4567-bda3-43545ae0fc32", "createdAt": "2026-06-05T15:22:36.000Z", "updatedAt": "2026-06-05T15:22:36.000Z", "uid": "35240-9cad9c1d-03a5-4567-bda3-43545ae0fc32" }, { "name": "Zendesk Get Api V2 Custom_objects Custom_object_key Fields", "id": "52ec1b10-684f-4723-be36-5e9703ed0212", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v2/custom_objects/:custom_object_key/fields", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "custom_objects", ":custom_object_key", "fields" ], "variable": [ { "id": "00d94a6d-6e45-4ae8-ac33-5be899b63e9b", "key": "custom_object_key" } ] }, "description": "Lists all undeleted custom fields for the specified object.\n\n#### Allowed For\n* Agents\n\n#### Pagination\n* Cursor pagination (recommended)\n* Offset pagination\n\nSee [Pagination](/api-reference/introduction/pagination/)." }, "response": [ { "id": "53a46aef-939d-4d49-82ce-34e1f977e765", "name": "Success response", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v2/custom_objects/:custom_object_key/fields", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "custom_objects", ":custom_object_key", "fields" ], "variable": [ { "key": "custom_object_key" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"custom_object_fields\": [\n {\n \"value\": \"reference #/components/schemas/CustomObjectField not found in the OpenAPI spec\"\n },\n {\n \"value\": \"reference #/components/schemas/CustomObjectField not found in the OpenAPI spec\"\n }\n ]\n}", "createdAt": "2026-06-05T15:22:36.000Z", "updatedAt": "2026-06-05T15:22:36.000Z", "uid": "35240-53a46aef-939d-4d49-82ce-34e1f977e765" } ], "createdAt": "2026-06-05T15:22:36.000Z", "updatedAt": "2026-06-05T15:22:36.000Z", "uid": "35240-52ec1b10-684f-4723-be36-5e9703ed0212" }, { "name": "Zendesk Post Api V2 Custom_objects Custom_object_key Fields", "id": "62ee1bd4-7ba5-4df2-ab12-eb88a8ac772c", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"value\": \"reference #/components/schemas/CustomObjectFieldsCreateRequest not found in the OpenAPI spec\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/custom_objects/:custom_object_key/fields", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "custom_objects", ":custom_object_key", "fields" ], "variable": [ { "id": "3210e2fe-ee68-4858-9833-b6e5f1949f33", "key": "custom_object_key" } ] }, "description": "Creates any of the following custom field types:\n\n* text (default when no \"type\" is specified)\n* textarea\n* checkbox\n* date\n* integer\n* decimal\n* regexp\n* dropdown\n* lookup\n* multiselect\n\nSee [About custom field types](https://support.zendesk.com/hc/en-us/articles/203661866) in Zendesk help.\n\n#### Allowed For\n\n* Admins\n" }, "response": [ { "id": "e55b7ff0-7126-4374-907a-1384a6950681", "name": "Created", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"value\": \"reference #/components/schemas/CustomObjectFieldsCreateRequest not found in the OpenAPI spec\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/custom_objects/:custom_object_key/fields", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "custom_objects", ":custom_object_key", "fields" ], "variable": [ { "key": "custom_object_key" } ] } }, "status": "Created", "code": 201, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"custom_object_field\": {\n \"value\": \"reference #/components/schemas/CustomObjectField not found in the OpenAPI spec\"\n }\n}", "createdAt": "2026-06-05T15:22:36.000Z", "updatedAt": "2026-06-05T15:22:36.000Z", "uid": "35240-e55b7ff0-7126-4374-907a-1384a6950681" } ], "createdAt": "2026-06-05T15:22:36.000Z", "updatedAt": "2026-06-05T15:22:36.000Z", "uid": "35240-62ee1bd4-7ba5-4df2-ab12-eb88a8ac772c" } ], "id": "7ab9b69e-e20d-4b4c-ac94-35e0d5c8e9ca", "createdAt": "2026-06-05T15:22:36.000Z", "updatedAt": "2026-06-05T15:22:36.000Z", "uid": "35240-7ab9b69e-e20d-4b4c-ac94-35e0d5c8e9ca" }, { "name": "jobs", "item": [ { "name": "Zendesk Post Api V2 Custom_objects Custom_object_key Jobs", "id": "09797155-dbfe-4ad8-af31-13fb1a8f7afd", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"value\": \"reference #/components/schemas/CustomObjectRecordsBulkCreateRequest not found in the OpenAPI spec\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/custom_objects/:custom_object_key/jobs", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "custom_objects", ":custom_object_key", "jobs" ], "variable": [ { "id": "d0e6d997-fdc0-47c5-8296-eb1081f9399b", "key": "custom_object_key" } ] }, "description": "Queues a background job to perform bulk actions on up to 100 custom object records per single request.\nTakes a `job` object with two nested fields:\n* `action`, one of:\n * `\"create\"`\n * `\"delete\"`\n * `\"delete_by_external_id\"`\n * `\"create_or_update_by_external_id\"`\n * `\"create_or_update_by_name\"`\n * `\"update\"`\n* `items`\n * For a `\"create\"` action, an array of JSON objects representing the custom object records being created\n * For a `\"delete\"` action, an array of strings representing Zendesk record ids\n * For a `\"delete_by_external_id\"` action, an array of strings representing external ids\n * For a `\"create_or_update_by_external_id\"` action, an array of JSON objects representing the custom object records being created or updated by external id\n * For a `\"create_or_update_by_name\"` action, an array of JSON objects representing the custom object records being created or updated by name. The `is_unique` property on the custom object's name field must be enabled.\n * For an `\"update\"` action, an array of JSON objects representing the custom object records being updated\n\nNote: If autonumbering is selected for the custom object's name field, record names aren't allowed in the request body because they are generated automatically. If uniqueness is enabled, the record names must be unique.\n\n#### Allowed For\n* Agents\n\n#### Response ###\nThis endpoint returns a `job_status` [JSON object](/api-reference/ticketing/ticket-management/job_statuses/#json-format) and queues a background job to do the work. Use the [Show Job Status](/api-reference/ticketing/ticket-management/job_statuses/#show-job-status) endpoint to check for the job's completion. Only a certain number of jobs can be queued or running at the same time. See [Job limit](/api-reference/introduction/rate-limits/#job-limit) for more information.\n" }, "response": [ { "id": "35ba0ada-a866-4cfc-8bb5-a0d743f19304", "name": "Created", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"value\": \"reference #/components/schemas/CustomObjectRecordsBulkCreateRequest not found in the OpenAPI spec\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/custom_objects/:custom_object_key/jobs", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "custom_objects", ":custom_object_key", "jobs" ], "variable": [ { "key": "custom_object_key" } ] } }, "status": "Created", "code": 201, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"value\": \"reference #/components/schemas/CustomObjectRecordsJobsResponse not found in the OpenAPI spec\"\n}", "createdAt": "2026-06-05T15:22:36.000Z", "updatedAt": "2026-06-05T15:22:36.000Z", "uid": "35240-35ba0ada-a866-4cfc-8bb5-a0d743f19304" } ], "createdAt": "2026-06-05T15:22:36.000Z", "updatedAt": "2026-06-05T15:22:36.000Z", "uid": "35240-09797155-dbfe-4ad8-af31-13fb1a8f7afd" } ], "id": "dc1c9463-996c-4331-82ca-470e57228ed6", "createdAt": "2026-06-05T15:22:36.000Z", "updatedAt": "2026-06-05T15:22:36.000Z", "uid": "35240-dc1c9463-996c-4331-82ca-470e57228ed6" }, { "name": "limits", "item": [ { "name": "field_limit", "item": [ { "name": "Zendesk Get Api V2 Custom_objects Custom_object_key Limits Field_limit", "id": "475fbad0-49cf-40fb-a5ef-6685f9dfa417", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v2/custom_objects/:custom_object_key/limits/field_limit", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "custom_objects", ":custom_object_key", "limits", "field_limit" ], "variable": [ { "id": "de46fea4-40f9-4285-968c-470b87c0a8cb", "key": "custom_object_key" } ] }, "description": "List the current count and the limit for a custom object's fields\n#### Allowed For\n* Agents" }, "response": [ { "id": "c3b14a66-36c3-431c-8e19-f72c652cdab3", "name": "Success response", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v2/custom_objects/:custom_object_key/limits/field_limit", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "custom_objects", ":custom_object_key", "limits", "field_limit" ], "variable": [ { "key": "custom_object_key" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"count\": \"\",\n \"limit\": \"\"\n}", "createdAt": "2026-06-05T15:22:36.000Z", "updatedAt": "2026-06-05T15:22:36.000Z", "uid": "35240-c3b14a66-36c3-431c-8e19-f72c652cdab3" } ], "createdAt": "2026-06-05T15:22:36.000Z", "updatedAt": "2026-06-05T15:22:36.000Z", "uid": "35240-475fbad0-49cf-40fb-a5ef-6685f9dfa417" } ], "id": "0a240d84-4f5c-4e5a-98d9-15ec31ce61ac", "createdAt": "2026-06-05T15:22:36.000Z", "updatedAt": "2026-06-05T15:22:36.000Z", "uid": "35240-0a240d84-4f5c-4e5a-98d9-15ec31ce61ac" } ], "id": "fc94ae6a-c695-46f6-95d9-de318f724630", "createdAt": "2026-06-05T15:22:36.000Z", "updatedAt": "2026-06-05T15:22:36.000Z", "uid": "35240-fc94ae6a-c695-46f6-95d9-de318f724630" }, { "name": "records", "item": [ { "name": "{custom_object_record_id}", "item": [ { "name": "Zendesk Get Api V2 Custom_objects Custom_object_key Records Custom_object_record_id", "id": "af754c51-de81-4ccf-be28-4b2764a79ac3", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v2/custom_objects/:custom_object_key/records/:custom_object_record_id", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "custom_objects", ":custom_object_key", "records", ":custom_object_record_id" ], "variable": [ { "id": "cb404a60-44a4-41e7-b15f-5a9e87af841b", "key": "custom_object_key" }, { "id": "d21305ed-9cb1-4ae0-977b-5199920b72da", "key": "custom_object_record_id" } ] }, "description": "Returns a custom record for a specific object using a provided id.\n#### Allowed For\n* Agents\n" }, "response": [ { "id": "a218c9f1-9799-4696-a3f0-f402e705b2eb", "name": "Custom Object Record", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v2/custom_objects/:custom_object_key/records/:custom_object_record_id", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "custom_objects", ":custom_object_key", "records", ":custom_object_record_id" ], "variable": [ { "key": "custom_object_key" }, { "key": "custom_object_record_id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"custom_object_record\": {\n \"value\": \"reference #/components/schemas/CustomObjectRecord not found in the OpenAPI spec\"\n }\n}", "createdAt": "2026-06-05T15:22:36.000Z", "updatedAt": "2026-06-05T15:22:36.000Z", "uid": "35240-a218c9f1-9799-4696-a3f0-f402e705b2eb" } ], "createdAt": "2026-06-05T15:22:36.000Z", "updatedAt": "2026-06-05T15:22:36.000Z", "uid": "35240-af754c51-de81-4ccf-be28-4b2764a79ac3" }, { "name": "Zendesk Patch Api V2 Custom_objects Custom_object_key Records Custom_object_record_id", "id": "08081c5e-62c7-4191-a32a-832a407a6df8", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "PATCH", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v2/custom_objects/:custom_object_key/records/:custom_object_record_id", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "custom_objects", ":custom_object_key", "records", ":custom_object_record_id" ], "variable": [ { "id": "3dbc4c7c-73bc-4d14-8c63-6a5cf6425515", "key": "custom_object_key" }, { "id": "4ef0c292-7142-4b2a-87a0-e809136483ee", "key": "custom_object_record_id" } ] }, "description": "Updates an individual custom object record. The updating rules are as follows:\n* Takes a `custom_object_record` object that specifies the properties to update\n* The custom object fields should be nested inside a `custom_object_fields` object\n#### Allowed For\n* Agents" }, "response": [ { "id": "287377f6-c4d1-470d-b4a3-c2d0fadfd89b", "name": "Success response", "originalRequest": { "method": "PATCH", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v2/custom_objects/:custom_object_key/records/:custom_object_record_id", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "custom_objects", ":custom_object_key", "records", ":custom_object_record_id" ], "variable": [ { "key": "custom_object_key" }, { "key": "custom_object_record_id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"custom_object_record\": {\n \"value\": \"reference #/components/schemas/CustomObjectRecord not found in the OpenAPI spec\"\n }\n}", "createdAt": "2026-06-05T15:22:36.000Z", "updatedAt": "2026-06-05T15:22:36.000Z", "uid": "35240-287377f6-c4d1-470d-b4a3-c2d0fadfd89b" } ], "createdAt": "2026-06-05T15:22:36.000Z", "updatedAt": "2026-06-05T15:22:36.000Z", "uid": "35240-08081c5e-62c7-4191-a32a-832a407a6df8" }, { "name": "Zendesk Delete Api V2 Custom_objects Custom_object_key Records Custom_object_record_id", "id": "6fee3c68-237c-423c-ab95-ca64a8569f4e", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "DELETE", "header": [], "url": { "raw": "{{baseUrl}}/api/v2/custom_objects/:custom_object_key/records/:custom_object_record_id", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "custom_objects", ":custom_object_key", "records", ":custom_object_record_id" ], "variable": [ { "id": "46a1ae11-a5fd-4635-b69f-3b8301738b3e", "key": "custom_object_key" }, { "id": "c8abc15d-eddb-4f67-8cf5-9a71557a1b10", "key": "custom_object_record_id" } ] }, "description": "Deletes a record with the specified id\n#### Allowed For\n* Agents" }, "response": [ { "id": "d5db3935-0662-4697-aa01-4d013fed5da6", "name": "No content response", "originalRequest": { "method": "DELETE", "header": [], "url": { "raw": "{{baseUrl}}/api/v2/custom_objects/:custom_object_key/records/:custom_object_record_id", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "custom_objects", ":custom_object_key", "records", ":custom_object_record_id" ], "variable": [ { "key": "custom_object_key" }, { "key": "custom_object_record_id" } ] } }, "status": "No Content", "code": 204, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:22:36.000Z", "updatedAt": "2026-06-05T15:22:36.000Z", "uid": "35240-d5db3935-0662-4697-aa01-4d013fed5da6" } ], "createdAt": "2026-06-05T15:22:36.000Z", "updatedAt": "2026-06-05T15:22:36.000Z", "uid": "35240-6fee3c68-237c-423c-ab95-ca64a8569f4e" } ], "id": "9020e3b9-935e-438f-b298-fff94b6784e2", "createdAt": "2026-06-05T15:22:36.000Z", "updatedAt": "2026-06-05T15:22:36.000Z", "uid": "35240-9020e3b9-935e-438f-b298-fff94b6784e2" }, { "name": "autocomplete", "item": [ { "name": "Zendesk Get Api V2 Custom_objects Custom_object_key Records Autocomplete", "id": "24ecc303-47e8-4b4b-aa4c-e5c3ee10a700", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v2/custom_objects/:custom_object_key/records/autocomplete?name=&page[before]=&page[after]=&page[size]=&field_id=&source=&filter[dynamic_values][ipsum35]=&requester_id=&assignee_id=&organization_id=", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "custom_objects", ":custom_object_key", "records", "autocomplete" ], "query": [ { "description": "Part of a name of the record you are searching for", "key": "name", "value": "" }, { "description": "A [pagination cursor](/documentation/api-basics/pagination/paginating-through-lists-using-cursor-pagination) that tells the endpoint which page to start on. It should be a `meta.before_cursor` value from a previous request. Note: `page[before]` and `page[after]` can't be used together in the same request.\n", "key": "page[before]", "value": "" }, { "description": "A [pagination cursor](/documentation/api-basics/pagination/paginating-through-lists-using-cursor-pagination) that tells the endpoint which page to start on. It should be a `meta.after_cursor` value from a previous request. Note: `page[before]` and `page[after]` can't be used together in the same request.\n", "key": "page[after]", "value": "" }, { "description": "The number of records to return in the response. You can specify up to 100 records per page.\n", "key": "page[size]", "value": "" }, { "description": "The id of the lookup field. If the field has a relationship filter, the filter is applied to the results. Must be used with `source` param.\n", "key": "field_id", "value": "" }, { "description": "One of \"zen:user\", \"zen:ticket\", \"zen:organization\", or \"zen:custom_object:CUSTOM_OBJECT_KEY\". Represents the object `field_id` belongs to. Must be used with field_id param.\n", "key": "source", "value": "" }, { "description": "Provided values to be used with [dynamic filters](/api-reference/ticketing/lookup_relationships/lookup_relationships/#using-dynamic-filters).\n", "key": "filter[dynamic_values][ipsum35]", "value": "" }, { "description": "The id of the requester. For use with dynamic filters.\n", "key": "requester_id", "value": "" }, { "description": "The id of the selected assignee. For use with dynamic filters.\n", "key": "assignee_id", "value": "" }, { "description": "The id of the organization the requester belongs to. For use with dynamic filters.\n", "key": "organization_id", "value": "" } ], "variable": [ { "id": "82a0baa5-7ab4-4685-a821-3e84f3b32952", "key": "custom_object_key" } ] }, "description": "Retrieves an array of custom object records that have a field value that matches the value specified in the `name` parameter.\n\n#### Pagination\n\n* [Cursor pagination](/api-reference/introduction/pagination/#cursor-pagination) only.\n* Returns the first 10,000 records sorted by relevancy with page limits.\n#### Allowed For\n* Agents" }, "response": [ { "id": "0ee1ab6c-b3b7-466f-8cbf-b5ea97ed54b2", "name": "Success response", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v2/custom_objects/:custom_object_key/records/autocomplete?name=&page[before]=&page[after]=&page[size]=&field_id=&source=&filter[dynamic_values][ipsum35]=&requester_id=&assignee_id=&organization_id=", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "custom_objects", ":custom_object_key", "records", "autocomplete" ], "query": [ { "description": "Part of a name of the record you are searching for", "key": "name", "value": "" }, { "description": "A [pagination cursor](/documentation/api-basics/pagination/paginating-through-lists-using-cursor-pagination) that tells the endpoint which page to start on. It should be a `meta.before_cursor` value from a previous request. Note: `page[before]` and `page[after]` can't be used together in the same request.\n", "key": "page[before]", "value": "" }, { "description": "A [pagination cursor](/documentation/api-basics/pagination/paginating-through-lists-using-cursor-pagination) that tells the endpoint which page to start on. It should be a `meta.after_cursor` value from a previous request. Note: `page[before]` and `page[after]` can't be used together in the same request.\n", "key": "page[after]", "value": "" }, { "description": "The number of records to return in the response. You can specify up to 100 records per page.\n", "key": "page[size]", "value": "" }, { "description": "The id of the lookup field. If the field has a relationship filter, the filter is applied to the results. Must be used with `source` param.\n", "key": "field_id", "value": "" }, { "description": "One of \"zen:user\", \"zen:ticket\", \"zen:organization\", or \"zen:custom_object:CUSTOM_OBJECT_KEY\". Represents the object `field_id` belongs to. Must be used with field_id param.\n", "key": "source", "value": "" }, { "description": "Provided values to be used with [dynamic filters](/api-reference/ticketing/lookup_relationships/lookup_relationships/#using-dynamic-filters).\n", "key": "filter[dynamic_values][ipsum35]", "value": "" }, { "description": "The id of the requester. For use with dynamic filters.\n", "key": "requester_id", "value": "" }, { "description": "The id of the selected assignee. For use with dynamic filters.\n", "key": "assignee_id", "value": "" }, { "description": "The id of the organization the requester belongs to. For use with dynamic filters.\n", "key": "organization_id", "value": "" } ], "variable": [ { "key": "custom_object_key" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"count\": \"\",\n \"custom_object_records\": [\n {\n \"value\": \"reference #/components/schemas/CustomObjectRecord not found in the OpenAPI spec\"\n },\n {\n \"value\": \"reference #/components/schemas/CustomObjectRecord not found in the OpenAPI spec\"\n }\n ],\n \"links\": {\n \"prev\": \"\",\n \"next\": \"\"\n },\n \"meta\": {\n \"has_more\": \"\",\n \"after_cursor\": \"\",\n \"before_cursor\": \"\"\n }\n}", "createdAt": "2026-06-05T15:22:36.000Z", "updatedAt": "2026-06-05T15:22:36.000Z", "uid": "35240-0ee1ab6c-b3b7-466f-8cbf-b5ea97ed54b2" } ], "createdAt": "2026-06-05T15:22:36.000Z", "updatedAt": "2026-06-05T15:22:36.000Z", "uid": "35240-24ecc303-47e8-4b4b-aa4c-e5c3ee10a700" } ], "id": "4b4f5a14-d586-4ce4-b5a5-60a7b58c3390", "createdAt": "2026-06-05T15:22:36.000Z", "updatedAt": "2026-06-05T15:22:36.000Z", "uid": "35240-4b4f5a14-d586-4ce4-b5a5-60a7b58c3390" }, { "name": "count", "item": [ { "name": "Zendesk Get Api V2 Custom_objects Custom_object_key Records Count", "id": "5fc65538-0bcb-41bf-8092-c1cdb84de226", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v2/custom_objects/:custom_object_key/records/count", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "custom_objects", ":custom_object_key", "records", "count" ], "variable": [ { "id": "f84c9fc7-daa5-4d7e-8bc2-eebb00d962b4", "key": "custom_object_key" } ] }, "description": "Returns a total count of records for a specific custom object as well as the time the count was refreshed.\n#### Allowed For\n* Agents" }, "response": [ { "id": "b2705bcc-1602-42e4-a12f-5c514232c8d0", "name": "Success response", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v2/custom_objects/:custom_object_key/records/count", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "custom_objects", ":custom_object_key", "records", "count" ], "variable": [ { "key": "custom_object_key" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"count\": {\n \"cupidatat0\": {\n \"refreshed_at\": \"\",\n \"value\": \"\"\n },\n \"ea_d7_\": {\n \"refreshed_at\": \"\",\n \"value\": \"\"\n },\n \"auteb6\": {\n \"refreshed_at\": \"\",\n \"value\": \"\"\n }\n }\n}", "createdAt": "2026-06-05T15:22:36.000Z", "updatedAt": "2026-06-05T15:22:36.000Z", "uid": "35240-b2705bcc-1602-42e4-a12f-5c514232c8d0" } ], "createdAt": "2026-06-05T15:22:36.000Z", "updatedAt": "2026-06-05T15:22:36.000Z", "uid": "35240-5fc65538-0bcb-41bf-8092-c1cdb84de226" } ], "id": "92278cbd-509d-45b9-a414-49d2d361f479", "createdAt": "2026-06-05T15:22:36.000Z", "updatedAt": "2026-06-05T15:22:36.000Z", "uid": "35240-92278cbd-509d-45b9-a414-49d2d361f479" }, { "name": "search", "item": [ { "name": "Zendesk Get Api V2 Custom_objects Custom_object_key Records Search", "id": "c2f9e1df-fe9c-4fa7-8184-d02cb1f0e503", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v2/custom_objects/:custom_object_key/records/search?query=&sort=&page[before]=&page[after]=&page[size]=", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "custom_objects", ":custom_object_key", "records", "search" ], "query": [ { "description": "The query parameter is used to search text-based fields for records that match specific query terms.\nThe query can be multiple words or numbers. Every record that matches the beginning of any word or number in the query string is returned.

\n\nFuzzy search is supported for the following text-based field types: : Text fields, Multi Line Text fields, and RegExp fields.

\n\nFor example, you might want to search for records related to Tesla vehicles: `query=Tesla`. In this example the API would return every record for the given custom object where any of the supported text fields contain the word 'Tesla'.

\n\nYou can include multiple words or numbers in your search. For example: `query=Tesla Honda 2020`. This search phrase would be URL encoded as `query=Tesla%20Honda%202020` and return every record for the custom object for which any of the supported text fields contained 'Tesla', 'Honda', or '2020'.\n", "key": "query", "value": "" }, { "description": "One of `name`, `created_at`, `updated_at`, `-name`, `-created_at`, or `-updated_at`. The `-` denotes the sort will be descending. Defaults to sorting by relevance.\n", "key": "sort", "value": "" }, { "description": "A [pagination cursor](/documentation/api-basics/pagination/paginating-through-lists-using-cursor-pagination) that tells the endpoint which page to start on. It should be a `meta.before_cursor` value from a previous request. Note: `page[before]` and `page[after]` can't be used together in the same request.\n", "key": "page[before]", "value": "" }, { "description": "A [pagination cursor](/documentation/api-basics/pagination/paginating-through-lists-using-cursor-pagination) that tells the endpoint which page to start on. It should be a `meta.after_cursor` value from a previous request. Note: `page[before]` and `page[after]` can't be used together in the same request.\n", "key": "page[after]", "value": "" }, { "description": "Specifies how many records should be returned in the response. You can specify up to 100 records per page.\n", "key": "page[size]", "value": "" } ], "variable": [ { "id": "c2d585d9-dac6-4777-a83f-cfae12386416", "key": "custom_object_key" } ] }, "description": "Returns an array of custom object records that meet the search criteria\n\n#### Pagination\n\n* [Cursor pagination](/api-reference/introduction/pagination/#cursor-pagination) only.\n* Returns the records sorted by relevancy with page limits. Without a `sort` parameter, only the first 10,000 records are returned. With a `sort` parameter, all records are returned.\n#### Allowed For\n* Agents" }, "response": [ { "id": "80a37a99-330c-4f6f-a591-f928ffbfd92f", "name": "Success response", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v2/custom_objects/:custom_object_key/records/search?query=&sort=&page[before]=&page[after]=&page[size]=", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "custom_objects", ":custom_object_key", "records", "search" ], "query": [ { "description": "The query parameter is used to search text-based fields for records that match specific query terms.\nThe query can be multiple words or numbers. Every record that matches the beginning of any word or number in the query string is returned.

\n\nFuzzy search is supported for the following text-based field types: : Text fields, Multi Line Text fields, and RegExp fields.

\n\nFor example, you might want to search for records related to Tesla vehicles: `query=Tesla`. In this example the API would return every record for the given custom object where any of the supported text fields contain the word 'Tesla'.

\n\nYou can include multiple words or numbers in your search. For example: `query=Tesla Honda 2020`. This search phrase would be URL encoded as `query=Tesla%20Honda%202020` and return every record for the custom object for which any of the supported text fields contained 'Tesla', 'Honda', or '2020'.\n", "key": "query", "value": "" }, { "description": "One of `name`, `created_at`, `updated_at`, `-name`, `-created_at`, or `-updated_at`. The `-` denotes the sort will be descending. Defaults to sorting by relevance.\n", "key": "sort", "value": "" }, { "description": "A [pagination cursor](/documentation/api-basics/pagination/paginating-through-lists-using-cursor-pagination) that tells the endpoint which page to start on. It should be a `meta.before_cursor` value from a previous request. Note: `page[before]` and `page[after]` can't be used together in the same request.\n", "key": "page[before]", "value": "" }, { "description": "A [pagination cursor](/documentation/api-basics/pagination/paginating-through-lists-using-cursor-pagination) that tells the endpoint which page to start on. It should be a `meta.after_cursor` value from a previous request. Note: `page[before]` and `page[after]` can't be used together in the same request.\n", "key": "page[after]", "value": "" }, { "description": "Specifies how many records should be returned in the response. You can specify up to 100 records per page.\n", "key": "page[size]", "value": "" } ], "variable": [ { "key": "custom_object_key" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"count\": \"\",\n \"custom_object_records\": [\n {\n \"value\": \"reference #/components/schemas/CustomObjectRecord not found in the OpenAPI spec\"\n },\n {\n \"value\": \"reference #/components/schemas/CustomObjectRecord not found in the OpenAPI spec\"\n }\n ],\n \"links\": {\n \"prev\": \"\",\n \"next\": \"\"\n },\n \"meta\": {\n \"has_more\": \"\",\n \"after_cursor\": \"\",\n \"before_cursor\": \"\"\n }\n}", "createdAt": "2026-06-05T15:22:36.000Z", "updatedAt": "2026-06-05T15:22:36.000Z", "uid": "35240-80a37a99-330c-4f6f-a591-f928ffbfd92f" } ], "createdAt": "2026-06-05T15:22:36.000Z", "updatedAt": "2026-06-05T15:22:36.000Z", "uid": "35240-c2f9e1df-fe9c-4fa7-8184-d02cb1f0e503" }, { "name": "Zendesk Post Api V2 Custom_objects Custom_object_key Records Search", "id": "9bd5266d-82f2-459a-bd59-a575bc24eef0", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"value\": \"reference #/components/schemas/CustomObjectRecordsFilteredSearchRequestBasic not found in the OpenAPI spec\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/custom_objects/:custom_object_key/records/search?query=&sort=&page[before]=&page[after]=&page[size]=", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "custom_objects", ":custom_object_key", "records", "search" ], "query": [ { "description": "The query parameter is used to search text-based fields for records that match specific query terms.\nThe query can be multiple words or numbers. Every record that matches the beginning of any word or number in the query string is returned.

\n\nFuzzy search is supported for the following text-based field types: Text fields, Multi Line Text fields, and RegExp fields.

\n\nFor example, you might want to search for records related to Tesla vehicles: `query=Tesla`. In this example the API would return every record for the given custom object where any of the supported text fields contain the word 'Tesla'.

\n\nYou can include multiple words or numbers in your search. For example: `query=Tesla Honda 2020`. This search phrase would be URL encoded as `query=Tesla%20Honda%202020` and return every record for the custom object for which any of the supported text fields contained 'Tesla', 'Honda', or '2020'.\n", "key": "query", "value": "" }, { "description": "One of `name`, `created_at`, `updated_at`, `-name`, `-created_at`, or `-updated_at`. The `-` denotes the sort will be descending. Defaults to sorting by relevance.\n", "key": "sort", "value": "" }, { "description": "A [pagination cursor](/documentation/api-basics/pagination/paginating-through-lists-using-cursor-pagination) that tells the endpoint which page to start on. It should be a `meta.before_cursor` value from a previous request. Note: `page[before]` and `page[after]` can't be used together in the same request.\n", "key": "page[before]", "value": "" }, { "description": "A [pagination cursor](/documentation/api-basics/pagination/paginating-through-lists-using-cursor-pagination) that tells the endpoint which page to start on. It should be a `meta.after_cursor` value from a previous request. Note: `page[before]` and `page[after]` can't be used together in the same request.\n", "key": "page[after]", "value": "" }, { "description": "Specifies how many records should be returned in the response. You can specify up to 100 records per page.\n", "key": "page[size]", "value": "" } ], "variable": [ { "id": "46a4fabe-ee82-44d8-af5f-a4c619c80b63", "key": "custom_object_key" } ] }, "description": "Returns an array of custom object records that meet the search and filter criteria.\n\nFilters can contain either an individual [comparison object](#comparison-object) or an array of [comparison objects](#comparison-object) within logical namespaces.\n\nA filter is a JSON object that has the following properties:\n\n| Name | Type | Required | Description\n| --------- | ------ | -------- | -----------\n| ATTRIBUTE | object | no | A [comparison object](#comparison-object) specifying an attribute value condition to be met for records to match.

Examples are marked below.\n| $and | array | no | Array of conjunctive filter objects (logical AND)\n| $or | array | no | Array of conjunctive filter objects (logical OR)\n\n##### Examples\n\n\n```js\n{\n \"filter\": {\n \"custom_object_fields.field_key\": { \"$eq\": \"value\" } // ATTRIBUTE\n }\n}\n```\n\n```js\n// $or\n{\n \"filter\": {\n \"$or\": [\n { \"custom_object_fields.field_key\": { \"$eq\": \"value\" } }, // ATTRIBUTE\n { \"external_id\": { \"$eq\": \"Record123\" } } // ATTRIBUTE\n ]\n }\n}\n```\n\n#### Comparison Object\n\nA comparison object defines a condition a record must meet to be considered a match. The condition is based on an attribute value or object type.\n\nA comparison object is a JSON object that has the following properties:\n\n| Name | Type | Required | Description\n| --------- | ------------- | -------- | -----------\n| FIELD_KEY | string | yes | When filtering on a custom field, they must be namedspaced with `custom_object_fields.`. ex. `custom_object_fields.field_key`

When filtering on a standard field, no namespace is required. The following fields are considered standard: `created_at`, `updated_at`, `created_by_user`, `updated_by_user`, `name`, `external_id`\n| OPERATOR | string | yes | [Supported operators](/documentation/custom-data/v2/searching-custom-object-records/) vary by the value's data type\n| VALUE | string, array | yes | The value you're filtering for\n\n#### Pagination\n\n* [Cursor pagination](/api-reference/introduction/pagination/#cursor-pagination) only.\n* Returns the records sorted by relevancy with page limits. Without a `sort` parameter, only the first 10,000 records are returned. With a `sort` parameter, all records are returned.\n\n#### Allowed For\n\n* Agents\n* End users (when an admin [configures](https://support.zendesk.com/hc/en-us/articles/6034260247066) the custom object to be accessible to end users)" }, "response": [ { "id": "e94b83f7-702d-4f2f-b227-3940af26e7bc", "name": "Success response", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"value\": \"reference #/components/schemas/CustomObjectRecordsFilteredSearchRequestBasic not found in the OpenAPI spec\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/custom_objects/:custom_object_key/records/search?query=&sort=&page[before]=&page[after]=&page[size]=", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "custom_objects", ":custom_object_key", "records", "search" ], "query": [ { "description": "The query parameter is used to search text-based fields for records that match specific query terms.\nThe query can be multiple words or numbers. Every record that matches the beginning of any word or number in the query string is returned.

\n\nFuzzy search is supported for the following text-based field types: Text fields, Multi Line Text fields, and RegExp fields.

\n\nFor example, you might want to search for records related to Tesla vehicles: `query=Tesla`. In this example the API would return every record for the given custom object where any of the supported text fields contain the word 'Tesla'.

\n\nYou can include multiple words or numbers in your search. For example: `query=Tesla Honda 2020`. This search phrase would be URL encoded as `query=Tesla%20Honda%202020` and return every record for the custom object for which any of the supported text fields contained 'Tesla', 'Honda', or '2020'.\n", "key": "query", "value": "" }, { "description": "One of `name`, `created_at`, `updated_at`, `-name`, `-created_at`, or `-updated_at`. The `-` denotes the sort will be descending. Defaults to sorting by relevance.\n", "key": "sort", "value": "" }, { "description": "A [pagination cursor](/documentation/api-basics/pagination/paginating-through-lists-using-cursor-pagination) that tells the endpoint which page to start on. It should be a `meta.before_cursor` value from a previous request. Note: `page[before]` and `page[after]` can't be used together in the same request.\n", "key": "page[before]", "value": "" }, { "description": "A [pagination cursor](/documentation/api-basics/pagination/paginating-through-lists-using-cursor-pagination) that tells the endpoint which page to start on. It should be a `meta.after_cursor` value from a previous request. Note: `page[before]` and `page[after]` can't be used together in the same request.\n", "key": "page[after]", "value": "" }, { "description": "Specifies how many records should be returned in the response. You can specify up to 100 records per page.\n", "key": "page[size]", "value": "" } ], "variable": [ { "key": "custom_object_key" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"count\": \"\",\n \"custom_object_records\": [\n {\n \"value\": \"reference #/components/schemas/CustomObjectRecord not found in the OpenAPI spec\"\n },\n {\n \"value\": \"reference #/components/schemas/CustomObjectRecord not found in the OpenAPI spec\"\n }\n ],\n \"links\": {\n \"prev\": \"\",\n \"next\": \"\"\n },\n \"meta\": {\n \"has_more\": \"\",\n \"after_cursor\": \"\",\n \"before_cursor\": \"\"\n }\n}", "createdAt": "2026-06-05T15:22:36.000Z", "updatedAt": "2026-06-05T15:22:36.000Z", "uid": "35240-e94b83f7-702d-4f2f-b227-3940af26e7bc" } ], "createdAt": "2026-06-05T15:22:36.000Z", "updatedAt": "2026-06-05T15:22:36.000Z", "uid": "35240-9bd5266d-82f2-459a-bd59-a575bc24eef0" } ], "id": "0d44b723-50a6-4162-9bd1-d4003949bd9b", "createdAt": "2026-06-05T15:22:36.000Z", "updatedAt": "2026-06-05T15:22:36.000Z", "uid": "35240-0d44b723-50a6-4162-9bd1-d4003949bd9b" }, { "name": "Zendesk Get Api V2 Custom_objects Custom_object_key Records", "id": "ea9cd249-53bd-4376-baf7-1674e70af73e", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v2/custom_objects/:custom_object_key/records?filter[ids]=&filter[external_ids]=&sort=&page[before]=&page[after]=&page[size]=", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "custom_objects", ":custom_object_key", "records" ], "query": [ { "description": "Optional comma-separated list of ids to filter records by. If one or more ids are specified, only matching records are returned. The ids must be unique and are case sensitive.", "key": "filter[ids]", "value": "" }, { "description": "Optional comma-separated list of external ids to filter records by. If one or more ids are specified, only matching records are returned. The ids must be unique and are case sensitive.", "key": "filter[external_ids]", "value": "" }, { "description": "One of `id`, `updated_at`, `-id`, or `-updated_at`. The `-` denotes the sort will be descending.\n", "key": "sort", "value": "" }, { "description": "A [pagination cursor](/documentation/api-basics/pagination/paginating-through-lists-using-cursor-pagination) that tells the endpoint which page to start on. It should be a `meta.before_cursor` value from a previous request. Note: `page[before]` and `page[after]` can't be used together in the same request.\n", "key": "page[before]", "value": "" }, { "description": "A [pagination cursor](/documentation/api-basics/pagination/paginating-through-lists-using-cursor-pagination) that tells the endpoint which page to start on. It should be a `meta.after_cursor` value from a previous request. Note: `page[before]` and `page[after]` can't be used together in the same request.\n", "key": "page[after]", "value": "" }, { "description": "Specifies how many records should be returned in the response. You can specify up to 100 records per page.\n", "key": "page[size]", "value": "" } ], "variable": [ { "id": "5bfb6f22-6928-49eb-acae-a03f4fbf6467", "key": "custom_object_key" } ] }, "description": "Lists all undeleted custom object records for the specified object\n\n #### Pagination\n\n* [Cursor pagination](/api-reference/introduction/pagination/#cursor-pagination) only.\n#### Allowed For\n* Agents" }, "response": [ { "id": "ee32c064-b6c9-4163-b748-bf40e66f83f7", "name": "Success response", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v2/custom_objects/:custom_object_key/records?filter[ids]=&filter[external_ids]=&sort=&page[before]=&page[after]=&page[size]=", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "custom_objects", ":custom_object_key", "records" ], "query": [ { "description": "Optional comma-separated list of ids to filter records by. If one or more ids are specified, only matching records are returned. The ids must be unique and are case sensitive.", "key": "filter[ids]", "value": "" }, { "description": "Optional comma-separated list of external ids to filter records by. If one or more ids are specified, only matching records are returned. The ids must be unique and are case sensitive.", "key": "filter[external_ids]", "value": "" }, { "description": "One of `id`, `updated_at`, `-id`, or `-updated_at`. The `-` denotes the sort will be descending.\n", "key": "sort", "value": "" }, { "description": "A [pagination cursor](/documentation/api-basics/pagination/paginating-through-lists-using-cursor-pagination) that tells the endpoint which page to start on. It should be a `meta.before_cursor` value from a previous request. Note: `page[before]` and `page[after]` can't be used together in the same request.\n", "key": "page[before]", "value": "" }, { "description": "A [pagination cursor](/documentation/api-basics/pagination/paginating-through-lists-using-cursor-pagination) that tells the endpoint which page to start on. It should be a `meta.after_cursor` value from a previous request. Note: `page[before]` and `page[after]` can't be used together in the same request.\n", "key": "page[after]", "value": "" }, { "description": "Specifies how many records should be returned in the response. You can specify up to 100 records per page.\n", "key": "page[size]", "value": "" } ], "variable": [ { "key": "custom_object_key" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"count\": \"\",\n \"custom_object_records\": [\n {\n \"value\": \"reference #/components/schemas/CustomObjectRecord not found in the OpenAPI spec\"\n },\n {\n \"value\": \"reference #/components/schemas/CustomObjectRecord not found in the OpenAPI spec\"\n }\n ],\n \"links\": {\n \"prev\": \"\",\n \"next\": \"\"\n },\n \"meta\": {\n \"has_more\": \"\",\n \"after_cursor\": \"\",\n \"before_cursor\": \"\"\n }\n}", "createdAt": "2026-06-05T15:22:36.000Z", "updatedAt": "2026-06-05T15:22:36.000Z", "uid": "35240-ee32c064-b6c9-4163-b748-bf40e66f83f7" } ], "createdAt": "2026-06-05T15:22:36.000Z", "updatedAt": "2026-06-05T15:22:36.000Z", "uid": "35240-ea9cd249-53bd-4376-baf7-1674e70af73e" }, { "name": "Zendesk Post Api V2 Custom_objects Custom_object_key Records", "id": "490ad8e1-0ca9-4b66-a16d-54b0b06b3186", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"value\": \"reference #/components/schemas/CustomObjectRecordsCreateRequest not found in the OpenAPI spec\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/custom_objects/:custom_object_key/records", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "custom_objects", ":custom_object_key", "records" ], "variable": [ { "id": "e28269c7-e449-40f0-990b-2c4c2856561f", "key": "custom_object_key" } ] }, "description": "Creates a custom object record according to all the properties described by a custom object definition. If `autoincrement_enabled` is true, record names aren't allowed in the request body because they are generated automatically. If `is_unique` is true, record names must be unique.\n#### Allowed For\n* Agents\n" }, "response": [ { "id": "408bc1a7-f9dd-4abe-9fff-2fca58e601de", "name": "Created", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"value\": \"reference #/components/schemas/CustomObjectRecordsCreateRequest not found in the OpenAPI spec\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/custom_objects/:custom_object_key/records", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "custom_objects", ":custom_object_key", "records" ], "variable": [ { "key": "custom_object_key" } ] } }, "status": "Created", "code": 201, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"custom_object_record\": {\n \"value\": \"reference #/components/schemas/CustomObjectRecord not found in the OpenAPI spec\"\n }\n}", "createdAt": "2026-06-05T15:22:36.000Z", "updatedAt": "2026-06-05T15:22:36.000Z", "uid": "35240-408bc1a7-f9dd-4abe-9fff-2fca58e601de" } ], "createdAt": "2026-06-05T15:22:36.000Z", "updatedAt": "2026-06-05T15:22:36.000Z", "uid": "35240-490ad8e1-0ca9-4b66-a16d-54b0b06b3186" }, { "name": "Zendesk Patch Api V2 Custom_objects Custom_object_key Records", "id": "a8354a07-2fc5-49c7-b5ac-c904c612e186", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"value\": \"reference #/components/schemas/CustomObjectRecordsUpsertRequest not found in the OpenAPI spec\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/custom_objects/:custom_object_key/records", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "custom_objects", ":custom_object_key", "records" ], "variable": [ { "id": "0a07c4fa-7a54-473a-99f0-35d02114798d", "key": "custom_object_key" } ] }, "description": "If a record exists for the given external id or name, updates it. Only the specified attributes are updated. Otherwise, creates a new record with the provided external id, name and other attributes. The `is_unqiue` property on the custom object's name field must be enabled in order to update or create by name. External id and name cannot be used together in the same request.\n#### Allowed For\n* Agents\n" }, "response": [ { "id": "d8a049a6-b44d-4827-be21-225e87b806e0", "name": "Success", "originalRequest": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"value\": \"reference #/components/schemas/CustomObjectRecordsUpsertRequest not found in the OpenAPI spec\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/custom_objects/:custom_object_key/records", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "custom_objects", ":custom_object_key", "records" ], "variable": [ { "key": "custom_object_key" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"custom_object_record\": {\n \"value\": \"reference #/components/schemas/CustomObjectRecord not found in the OpenAPI spec\"\n }\n}", "createdAt": "2026-06-05T15:22:36.000Z", "updatedAt": "2026-06-05T15:22:36.000Z", "uid": "35240-d8a049a6-b44d-4827-be21-225e87b806e0" } ], "createdAt": "2026-06-05T15:22:36.000Z", "updatedAt": "2026-06-05T15:22:36.000Z", "uid": "35240-a8354a07-2fc5-49c7-b5ac-c904c612e186" }, { "name": "Zendesk Delete Api V2 Custom_objects Custom_object_key Records", "id": "3b685c39-fd22-4102-9370-c3603d1e4cae", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "DELETE", "header": [], "url": { "raw": "{{baseUrl}}/api/v2/custom_objects/:custom_object_key/records", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "custom_objects", ":custom_object_key", "records" ], "variable": [ { "id": "636b94fb-5116-4157-afba-d9bce8e74b6c", "key": "custom_object_key" } ] }, "description": "Deletes a record with the specified external id or name. The `is_unique` property on the custom object's name field must be enabled in order to delete by name. External id and name cannot be used together in the same request.\n#### Allowed For\n* Agents\n" }, "response": [ { "id": "96530b39-5745-47a0-bc5b-0b10e32beb24", "name": "No content response", "originalRequest": { "method": "DELETE", "header": [], "url": { "raw": "{{baseUrl}}/api/v2/custom_objects/:custom_object_key/records", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "custom_objects", ":custom_object_key", "records" ], "variable": [ { "key": "custom_object_key" } ] } }, "status": "No Content", "code": 204, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:22:36.000Z", "updatedAt": "2026-06-05T15:22:36.000Z", "uid": "35240-96530b39-5745-47a0-bc5b-0b10e32beb24" } ], "createdAt": "2026-06-05T15:22:36.000Z", "updatedAt": "2026-06-05T15:22:36.000Z", "uid": "35240-3b685c39-fd22-4102-9370-c3603d1e4cae" } ], "id": "89cf5eda-ee5f-453d-b9e8-04374d95538a", "createdAt": "2026-06-05T15:22:36.000Z", "updatedAt": "2026-06-05T15:22:36.000Z", "uid": "35240-89cf5eda-ee5f-453d-b9e8-04374d95538a" }, { "name": "triggers", "item": [ { "name": "{trigger_id}", "item": [ { "name": "Zendesk Get Api V2 Custom_objects Custom_object_key Triggers Trigger_id", "id": "ffb0d10d-871f-446c-8b32-b08ad18c124a", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v2/custom_objects/:custom_object_key/triggers/:trigger_id", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "custom_objects", ":custom_object_key", "triggers", ":trigger_id" ], "variable": [ { "id": "c6b65d79-e28d-40e3-baac-a2e22ad1a691", "key": "custom_object_key" }, { "id": "4eedd22c-5977-4937-b675-9d018ffeb155", "key": "trigger_id" } ] }, "description": "Returns details of a specific object trigger.\n#### Allowed For\n\n* Agents\n" }, "response": [ { "id": "439a662a-42b4-4a28-a750-3fd940e5b22f", "name": "Success response", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v2/custom_objects/:custom_object_key/triggers/:trigger_id", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "custom_objects", ":custom_object_key", "triggers", ":trigger_id" ], "variable": [ { "key": "custom_object_key" }, { "key": "trigger_id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"trigger\": {\n \"value\": \"reference #/components/schemas/ObjectTriggerObject not found in the OpenAPI spec\"\n }\n}", "createdAt": "2026-06-05T15:22:36.000Z", "updatedAt": "2026-06-05T15:22:36.000Z", "uid": "35240-439a662a-42b4-4a28-a750-3fd940e5b22f" } ], "createdAt": "2026-06-05T15:22:36.000Z", "updatedAt": "2026-06-05T15:22:36.000Z", "uid": "35240-ffb0d10d-871f-446c-8b32-b08ad18c124a" }, { "name": "Zendesk Put Api V2 Custom_objects Custom_object_key Triggers Trigger_id", "id": "06524f32-e1d8-4b0a-9cb3-79fe0f4ef9dd", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"value\": \"reference #/components/schemas/ObjectTriggerRequest not found in the OpenAPI spec\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/custom_objects/:custom_object_key/triggers/:trigger_id", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "custom_objects", ":custom_object_key", "triggers", ":trigger_id" ], "variable": [ { "id": "1c2bfaa8-c8db-4093-8610-42e72964009c", "key": "custom_object_key" }, { "id": "545aea01-b7bd-4a12-adc7-0695a104caad", "key": "trigger_id" } ] }, "description": "Updates a specified object trigger.\n\n**Note**: Updating a condition or action updates both the conditions and actions arrays,\nclearing all existing values of both arrays. Include all your conditions\nand actions when updating any condition or action.\n\n#### Allowed For\n\n* Administrators\n* Agents in custom roles with the `manage_triggers` permission (Enterprise only)\n" }, "response": [ { "id": "d0c28eac-8a7e-418c-a7e6-ea0ea9386660", "name": "Success response", "originalRequest": { "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"value\": \"reference #/components/schemas/ObjectTriggerRequest not found in the OpenAPI spec\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/custom_objects/:custom_object_key/triggers/:trigger_id", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "custom_objects", ":custom_object_key", "triggers", ":trigger_id" ], "variable": [ { "key": "custom_object_key" }, { "key": "trigger_id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"trigger\": {\n \"value\": \"reference #/components/schemas/ObjectTriggerObject not found in the OpenAPI spec\"\n }\n}", "createdAt": "2026-06-05T15:22:36.000Z", "updatedAt": "2026-06-05T15:22:36.000Z", "uid": "35240-d0c28eac-8a7e-418c-a7e6-ea0ea9386660" } ], "createdAt": "2026-06-05T15:22:36.000Z", "updatedAt": "2026-06-05T15:22:36.000Z", "uid": "35240-06524f32-e1d8-4b0a-9cb3-79fe0f4ef9dd" }, { "name": "Zendesk Delete Api V2 Custom_objects Custom_object_key Triggers Trigger_id", "id": "6e5a51e7-137f-49dc-8c39-baaf82ecf6e8", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "DELETE", "header": [], "url": { "raw": "{{baseUrl}}/api/v2/custom_objects/:custom_object_key/triggers/:trigger_id", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "custom_objects", ":custom_object_key", "triggers", ":trigger_id" ], "variable": [ { "id": "c75447ee-fc22-4c5d-a919-60deadacae67", "key": "custom_object_key" }, { "id": "fd2934f9-50de-4e76-ae7a-99918161a8cf", "key": "trigger_id" } ] }, "description": "Deletes a specified object trigger.\n\n#### Allowed For\n\n* Administrators\n* Agents in custom roles with the `manage_triggers` permission (Enterprise only)\n" }, "response": [ { "id": "75aa9a23-e2aa-4d9b-b4f2-0aff61b23e5b", "name": "No Content response", "originalRequest": { "method": "DELETE", "header": [], "url": { "raw": "{{baseUrl}}/api/v2/custom_objects/:custom_object_key/triggers/:trigger_id", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "custom_objects", ":custom_object_key", "triggers", ":trigger_id" ], "variable": [ { "key": "custom_object_key" }, { "key": "trigger_id" } ] } }, "status": "No Content", "code": 204, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:22:36.000Z", "updatedAt": "2026-06-05T15:22:36.000Z", "uid": "35240-75aa9a23-e2aa-4d9b-b4f2-0aff61b23e5b" } ], "createdAt": "2026-06-05T15:22:36.000Z", "updatedAt": "2026-06-05T15:22:36.000Z", "uid": "35240-6e5a51e7-137f-49dc-8c39-baaf82ecf6e8" } ], "id": "73e46468-af8a-46f0-8de6-d8293544c0c8", "createdAt": "2026-06-05T15:22:36.000Z", "updatedAt": "2026-06-05T15:22:36.000Z", "uid": "35240-73e46468-af8a-46f0-8de6-d8293544c0c8" }, { "name": "active", "item": [ { "name": "Zendesk Get Api V2 Custom_objects Custom_object_key Triggers Active", "id": "10a18dee-8657-4e9c-8fe7-1a51b897053a", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v2/custom_objects/:custom_object_key/triggers/active", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "custom_objects", ":custom_object_key", "triggers", "active" ], "variable": [ { "id": "a5136353-a2ed-4946-952a-f516853c5229", "key": "custom_object_key" } ] }, "description": "Lists all active object triggers.\n\n#### Pagination\n\n- Cursor pagination (recommended)\n- Offset pagination\n\nSee [Pagination](/api-reference/introduction/pagination/).\n\nReturns a maximum of 100 records per page.\n\n#### Allowed For\n\n* Administrators\n* Agents in custom roles with the `manage_triggers` permission (Enterprise only)\n" }, "response": [ { "id": "1bb6cf1d-d40d-480c-99d7-bc0e2bb6a89b", "name": "Success response", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v2/custom_objects/:custom_object_key/triggers/active", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "custom_objects", ":custom_object_key", "triggers", "active" ], "variable": [ { "key": "custom_object_key" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"count\": \"\",\n \"next_page\": \"\",\n \"previous_page\": \"\",\n \"triggers\": [\n {\n \"value\": \"reference #/components/schemas/ObjectTriggerObject not found in the OpenAPI spec\"\n },\n {\n \"value\": \"reference #/components/schemas/ObjectTriggerObject not found in the OpenAPI spec\"\n }\n ]\n}", "createdAt": "2026-06-05T15:22:36.000Z", "updatedAt": "2026-06-05T15:22:36.000Z", "uid": "35240-1bb6cf1d-d40d-480c-99d7-bc0e2bb6a89b" } ], "createdAt": "2026-06-05T15:22:36.000Z", "updatedAt": "2026-06-05T15:22:36.000Z", "uid": "35240-10a18dee-8657-4e9c-8fe7-1a51b897053a" } ], "id": "5382744f-bf35-4c75-8ec6-8b4ffef9a1a3", "createdAt": "2026-06-05T15:22:36.000Z", "updatedAt": "2026-06-05T15:22:36.000Z", "uid": "35240-5382744f-bf35-4c75-8ec6-8b4ffef9a1a3" }, { "name": "definitions", "item": [ { "name": "Zendesk Get Api V2 Custom_objects Custom_object_key Triggers Definitions", "id": "7d91cc5e-5469-4b2c-be04-1bf13dde2d9c", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v2/custom_objects/:custom_object_key/triggers/definitions", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "custom_objects", ":custom_object_key", "triggers", "definitions" ], "variable": [ { "id": "0e1151c3-1c79-49bb-a5e3-ac480f98b431", "key": "custom_object_key" } ] }, "description": "Lists the conditions and actions of all triggers for the specified custom object.\n\n#### Allowed For \n* Agents\n" }, "response": [ { "id": "2a9c1ee6-9e6a-465b-8606-9b5b5834c774", "name": "Success response", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v2/custom_objects/:custom_object_key/triggers/definitions", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "custom_objects", ":custom_object_key", "triggers", "definitions" ], "variable": [ { "key": "custom_object_key" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"definitions\": {\n \"value\": \"reference #/components/schemas/ObjectTriggerDefinitionObject not found in the OpenAPI spec\"\n }\n}", "createdAt": "2026-06-05T15:22:36.000Z", "updatedAt": "2026-06-05T15:22:36.000Z", "uid": "35240-2a9c1ee6-9e6a-465b-8606-9b5b5834c774" } ], "createdAt": "2026-06-05T15:22:36.000Z", "updatedAt": "2026-06-05T15:22:36.000Z", "uid": "35240-7d91cc5e-5469-4b2c-be04-1bf13dde2d9c" } ], "id": "e7051f6d-deb4-4d5c-a6e0-19dec21832f8", "createdAt": "2026-06-05T15:22:36.000Z", "updatedAt": "2026-06-05T15:22:36.000Z", "uid": "35240-e7051f6d-deb4-4d5c-a6e0-19dec21832f8" }, { "name": "destroy_many", "item": [ { "name": "Zendesk Delete Api V2 Custom_objects Custom_object_key Triggers Destroy_many", "id": "dbce67e5-cb63-4b73-851e-2cc78246ade1", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "DELETE", "header": [], "url": { "raw": "{{baseUrl}}/api/v2/custom_objects/:custom_object_key/triggers/destroy_many", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "custom_objects", ":custom_object_key", "triggers", "destroy_many" ], "variable": [ { "id": "638db0db-5483-4e2e-adc2-cf9a95bf4433", "key": "custom_object_key" } ] }, "description": "Deletes the object triggers corresponding to the provided comma-separated list of ids. \n\n**Note**: You can only bulk-delete triggers associated with one object at a time, specified by the `custom_object_key` in the request.\n\n#### Allowed For\n\n* Administrators\n* Agents in custom roles with the `manage_triggers` permission (Enterprise only)\n\n#### Request Parameters\n\nThe DELETE request takes an `ids` object that lists the\nobject triggers to delete. All of the specified object trigger `ids` must be associated with a single object.\n\n| Name | Description\n| ---- | -----------\n| ids | The ids of the triggers to delete\n\n#### Example request\n\n```js\n{\n \"ids\": \"25,23,27,22\"\n}\n```\n" }, "response": [ { "id": "c0b16de2-1fa8-430a-9478-6d02ebb57060", "name": "No content response", "originalRequest": { "method": "DELETE", "header": [], "url": { "raw": "{{baseUrl}}/api/v2/custom_objects/:custom_object_key/triggers/destroy_many", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "custom_objects", ":custom_object_key", "triggers", "destroy_many" ], "variable": [ { "key": "custom_object_key" } ] } }, "status": "No Content", "code": 204, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:22:36.000Z", "updatedAt": "2026-06-05T15:22:36.000Z", "uid": "35240-c0b16de2-1fa8-430a-9478-6d02ebb57060" } ], "createdAt": "2026-06-05T15:22:36.000Z", "updatedAt": "2026-06-05T15:22:36.000Z", "uid": "35240-dbce67e5-cb63-4b73-851e-2cc78246ade1" } ], "id": "3c6e2129-8e1c-4cb4-935b-25c8ece30b65", "createdAt": "2026-06-05T15:22:36.000Z", "updatedAt": "2026-06-05T15:22:36.000Z", "uid": "35240-3c6e2129-8e1c-4cb4-935b-25c8ece30b65" }, { "name": "search", "item": [ { "name": "Zendesk Get Api V2 Custom_objects Custom_object_key Triggers Search", "id": "70aca084-0633-4bcc-9fc5-648bece2db82", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v2/custom_objects/:custom_object_key/triggers/search", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "custom_objects", ":custom_object_key", "triggers", "search" ], "variable": [ { "id": "abdef59a-da8f-4624-bcc6-6ac38d9c6a09", "key": "custom_object_key" } ] }, "description": "Returns a list of object triggers that meet your filter or search criteria.\n\n#### Pagination\n\n* Offset pagination only\n\nSee [Using Offset Pagination](/api-reference/introduction/pagination/#using-offset-pagination).\n\n#### Allowed For\n\n* Agents\n\n#### Filter\n\nUse the `filter` query parameter to filter an object trigger search by one or more attributes. For example, the following `filter` argument filters object triggers by the `title` attribute:\n\n```json\n{\n \"json\": {\n \"title\": \"test\"\n }\n}\n```\n" }, "response": [ { "id": "82a0ce1d-9df9-4bbd-a55e-41a078ec2709", "name": "Success response", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v2/custom_objects/:custom_object_key/triggers/search", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "custom_objects", ":custom_object_key", "triggers", "search" ], "variable": [ { "key": "custom_object_key" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"count\": \"\",\n \"next_page\": \"\",\n \"previous_page\": \"\",\n \"triggers\": [\n {\n \"value\": \"reference #/components/schemas/ObjectTriggerObject not found in the OpenAPI spec\"\n },\n {\n \"value\": \"reference #/components/schemas/ObjectTriggerObject not found in the OpenAPI spec\"\n }\n ]\n}", "createdAt": "2026-06-05T15:22:36.000Z", "updatedAt": "2026-06-05T15:22:36.000Z", "uid": "35240-82a0ce1d-9df9-4bbd-a55e-41a078ec2709" } ], "createdAt": "2026-06-05T15:22:36.000Z", "updatedAt": "2026-06-05T15:22:36.000Z", "uid": "35240-70aca084-0633-4bcc-9fc5-648bece2db82" } ], "id": "119ed634-e9d8-47de-b4d3-4e980532a123", "createdAt": "2026-06-05T15:22:36.000Z", "updatedAt": "2026-06-05T15:22:36.000Z", "uid": "35240-119ed634-e9d8-47de-b4d3-4e980532a123" }, { "name": "update_many", "item": [ { "name": "Zendesk Put Api V2 Custom_objects Custom_object_key Triggers Update_many", "id": "17731464-f39b-4a68-962b-4f523048d39f", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"value\": \"reference #/components/schemas/ObjectTriggerBulkUpdateRequest not found in the OpenAPI spec\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/custom_objects/:custom_object_key/triggers/update_many", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "custom_objects", ":custom_object_key", "triggers", "update_many" ], "variable": [ { "id": "c28600ab-7a93-46cc-88a3-ce75734c714b", "key": "custom_object_key" } ] }, "description": "Updates the position or the active status of multiple object triggers. Any additional properties are ignored.\n\n**Note**: You can only bulk-update triggers associated with one object at a time, specified by the `custom_object_key` in the request.\n\n#### Allowed For\n\n* Administrators\n* Agents in custom roles with the `manage_triggers` permission (Enterprise only)\n\n#### Request Parameters\n\nThe PUT request expects a `triggers` object that lists the object triggers to update. All of the specified object trigger `ids` must be associated with a single object.\n\nYou can specify the following properties for each object trigger you're updating:\n\n| Name | Mandatory | Description\n| -------- | --------- | -----------\n| id | yes | The ID of the object trigger to update\n| position | no | The new position of the object trigger\n| active | no | The active status of the object trigger (true or false)\n\n#### Example Request\n\n```js\n{\n \"triggers\": [\n {\"id\": 25, \"position\": 3},\n {\"id\": 23, \"active\": true},\n {\"id\": 27, \"position\": 9, \"active\": false},\n {\"id\": 22, \"position\": 7}\n ]\n}\n```\n" }, "response": [ { "id": "f995cafd-57fe-4c56-8fd8-55e10fa8e274", "name": "Success response", "originalRequest": { "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"value\": \"reference #/components/schemas/ObjectTriggerBulkUpdateRequest not found in the OpenAPI spec\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/custom_objects/:custom_object_key/triggers/update_many", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "custom_objects", ":custom_object_key", "triggers", "update_many" ], "variable": [ { "key": "custom_object_key" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"count\": \"\",\n \"next_page\": \"\",\n \"previous_page\": \"\",\n \"triggers\": [\n {\n \"value\": \"reference #/components/schemas/ObjectTriggerObject not found in the OpenAPI spec\"\n },\n {\n \"value\": \"reference #/components/schemas/ObjectTriggerObject not found in the OpenAPI spec\"\n }\n ]\n}", "createdAt": "2026-06-05T15:22:36.000Z", "updatedAt": "2026-06-05T15:22:36.000Z", "uid": "35240-f995cafd-57fe-4c56-8fd8-55e10fa8e274" } ], "createdAt": "2026-06-05T15:22:36.000Z", "updatedAt": "2026-06-05T15:22:36.000Z", "uid": "35240-17731464-f39b-4a68-962b-4f523048d39f" } ], "id": "64cb89ee-75ce-4369-8396-93abbc195cde", "createdAt": "2026-06-05T15:22:36.000Z", "updatedAt": "2026-06-05T15:22:36.000Z", "uid": "35240-64cb89ee-75ce-4369-8396-93abbc195cde" }, { "name": "Zendesk Get Api V2 Custom_objects Custom_object_key Triggers", "id": "1c9ce60b-b1bb-43c1-80cb-6a5ec85862ed", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v2/custom_objects/:custom_object_key/triggers", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "custom_objects", ":custom_object_key", "triggers" ], "variable": [ { "id": "f1b187a8-52c8-4eb7-96af-c0e8ad685d66", "key": "custom_object_key" } ] }, "description": "Lists all triggers for the specified custom object.\n\n#### Allowed For \n* Agents\n" }, "response": [ { "id": "3278c618-0fef-4dc4-bf9b-55db23475fe3", "name": "Success response", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v2/custom_objects/:custom_object_key/triggers", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "custom_objects", ":custom_object_key", "triggers" ], "variable": [ { "key": "custom_object_key" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"count\": \"\",\n \"next_page\": \"\",\n \"previous_page\": \"\",\n \"triggers\": [\n {\n \"value\": \"reference #/components/schemas/ObjectTriggerObject not found in the OpenAPI spec\"\n },\n {\n \"value\": \"reference #/components/schemas/ObjectTriggerObject not found in the OpenAPI spec\"\n }\n ]\n}", "createdAt": "2026-06-05T15:22:36.000Z", "updatedAt": "2026-06-05T15:22:36.000Z", "uid": "35240-3278c618-0fef-4dc4-bf9b-55db23475fe3" } ], "createdAt": "2026-06-05T15:22:36.000Z", "updatedAt": "2026-06-05T15:22:36.000Z", "uid": "35240-1c9ce60b-b1bb-43c1-80cb-6a5ec85862ed" }, { "name": "Zendesk Post Api V2 Custom_objects Custom_object_key Triggers", "id": "1a132a10-e5e8-4b47-be85-ec74bacb83f4", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"value\": \"reference #/components/schemas/ObjectTriggerRequest not found in the OpenAPI spec\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/custom_objects/:custom_object_key/triggers", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "custom_objects", ":custom_object_key", "triggers" ], "variable": [ { "id": "ecc7f9b4-7f44-4b7b-85d0-e1db32a21353", "key": "custom_object_key" } ] }, "description": "Creates a new object trigger for a specified object.\n\n#### Allowed For\n\n* Administrators\n* Agents in custom roles with the `manage_triggers` permission (Enterprise only)\n" }, "response": [ { "id": "68ebf820-b825-4862-89de-fdb764c2c735", "name": "Created response", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"value\": \"reference #/components/schemas/ObjectTriggerRequest not found in the OpenAPI spec\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/custom_objects/:custom_object_key/triggers", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "custom_objects", ":custom_object_key", "triggers" ], "variable": [ { "key": "custom_object_key" } ] } }, "status": "Created", "code": 201, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"trigger\": {\n \"value\": \"reference #/components/schemas/ObjectTriggerObject not found in the OpenAPI spec\"\n }\n}", "createdAt": "2026-06-05T15:22:36.000Z", "updatedAt": "2026-06-05T15:22:36.000Z", "uid": "35240-68ebf820-b825-4862-89de-fdb764c2c735" } ], "createdAt": "2026-06-05T15:22:36.000Z", "updatedAt": "2026-06-05T15:22:36.000Z", "uid": "35240-1a132a10-e5e8-4b47-be85-ec74bacb83f4" } ], "id": "1ed672e6-d95e-4e50-bb37-a049a2616cfc", "createdAt": "2026-06-05T15:22:36.000Z", "updatedAt": "2026-06-05T15:22:36.000Z", "uid": "35240-1ed672e6-d95e-4e50-bb37-a049a2616cfc" }, { "name": "Zendesk Get Api V2 Custom_objects Custom_object_key", "id": "6e8d61df-7dd2-469e-b011-04957b4079d4", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v2/custom_objects/:custom_object_key", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "custom_objects", ":custom_object_key" ], "variable": [ { "id": "239f1487-73d4-4201-9724-5c585a027bcd", "key": "custom_object_key" } ] }, "description": "Returns an object with the specified key\n#### Allowed For\n* Agents\n" }, "response": [ { "id": "69e83fd2-cd3d-4c46-9104-ca39be98162a", "name": "Custom Object", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v2/custom_objects/:custom_object_key", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "custom_objects", ":custom_object_key" ], "variable": [ { "key": "custom_object_key" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"custom_object\": {\n \"value\": \"reference #/components/schemas/CustomObject not found in the OpenAPI spec\"\n }\n}", "createdAt": "2026-06-05T15:22:36.000Z", "updatedAt": "2026-06-05T15:22:36.000Z", "uid": "35240-69e83fd2-cd3d-4c46-9104-ca39be98162a" } ], "createdAt": "2026-06-05T15:22:36.000Z", "updatedAt": "2026-06-05T15:22:36.000Z", "uid": "35240-6e8d61df-7dd2-469e-b011-04957b4079d4" }, { "name": "Zendesk Patch Api V2 Custom_objects Custom_object_key", "id": "f1181afa-e518-4113-9a87-575a9084d805", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "PATCH", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v2/custom_objects/:custom_object_key", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "custom_objects", ":custom_object_key" ], "variable": [ { "id": "d1af11e5-3368-46f2-94c1-59b72ba5b81e", "key": "custom_object_key" } ] }, "description": "Updates an individual custom object. The updating rules are as follows:\n* Takes a `custom_object` object that specifies the properties to update\n* The `key` property cannot be updated\n#### Allowed For\n* Admins" }, "response": [ { "id": "b9c1ab63-5358-4d56-9a80-396fd95a01c4", "name": "Success response", "originalRequest": { "method": "PATCH", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v2/custom_objects/:custom_object_key", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "custom_objects", ":custom_object_key" ], "variable": [ { "key": "custom_object_key" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"custom_object\": {\n \"value\": \"reference #/components/schemas/CustomObject not found in the OpenAPI spec\"\n }\n}", "createdAt": "2026-06-05T15:22:36.000Z", "updatedAt": "2026-06-05T15:22:36.000Z", "uid": "35240-b9c1ab63-5358-4d56-9a80-396fd95a01c4" } ], "createdAt": "2026-06-05T15:22:36.000Z", "updatedAt": "2026-06-05T15:22:36.000Z", "uid": "35240-f1181afa-e518-4113-9a87-575a9084d805" }, { "name": "Zendesk Delete Api V2 Custom_objects Custom_object_key", "id": "a31117db-9d4d-4011-9681-35c738acd3cc", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "DELETE", "header": [], "url": { "raw": "{{baseUrl}}/api/v2/custom_objects/:custom_object_key", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "custom_objects", ":custom_object_key" ], "variable": [ { "id": "fc0bdf73-5999-4391-ba11-0dd492b8ea61", "key": "custom_object_key" } ] }, "description": "Permanently deletes the custom object with the specified key\n#### Allowed For\n* Admins" }, "response": [ { "id": "944a9812-c2f2-458d-8aca-d835d48b4447", "name": "No content response", "originalRequest": { "method": "DELETE", "header": [], "url": { "raw": "{{baseUrl}}/api/v2/custom_objects/:custom_object_key", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "custom_objects", ":custom_object_key" ], "variable": [ { "key": "custom_object_key" } ] } }, "status": "No Content", "code": 204, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:22:36.000Z", "updatedAt": "2026-06-05T15:22:36.000Z", "uid": "35240-944a9812-c2f2-458d-8aca-d835d48b4447" } ], "createdAt": "2026-06-05T15:22:36.000Z", "updatedAt": "2026-06-05T15:22:36.000Z", "uid": "35240-a31117db-9d4d-4011-9681-35c738acd3cc" } ], "id": "55bb46e8-d0ec-46fb-83ff-68c7201c4ab0", "createdAt": "2026-06-05T15:22:36.000Z", "updatedAt": "2026-06-05T15:22:36.000Z", "uid": "35240-55bb46e8-d0ec-46fb-83ff-68c7201c4ab0" }, { "name": "limits", "item": [ { "name": "object_limit", "item": [ { "name": "Zendesk Get Api V2 Custom_objects Limits Object_limit", "id": "389e85f4-e789-4a71-8268-243edb4d5f66", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v2/custom_objects/limits/object_limit", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "custom_objects", "limits", "object_limit" ] }, "description": "List the current count and the limit for custom objects\n#### Allowed For\n* Admins" }, "response": [ { "id": "23a5076c-6dd9-4503-bd8a-3f105b4492fc", "name": "Success response", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v2/custom_objects/limits/object_limit", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "custom_objects", "limits", "object_limit" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"count\": \"\",\n \"limit\": \"\"\n}", "createdAt": "2026-06-05T15:22:36.000Z", "updatedAt": "2026-06-05T15:22:36.000Z", "uid": "35240-23a5076c-6dd9-4503-bd8a-3f105b4492fc" } ], "createdAt": "2026-06-05T15:22:36.000Z", "updatedAt": "2026-06-05T15:22:36.000Z", "uid": "35240-389e85f4-e789-4a71-8268-243edb4d5f66" } ], "id": "9f2863c7-4d2a-4351-af4f-607664e8c131", "createdAt": "2026-06-05T15:22:36.000Z", "updatedAt": "2026-06-05T15:22:36.000Z", "uid": "35240-9f2863c7-4d2a-4351-af4f-607664e8c131" }, { "name": "record_limit", "item": [ { "name": "Zendesk Get Api V2 Custom_objects Limits Record_limit", "id": "0bdb1a77-c77f-4a92-afe2-7411d84b6798", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v2/custom_objects/limits/record_limit", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "custom_objects", "limits", "record_limit" ] }, "description": "List the current count and the limit for custom object records\n#### Allowed For\n* Agents" }, "response": [ { "id": "756a5b9f-8346-4e81-8f0d-1d998cc77ec2", "name": "Success response", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v2/custom_objects/limits/record_limit", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "custom_objects", "limits", "record_limit" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"count\": \"\",\n \"limit\": \"\"\n}", "createdAt": "2026-06-05T15:22:36.000Z", "updatedAt": "2026-06-05T15:22:36.000Z", "uid": "35240-756a5b9f-8346-4e81-8f0d-1d998cc77ec2" } ], "createdAt": "2026-06-05T15:22:36.000Z", "updatedAt": "2026-06-05T15:22:36.000Z", "uid": "35240-0bdb1a77-c77f-4a92-afe2-7411d84b6798" } ], "id": "87232d19-f083-42b9-bf96-12f3daa91281", "createdAt": "2026-06-05T15:22:36.000Z", "updatedAt": "2026-06-05T15:22:36.000Z", "uid": "35240-87232d19-f083-42b9-bf96-12f3daa91281" } ], "id": "6c8ec4fa-d99e-4ef7-80ee-4255ca230f6c", "createdAt": "2026-06-05T15:22:36.000Z", "updatedAt": "2026-06-05T15:22:36.000Z", "uid": "35240-6c8ec4fa-d99e-4ef7-80ee-4255ca230f6c" }, { "name": "Zendesk Get Api V2 Custom_objects", "id": "2bd7e413-a3f8-4206-853c-6e38c75d3be5", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v2/custom_objects", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "custom_objects" ] }, "description": "Lists all undeleted custom objects for the account\n#### Allowed For\n* Agents" }, "response": [ { "id": "0bec126c-dc7a-418f-ba03-016c510fc612", "name": "Success response", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v2/custom_objects", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "custom_objects" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"custom_objects\": [\n {\n \"value\": \"reference #/components/schemas/CustomObject not found in the OpenAPI spec\"\n },\n {\n \"value\": \"reference #/components/schemas/CustomObject not found in the OpenAPI spec\"\n }\n ]\n}", "createdAt": "2026-06-05T15:22:36.000Z", "updatedAt": "2026-06-05T15:22:36.000Z", "uid": "35240-0bec126c-dc7a-418f-ba03-016c510fc612" } ], "createdAt": "2026-06-05T15:22:36.000Z", "updatedAt": "2026-06-05T15:22:36.000Z", "uid": "35240-2bd7e413-a3f8-4206-853c-6e38c75d3be5" }, { "name": "Zendesk Post Api V2 Custom_objects", "id": "081e77b3-1f64-4da9-b24f-c8afa6b67e4a", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"value\": \"reference #/components/schemas/CustomObjectsCreateRequest not found in the OpenAPI spec\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/custom_objects", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "custom_objects" ] }, "description": "Creates an object describing all the properties required to create a custom object record\n#### Allowed For\n* Admins\n" }, "response": [ { "id": "fb42d6ac-f0c5-4b00-abb1-73aa6d798dca", "name": "Created", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"value\": \"reference #/components/schemas/CustomObjectsCreateRequest not found in the OpenAPI spec\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/custom_objects", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "custom_objects" ] } }, "status": "Created", "code": 201, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"custom_object\": {\n \"value\": \"reference #/components/schemas/CustomObject not found in the OpenAPI spec\"\n }\n}", "createdAt": "2026-06-05T15:22:36.000Z", "updatedAt": "2026-06-05T15:22:36.000Z", "uid": "35240-fb42d6ac-f0c5-4b00-abb1-73aa6d798dca" } ], "createdAt": "2026-06-05T15:22:36.000Z", "updatedAt": "2026-06-05T15:22:36.000Z", "uid": "35240-081e77b3-1f64-4da9-b24f-c8afa6b67e4a" } ], "id": "6443ab6a-52dd-44b4-aed3-ce4b1b9f03e5", "createdAt": "2026-06-05T15:22:36.000Z", "updatedAt": "2026-06-05T15:22:36.000Z", "uid": "35240-6443ab6a-52dd-44b4-aed3-ce4b1b9f03e5" } ], "id": "a80eced7-3d25-4ea9-8f96-7a61184a33ac", "createdAt": "2026-06-05T15:22:36.000Z", "updatedAt": "2026-06-05T15:22:36.000Z", "uid": "35240-a80eced7-3d25-4ea9-8f96-7a61184a33ac" } ], "id": "32783b5b-754b-427e-b4de-dea8a6ea18f7", "createdAt": "2026-06-05T15:22:36.000Z", "updatedAt": "2026-06-05T15:22:36.000Z", "uid": "35240-32783b5b-754b-427e-b4de-dea8a6ea18f7" } ], "variable": [ { "key": "baseUrl", "value": "/" } ] }