{ "info": { "_postman_id": "33f3e0c7-99d1-4e86-90cb-dd860c456b8d", "name": "Zendesk Users", "description": "Needs a description.", "schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json", "createdAt": "2026-06-05T15:23:54.000Z", "updatedAt": "2026-06-05T15:23:55.000Z", "lastUpdatedBy": "35240", "uid": "35240-33f3e0c7-99d1-4e86-90cb-dd860c456b8d" }, "item": [ { "name": "api", "item": [ { "name": "v2", "item": [ { "name": "channels", "item": [ { "name": "voice", "item": [ { "name": "agents", "item": [ { "name": "{agent_id}", "item": [ { "name": "users", "item": [ { "name": "{user_id}", "item": [ { "name": "display", "item": [ { "name": "Zendesk Post Api V2 Channels Voice Agents Agent_id Users User_id Display", "id": "905e3b67-26ab-4167-bc43-247bc06ef5b4", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v2/channels/voice/agents/:agent_id/users/:user_id/display", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "channels", "voice", "agents", ":agent_id", "users", ":user_id", "display" ], "variable": [ { "id": "e4ce0cb0-8ffb-4c8f-9c0c-b26c6c660a01", "key": "agent_id" }, { "id": "402d64ad-a1d7-4f31-bd19-aa8d02ad7e17", "key": "user_id" } ] }, "description": "Allows you to instruct an agent's browser to open a user's profile.\n\nWhen the message is successfully delivered to an agent's browser:\n\n```http\nStatus: 200 OK\n```\n\nWhen `agent_id` or `user_id` is invalid:\n\n```http\nStatus: 404 Not Found\n```\n\n#### Allowed For\n* Agents" }, "response": [ { "id": "d55ebc09-743c-4485-8439-36c6839407cf", "name": "Successful response", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v2/channels/voice/agents/:agent_id/users/:user_id/display", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "channels", "voice", "agents", ":agent_id", "users", ":user_id", "display" ], "variable": [ { "key": "agent_id" }, { "key": "user_id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "", "createdAt": "2026-06-05T15:23:55.000Z", "updatedAt": "2026-06-05T15:23:55.000Z", "uid": "35240-d55ebc09-743c-4485-8439-36c6839407cf" }, { "id": "ff7eb716-a0a2-42f4-baa8-fb58f6c23cc1", "name": "When the `agent_id` or `user_id` is invalid", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v2/channels/voice/agents/:agent_id/users/:user_id/display", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "channels", "voice", "agents", ":agent_id", "users", ":user_id", "display" ], "variable": [ { "key": "agent_id" }, { "key": "user_id" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "", "createdAt": "2026-06-05T15:23:55.000Z", "updatedAt": "2026-06-05T15:23:55.000Z", "uid": "35240-ff7eb716-a0a2-42f4-baa8-fb58f6c23cc1" } ], "createdAt": "2026-06-05T15:23:55.000Z", "updatedAt": "2026-06-05T15:23:55.000Z", "uid": "35240-905e3b67-26ab-4167-bc43-247bc06ef5b4" } ], "id": "986e3647-cad4-414f-8f34-35baa537fe07", "createdAt": "2026-06-05T15:23:55.000Z", "updatedAt": "2026-06-05T15:23:55.000Z", "uid": "35240-986e3647-cad4-414f-8f34-35baa537fe07" } ], "id": "394cdb64-3ef4-4804-9f38-a53c3d3d455b", "createdAt": "2026-06-05T15:23:55.000Z", "updatedAt": "2026-06-05T15:23:55.000Z", "uid": "35240-394cdb64-3ef4-4804-9f38-a53c3d3d455b" } ], "id": "9a9beb5c-ab9f-4987-adec-f54388aa4229", "createdAt": "2026-06-05T15:23:55.000Z", "updatedAt": "2026-06-05T15:23:55.000Z", "uid": "35240-9a9beb5c-ab9f-4987-adec-f54388aa4229" } ], "id": "a1fe206d-8ecf-4f57-a325-af2136bdea2a", "createdAt": "2026-06-05T15:23:55.000Z", "updatedAt": "2026-06-05T15:23:55.000Z", "uid": "35240-a1fe206d-8ecf-4f57-a325-af2136bdea2a" } ], "id": "0d7484f9-acdb-44b7-bb2c-739cba0e3df3", "createdAt": "2026-06-05T15:23:55.000Z", "updatedAt": "2026-06-05T15:23:55.000Z", "uid": "35240-0d7484f9-acdb-44b7-bb2c-739cba0e3df3" } ], "id": "038e1e7a-86aa-4004-8090-6c36cbd785fd", "createdAt": "2026-06-05T15:23:55.000Z", "updatedAt": "2026-06-05T15:23:55.000Z", "uid": "35240-038e1e7a-86aa-4004-8090-6c36cbd785fd" } ], "id": "c4ecc78f-24cf-4ece-a5ce-b8c2a1aef96c", "createdAt": "2026-06-05T15:23:55.000Z", "updatedAt": "2026-06-05T15:23:55.000Z", "uid": "35240-c4ecc78f-24cf-4ece-a5ce-b8c2a1aef96c" }, { "name": "incremental", "item": [ { "name": "users", "item": [ { "name": "cursor", "item": [ { "name": "Zendesk Get Api V2 Incremental Users Cursor", "id": "d86813b3-4cb1-4c07-a508-6c526fd84439", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v2/incremental/users/cursor", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "incremental", "users", "cursor" ] }, "description": "#### Allowed For\n\n * Admins\n\n#### Sideloading\n\nSee [Users sideloads](/documentation/ticketing/using-the-zendesk-api/side_loading/#supported-endpoints).\n" }, "response": [ { "id": "536c0286-972b-4526-9d2a-61c13e789eb0", "name": "Success response", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v2/incremental/users/cursor", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "incremental", "users", "cursor" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"after_cursor\": \"\",\n \"after_url\": \"\",\n \"before_cursor\": \"\",\n \"before_url\": \"\",\n \"end_of_stream\": \"\",\n \"users\": [\n {\n \"value\": \"reference #/components/schemas/UserObject not found in the OpenAPI spec\"\n },\n {\n \"value\": \"reference #/components/schemas/UserObject not found in the OpenAPI spec\"\n }\n ]\n}", "createdAt": "2026-06-05T15:23:55.000Z", "updatedAt": "2026-06-05T15:23:55.000Z", "uid": "35240-536c0286-972b-4526-9d2a-61c13e789eb0" } ], "createdAt": "2026-06-05T15:23:55.000Z", "updatedAt": "2026-06-05T15:23:55.000Z", "uid": "35240-d86813b3-4cb1-4c07-a508-6c526fd84439" } ], "id": "aafc2ee9-c7db-48fe-b55a-9b1ebe568bf7", "createdAt": "2026-06-05T15:23:55.000Z", "updatedAt": "2026-06-05T15:23:55.000Z", "uid": "35240-aafc2ee9-c7db-48fe-b55a-9b1ebe568bf7" }, { "name": "Zendesk Get Api V2 Incremental Users", "id": "e72051e3-8485-4dbe-87f0-68d89654b0a6", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v2/incremental/users", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "incremental", "users" ] }, "description": "#### Allowed For\n\n * Admins\n\n#### Sideloading\n\nSee [Users sideloads](/documentation/ticketing/using-the-zendesk-api/side_loading/#supported-endpoints).\n" }, "response": [ { "id": "7f5c6d4c-30a6-42fc-991c-154de79405b5", "name": "Success response", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v2/incremental/users", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "incremental", "users" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"count\": \"\",\n \"end_of_stream\": \"\",\n \"end_time\": \"\",\n \"next_page\": \"\",\n \"users\": [\n {\n \"value\": \"reference #/components/schemas/UserObject not found in the OpenAPI spec\"\n },\n {\n \"value\": \"reference #/components/schemas/UserObject not found in the OpenAPI spec\"\n }\n ]\n}", "createdAt": "2026-06-05T15:23:55.000Z", "updatedAt": "2026-06-05T15:23:55.000Z", "uid": "35240-7f5c6d4c-30a6-42fc-991c-154de79405b5" } ], "createdAt": "2026-06-05T15:23:55.000Z", "updatedAt": "2026-06-05T15:23:55.000Z", "uid": "35240-e72051e3-8485-4dbe-87f0-68d89654b0a6" } ], "id": "fb410912-8d3c-4385-a170-506f832da603", "createdAt": "2026-06-05T15:23:55.000Z", "updatedAt": "2026-06-05T15:23:55.000Z", "uid": "35240-fb410912-8d3c-4385-a170-506f832da603" } ], "id": "a1405bef-0c21-4eb5-badd-58bb65ff4c82", "createdAt": "2026-06-05T15:23:55.000Z", "updatedAt": "2026-06-05T15:23:55.000Z", "uid": "35240-a1405bef-0c21-4eb5-badd-58bb65ff4c82" }, { "name": "users", "item": [ { "name": "{user_id}", "item": [ { "name": "compliance_deletion_statuses", "item": [ { "name": "Zendesk Get Api V2 Users User_id Compliance_deletion_statuses", "id": "b41cd461-6dcd-4b04-8c6c-f8205c251c31", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v2/users/:user_id/compliance_deletion_statuses?application=", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "users", ":user_id", "compliance_deletion_statuses" ], "query": [ { "description": "Area of compliance", "key": "application", "value": "" } ], "variable": [ { "id": "85325272-678f-4fb6-9934-8bda02fb7194", "key": "user_id" } ] }, "description": "Returns the GDPR status for each user per area of compliance. A Zendesk area of compliance is typically a product like \"support/explore\" but can be more fine-grained for areas within the product lines.\n\nIf the user is not in the account, the request returns a 404 status.\n\n```http\nStatus: 404\n{\n \"error\":\"RecordNotFound\",\n \"description\":\"Not found\"\n}\n```\n\n#### Allowed For\n\n* Agents, with restrictions\n\n#### Pagination\n\n* Cursor pagination (recommended)\n* Offset pagination\n\nSee [Pagination](/api-reference/introduction/pagination/).\n" }, "response": [ { "id": "923fb7ee-4e8c-4edd-aef8-e5ee44c212c3", "name": "Success response", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v2/users/:user_id/compliance_deletion_statuses?application=", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "users", ":user_id", "compliance_deletion_statuses" ], "query": [ { "description": "Area of compliance", "key": "application", "value": "" } ], "variable": [ { "key": "user_id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"compliance_deletion_statuses\": [\n {\n \"value\": \"reference #/components/schemas/ComplianceDeletionStatusObject not found in the OpenAPI spec\"\n },\n {\n \"value\": \"reference #/components/schemas/ComplianceDeletionStatusObject not found in the OpenAPI spec\"\n }\n ]\n}", "createdAt": "2026-06-05T15:23:55.000Z", "updatedAt": "2026-06-05T15:23:55.000Z", "uid": "35240-923fb7ee-4e8c-4edd-aef8-e5ee44c212c3" } ], "createdAt": "2026-06-05T15:23:55.000Z", "updatedAt": "2026-06-05T15:23:55.000Z", "uid": "35240-b41cd461-6dcd-4b04-8c6c-f8205c251c31" } ], "id": "eb3246c1-4708-4c80-901e-0daf4fcdc820", "createdAt": "2026-06-05T15:23:55.000Z", "updatedAt": "2026-06-05T15:23:55.000Z", "uid": "35240-eb3246c1-4708-4c80-901e-0daf4fcdc820" }, { "name": "group_memberships", "item": [ { "name": "{group_membership_id}", "item": [ { "name": "make_default", "item": [ { "name": "Zendesk Put Api V2 Users User_id Group_memberships Group_membership_id Make_default", "id": "62e0b941-14d7-434d-82ce-b1cb358a85ab", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v2/users/:user_id/group_memberships/:group_membership_id/make_default", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "users", ":user_id", "group_memberships", ":group_membership_id", "make_default" ], "variable": [ { "id": "8baa9478-6972-474b-a2f9-5cbc9ac4056b", "key": "user_id" }, { "id": "b19d7065-a8a3-4737-b6a4-7168e0bc8955", "key": "group_membership_id" } ] }, "description": "#### Allowed For:\n\n* Agents\n" }, "response": [ { "id": "761e9570-300c-49b1-904a-21a126173e79", "name": "Success response", "originalRequest": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v2/users/:user_id/group_memberships/:group_membership_id/make_default", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "users", ":user_id", "group_memberships", ":group_membership_id", "make_default" ], "variable": [ { "key": "user_id" }, { "key": "group_membership_id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"group_memberships\": [\n {\n \"value\": \"reference #/components/schemas/GroupMembershipObject not found in the OpenAPI spec\"\n },\n {\n \"value\": \"reference #/components/schemas/GroupMembershipObject not found in the OpenAPI spec\"\n }\n ]\n}", "createdAt": "2026-06-05T15:23:55.000Z", "updatedAt": "2026-06-05T15:23:55.000Z", "uid": "35240-761e9570-300c-49b1-904a-21a126173e79" } ], "createdAt": "2026-06-05T15:23:55.000Z", "updatedAt": "2026-06-05T15:23:55.000Z", "uid": "35240-62e0b941-14d7-434d-82ce-b1cb358a85ab" } ], "id": "543fd487-2349-49d1-8f7c-3b50e83b8540", "createdAt": "2026-06-05T15:23:55.000Z", "updatedAt": "2026-06-05T15:23:55.000Z", "uid": "35240-543fd487-2349-49d1-8f7c-3b50e83b8540" } ], "id": "bebc25e5-0712-42f1-89a8-519270e9a5d0", "createdAt": "2026-06-05T15:23:55.000Z", "updatedAt": "2026-06-05T15:23:55.000Z", "uid": "35240-bebc25e5-0712-42f1-89a8-519270e9a5d0" } ], "id": "4746605f-9ec3-417b-860f-03fdae787654", "createdAt": "2026-06-05T15:23:55.000Z", "updatedAt": "2026-06-05T15:23:55.000Z", "uid": "35240-4746605f-9ec3-417b-860f-03fdae787654" }, { "name": "identities", "item": [ { "name": "{user_identity_id}", "item": [ { "name": "make_primary", "item": [ { "name": "Zendesk Put Api V2 Users User_id Identities User_identity_id Make_primary", "id": "cdda2389-8352-41c3-9d4d-a17c79f3ecad", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v2/users/:user_id/identities/:user_identity_id/make_primary", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "users", ":user_id", "identities", ":user_identity_id", "make_primary" ], "variable": [ { "id": "dfe3f710-f2d1-4d52-b203-dfb01ca0de7c", "key": "user_id" }, { "id": "6a70da59-80e7-49a0-b90c-99331dfa15f8", "key": "user_identity_id" } ] }, "description": "Sets the specified identity as primary. To change other attributes, use the [Update Identity](#update-identity) endpoint. This is a collection-level operation and the correct behavior for an API client is to subsequently reload the entire collection.\n\nThe first endpoint is the preferred option if authenticating as an agent. If authenticating as an end user, you can only use the second endpoint. In addition, an end user can only make an email identity primary if the email is verified.\n\n#### Allowed For\n\n* Agents\n* Verified end users\n" }, "response": [ { "id": "bf13f442-098c-4e50-99a8-07d5d26d77e2", "name": "Success response", "originalRequest": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v2/users/:user_id/identities/:user_identity_id/make_primary", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "users", ":user_id", "identities", ":user_identity_id", "make_primary" ], "variable": [ { "key": "user_id" }, { "key": "user_identity_id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"identities\": [\n {\n \"value\": \"reference #/components/schemas/UserIdentityObject not found in the OpenAPI spec\"\n },\n {\n \"value\": \"reference #/components/schemas/UserIdentityObject not found in the OpenAPI spec\"\n }\n ]\n}", "createdAt": "2026-06-05T15:23:55.000Z", "updatedAt": "2026-06-05T15:23:55.000Z", "uid": "35240-bf13f442-098c-4e50-99a8-07d5d26d77e2" } ], "createdAt": "2026-06-05T15:23:55.000Z", "updatedAt": "2026-06-05T15:23:55.000Z", "uid": "35240-cdda2389-8352-41c3-9d4d-a17c79f3ecad" } ], "id": "6304ee74-c8ea-452b-b4e2-374a1b96f17b", "createdAt": "2026-06-05T15:23:55.000Z", "updatedAt": "2026-06-05T15:23:55.000Z", "uid": "35240-6304ee74-c8ea-452b-b4e2-374a1b96f17b" }, { "name": "request_verification", "item": [ { "name": "Zendesk Put Api V2 Users User_id Identities User_identity_id Request_verification", "id": "cb19e393-e72e-4afd-821d-c56c47bf4234", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v2/users/:user_id/identities/:user_identity_id/request_verification", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "users", ":user_id", "identities", ":user_identity_id", "request_verification" ], "variable": [ { "id": "3b264f83-6921-4ddc-9084-680e9ba70535", "key": "user_id" }, { "id": "6249270f-5472-48c4-82d2-451cbf5cdba2", "key": "user_identity_id" } ] }, "description": "Sends the user a verification email with a link to verify ownership of the email address.\n\n#### Allowed For\n\n* Agents\n" }, "response": [ { "id": "98741f0a-3ec4-44e4-a9ea-1dec17594a7f", "name": "Success description", "originalRequest": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v2/users/:user_id/identities/:user_identity_id/request_verification", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "users", ":user_id", "identities", ":user_identity_id", "request_verification" ], "variable": [ { "key": "user_id" }, { "key": "user_identity_id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "", "createdAt": "2026-06-05T15:23:55.000Z", "updatedAt": "2026-06-05T15:23:55.000Z", "uid": "35240-98741f0a-3ec4-44e4-a9ea-1dec17594a7f" } ], "createdAt": "2026-06-05T15:23:55.000Z", "updatedAt": "2026-06-05T15:23:55.000Z", "uid": "35240-cb19e393-e72e-4afd-821d-c56c47bf4234" } ], "id": "0925f3d9-565a-4997-88a6-c8dbcef5ddcc", "createdAt": "2026-06-05T15:23:55.000Z", "updatedAt": "2026-06-05T15:23:55.000Z", "uid": "35240-0925f3d9-565a-4997-88a6-c8dbcef5ddcc" }, { "name": "verify", "item": [ { "name": "Zendesk Put Api V2 Users User_id Identities User_identity_id Verify", "id": "0563cd86-9d03-487d-ad2d-273e71a105e1", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v2/users/:user_id/identities/:user_identity_id/verify", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "users", ":user_id", "identities", ":user_identity_id", "verify" ], "variable": [ { "id": "7dc71922-17e7-4ed7-be34-cf35299390e2", "key": "user_id" }, { "id": "9868387b-5b43-4797-a9a4-0c5517165189", "key": "user_identity_id" } ] }, "description": "Sets the specified identity as verified.\n\nFor security reasons, you can't use this endpoint to update the email identity of the account owner. To verify the person's identity, send a verification email. See [Verifying the account owner's email address](https://support.zendesk.com/hc/en-us/articles/4408828975130) in Zendesk help.\n\nIf [automatic mapping of users to organizations using the email domain](https://support.zendesk.com/hc/en-us/articles/4408882246298-Creating-organizations#topic_nxl_vdt_bc) is enabled and the user is not already a member of an organization, they will be automatically added to the organization associated with the email domain once the email identity is verified.\n\n#### Allowed For\n\n* Agents\n" }, "response": [ { "id": "358e93d6-2259-4586-8ee0-397e99185041", "name": "Success response", "originalRequest": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v2/users/:user_id/identities/:user_identity_id/verify", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "users", ":user_id", "identities", ":user_identity_id", "verify" ], "variable": [ { "key": "user_id" }, { "key": "user_identity_id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"identity\": {\n \"value\": \"reference #/components/schemas/UserIdentityObject not found in the OpenAPI spec\"\n }\n}", "createdAt": "2026-06-05T15:23:55.000Z", "updatedAt": "2026-06-05T15:23:55.000Z", "uid": "35240-358e93d6-2259-4586-8ee0-397e99185041" } ], "createdAt": "2026-06-05T15:23:55.000Z", "updatedAt": "2026-06-05T15:23:55.000Z", "uid": "35240-0563cd86-9d03-487d-ad2d-273e71a105e1" } ], "id": "cd702947-9fdc-418a-9db5-ee2236288319", "createdAt": "2026-06-05T15:23:55.000Z", "updatedAt": "2026-06-05T15:23:55.000Z", "uid": "35240-cd702947-9fdc-418a-9db5-ee2236288319" }, { "name": "Zendesk Get Api V2 Users User_id Identities User_identity_id", "id": "ebdb1633-be8f-4b26-93e0-c5aeadaff1b7", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v2/users/:user_id/identities/:user_identity_id", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "users", ":user_id", "identities", ":user_identity_id" ], "variable": [ { "id": "e84d41b5-ca03-4ee5-9ac2-a920cdffa2fe", "key": "user_id" }, { "id": "1588f19d-7855-48d2-8267-05500aa5b6c6", "key": "user_identity_id" } ] }, "description": "Shows the identity with the given id for a given user.\n\nUse the first endpoint if authenticating as an agent. Use the second if authenticating as an end user. End users can only view email or phone number identity.\n\n#### Allowed For\n\n* Agents\n* Verified end users\n" }, "response": [ { "id": "84f2227a-156b-43ab-97c4-78c717b0704d", "name": "Success response", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v2/users/:user_id/identities/:user_identity_id", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "users", ":user_id", "identities", ":user_identity_id" ], "variable": [ { "key": "user_id" }, { "key": "user_identity_id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"identity\": {\n \"value\": \"reference #/components/schemas/UserIdentityObject not found in the OpenAPI spec\"\n }\n}", "createdAt": "2026-06-05T15:23:55.000Z", "updatedAt": "2026-06-05T15:23:55.000Z", "uid": "35240-84f2227a-156b-43ab-97c4-78c717b0704d" } ], "createdAt": "2026-06-05T15:23:55.000Z", "updatedAt": "2026-06-05T15:23:55.000Z", "uid": "35240-ebdb1633-be8f-4b26-93e0-c5aeadaff1b7" }, { "name": "Zendesk Put Api V2 Users User_id Identities User_identity_id", "id": "b47874a0-49b7-4f53-8e39-7955744b5ae3", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v2/users/:user_id/identities/:user_identity_id", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "users", ":user_id", "identities", ":user_identity_id" ], "variable": [ { "id": "4c433ff5-fe16-44a1-94f1-ef9d2f0d9cd1", "key": "user_id" }, { "id": "2f9afcd6-4748-4635-9161-803cd9d4b0de", "key": "user_identity_id" } ] }, "description": "This endpoint allows you to:\n\n* Set the specified identity as verified (by setting `verified` to \"true\" or `verification_method` to \"low\")\n* Unverify a verified identity (by setting `verified` to \"false\" or `verification_method` to \"none\")\n* Update the `value` property of the specified identity\n\nYou can't change an identity's `primary` attribute with this endpoint. You must use the [Make Identity Primary](#make-identity-primary) endpoint instead.\n\n#### Allowed For\n\n* Agents\n" }, "response": [ { "id": "5483af9a-7373-4d20-babb-5bb8e0689a83", "name": "Success response", "originalRequest": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v2/users/:user_id/identities/:user_identity_id", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "users", ":user_id", "identities", ":user_identity_id" ], "variable": [ { "key": "user_id" }, { "key": "user_identity_id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"identity\": {\n \"value\": \"reference #/components/schemas/UserIdentityObject not found in the OpenAPI spec\"\n }\n}", "createdAt": "2026-06-05T15:23:55.000Z", "updatedAt": "2026-06-05T15:23:55.000Z", "uid": "35240-5483af9a-7373-4d20-babb-5bb8e0689a83" } ], "createdAt": "2026-06-05T15:23:55.000Z", "updatedAt": "2026-06-05T15:23:55.000Z", "uid": "35240-b47874a0-49b7-4f53-8e39-7955744b5ae3" }, { "name": "Zendesk Delete Api V2 Users User_id Identities User_identity_id", "id": "c84dd110-d198-466c-bff1-71b4ce797df8", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "DELETE", "header": [], "url": { "raw": "{{baseUrl}}/api/v2/users/:user_id/identities/:user_identity_id", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "users", ":user_id", "identities", ":user_identity_id" ], "variable": [ { "id": "2f4fa300-fdbd-4a26-97b1-bfe0ee45b478", "key": "user_id" }, { "id": "8155960b-6843-4ce2-b53f-4b1799491e50", "key": "user_identity_id" } ] }, "description": "Deletes the identity for a given user.\nIn certain cases, a phone number associated with an identity is still visible on the user profile after the identity has been deleted via API. You can remove the phone number from the user profile by updating the `phone` attribute of the user to an empty string. See [Update User via API](/api-reference/ticketing/users/users/#update-user) for details and examples.\n\nDeleting identities with type `messaging` could break messaging functionality. For example, an agent may stop being able to send messages via the messaging channel.\n\n#### Allowed For\n* Agents\n" }, "response": [ { "id": "d59d7734-4d57-4860-a01c-3d2fc0e287fb", "name": "No Content response", "originalRequest": { "method": "DELETE", "header": [], "url": { "raw": "{{baseUrl}}/api/v2/users/:user_id/identities/:user_identity_id", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "users", ":user_id", "identities", ":user_identity_id" ], "variable": [ { "key": "user_id" }, { "key": "user_identity_id" } ] } }, "status": "No Content", "code": 204, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:23:55.000Z", "updatedAt": "2026-06-05T15:23:55.000Z", "uid": "35240-d59d7734-4d57-4860-a01c-3d2fc0e287fb" } ], "createdAt": "2026-06-05T15:23:55.000Z", "updatedAt": "2026-06-05T15:23:55.000Z", "uid": "35240-c84dd110-d198-466c-bff1-71b4ce797df8" } ], "id": "44e57792-9bd9-4b60-bd32-f77bd21ce719", "createdAt": "2026-06-05T15:23:55.000Z", "updatedAt": "2026-06-05T15:23:55.000Z", "uid": "35240-44e57792-9bd9-4b60-bd32-f77bd21ce719" }, { "name": "Zendesk Get Api V2 Users User_id Identities", "id": "431d9e29-1d48-43f0-ac3a-da86188ffedb", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v2/users/:user_id/identities?type[]=twitter", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "users", ":user_id", "identities" ], "query": [ { "description": "Filters results by one or more identity types using the format `?type[]={type}&type[]={type}`", "key": "type[]", "value": "twitter" } ], "variable": [ { "id": "0d51b7da-f1d0-42ee-ab0d-e140c62dc0a7", "key": "user_id" } ] }, "description": "Returns a list of identities for the given user.\n\nUse the first endpoint if authenticating as an agent. Use the second if authenticating as an end user. End users can only list email and phone number identities.\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 for cursor pagination.\n\n#### Allowed For\n\n* Agents\n* Verified end users\n" }, "response": [ { "id": "89623a07-f255-44a9-8887-fd458d002c59", "name": "Success response", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v2/users/:user_id/identities?type[]=twitter", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "users", ":user_id", "identities" ], "query": [ { "description": "Filters results by one or more identity types using the format `?type[]={type}&type[]={type}`", "key": "type[]", "value": "twitter" } ], "variable": [ { "key": "user_id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"identities\": [\n {\n \"value\": \"reference #/components/schemas/UserIdentityObject not found in the OpenAPI spec\"\n },\n {\n \"value\": \"reference #/components/schemas/UserIdentityObject not found in the OpenAPI spec\"\n }\n ]\n}", "createdAt": "2026-06-05T15:23:55.000Z", "updatedAt": "2026-06-05T15:23:55.000Z", "uid": "35240-89623a07-f255-44a9-8887-fd458d002c59" } ], "createdAt": "2026-06-05T15:23:55.000Z", "updatedAt": "2026-06-05T15:23:55.000Z", "uid": "35240-431d9e29-1d48-43f0-ac3a-da86188ffedb" }, { "name": "Zendesk Post Api V2 Users User_id Identities", "id": "88279f6d-f5c7-48d9-9cdb-4630ce28f53d", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v2/users/:user_id/identities?type[]=twitter", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "users", ":user_id", "identities" ], "query": [ { "description": "Filters results by one or more identity types using the format `?type[]={type}&type[]={type}`", "key": "type[]", "value": "twitter" } ], "variable": [ { "id": "4ec785e5-7197-490e-88c5-9c5206b83ebe", "key": "user_id" } ] }, "description": "Adds an identity to a user's profile. An agent can add an identity to any user profile.\n\nSupported identity types:\n\n| Type | Example |\n| ---------------- | ------- |\n| email | `{ \"type\" : \"email\", \"value\" : \"someone@example.com\" }` |\n| twitter | `{ \"type\" : \"twitter\", \"value\" : \"screen_name\" }` |\n| facebook | `{ \"type\" : \"facebook\", \"value\" : \"855769377321\" }` |\n| google | `{ \"type\" : \"google\", \"value\" : \"example@gmail.com\" }` |\n| agent_forwarding | `{ \"type\" : \"agent_forwarding\", \"value\" : \"+1 555-123-4567\" }` |\n| phone_number | `{ \"type\" : \"phone_number\", \"value\" : \"+1 555-123-4567\" }` |\n\nTo create an identity without sending out a verification email, include a `\"skip_verify_email\": true` property. The `\"skip_verify_email\": true` property does not apply when updating your own agent profile. A welcome or verification email will be sent regardless of this setting.\n\n#### Allowed For\n\n* Agents\n" }, "response": [ { "id": "58d3b7ec-8879-4061-94ed-2a0980476244", "name": "Created response", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v2/users/:user_id/identities?type[]=twitter", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "users", ":user_id", "identities" ], "query": [ { "description": "Filters results by one or more identity types using the format `?type[]={type}&type[]={type}`", "key": "type[]", "value": "twitter" } ], "variable": [ { "key": "user_id" } ] } }, "status": "Created", "code": 201, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"identity\": {\n \"value\": \"reference #/components/schemas/UserIdentityObject not found in the OpenAPI spec\"\n }\n}", "createdAt": "2026-06-05T15:23:55.000Z", "updatedAt": "2026-06-05T15:23:55.000Z", "uid": "35240-58d3b7ec-8879-4061-94ed-2a0980476244" } ], "createdAt": "2026-06-05T15:23:55.000Z", "updatedAt": "2026-06-05T15:23:55.000Z", "uid": "35240-88279f6d-f5c7-48d9-9cdb-4630ce28f53d" } ], "id": "164c7903-210d-497c-802c-fe3b0edc6339", "createdAt": "2026-06-05T15:23:55.000Z", "updatedAt": "2026-06-05T15:23:55.000Z", "uid": "35240-164c7903-210d-497c-802c-fe3b0edc6339" }, { "name": "merge", "item": [ { "name": "Zendesk Put Api V2 Users User_id Merge", "id": "8e12d95b-8306-4ddc-b650-d58c2a9f6cd2", "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/UserRequest not found in the OpenAPI spec\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/users/:user_id/merge", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "users", ":user_id", "merge" ], "variable": [ { "id": "c0c5d611-8dcd-4a30-bced-e718b4c9a355", "key": "user_id" } ] }, "description": "Merges the end user specified in the path parameter into the existing end user specified in the request body.\n\nAny two end users can be merged with the exception of end users created by sharing agreements.\n\nTo be eligible for merging, the user in the path parameter must be a requester on 10,000 or fewer tickets. Otherwise, the merge will be blocked.\n\nAgents, admins, and users with more than 10,000 requested tickets cannot be merged.\n\nFor more information about how user data is merged, see [Merging a user's duplicate account](https://support.zendesk.com/hc/en-us/articles/4408887695898) in Zendesk help.\n\n#### Allowed For\n\n* Admins or agents with permission to edit end users\n" }, "response": [ { "id": "f579b6f8-88ca-48b6-b54c-ee3123544bc5", "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/UserRequest not found in the OpenAPI spec\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/users/:user_id/merge", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "users", ":user_id", "merge" ], "variable": [ { "key": "user_id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"user\": {\n \"value\": \"reference #/components/schemas/UserObject not found in the OpenAPI spec\"\n }\n}", "createdAt": "2026-06-05T15:23:55.000Z", "updatedAt": "2026-06-05T15:23:55.000Z", "uid": "35240-f579b6f8-88ca-48b6-b54c-ee3123544bc5" } ], "createdAt": "2026-06-05T15:23:55.000Z", "updatedAt": "2026-06-05T15:23:55.000Z", "uid": "35240-8e12d95b-8306-4ddc-b650-d58c2a9f6cd2" } ], "id": "5d19cbae-4609-40c0-94c2-6ad468c1410f", "createdAt": "2026-06-05T15:23:55.000Z", "updatedAt": "2026-06-05T15:23:55.000Z", "uid": "35240-5d19cbae-4609-40c0-94c2-6ad468c1410f" }, { "name": "organization_memberships", "item": [ { "name": "{organization_membership_id}", "item": [ { "name": "make_default", "item": [ { "name": "Zendesk Put Api V2 Users User_id Organization_memberships Organization_membership_id Make_default", "id": "39fe2974-de2a-4c29-9549-cbc0bc79eada", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v2/users/:user_id/organization_memberships/:organization_membership_id/make_default", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "users", ":user_id", "organization_memberships", ":organization_membership_id", "make_default" ], "variable": [ { "id": "cdd726e0-900e-4365-a80d-5e3d1a8ebc10", "key": "user_id" }, { "id": "97e128d3-3f09-4ec1-99d6-fcf9f00d5ba2", "key": "organization_membership_id" } ] }, "description": "Sets the default organization membership of a given user.\n\n#### Allowed for\n\n* Admins\n* Agents when setting the default organization membership for an end user\n" }, "response": [ { "id": "312584cf-4fa3-4d6a-b935-25516de3806f", "name": "Success response", "originalRequest": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v2/users/:user_id/organization_memberships/:organization_membership_id/make_default", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "users", ":user_id", "organization_memberships", ":organization_membership_id", "make_default" ], "variable": [ { "key": "user_id" }, { "key": "organization_membership_id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"organization_memberships\": [\n {\n \"value\": \"reference #/components/schemas/OrganizationMembershipObject not found in the OpenAPI spec\"\n },\n {\n \"value\": \"reference #/components/schemas/OrganizationMembershipObject not found in the OpenAPI spec\"\n }\n ]\n}", "createdAt": "2026-06-05T15:23:55.000Z", "updatedAt": "2026-06-05T15:23:55.000Z", "uid": "35240-312584cf-4fa3-4d6a-b935-25516de3806f" } ], "createdAt": "2026-06-05T15:23:55.000Z", "updatedAt": "2026-06-05T15:23:55.000Z", "uid": "35240-39fe2974-de2a-4c29-9549-cbc0bc79eada" } ], "id": "c20d1116-836d-42e4-be9e-d4612eded4ff", "createdAt": "2026-06-05T15:23:55.000Z", "updatedAt": "2026-06-05T15:23:55.000Z", "uid": "35240-c20d1116-836d-42e4-be9e-d4612eded4ff" } ], "id": "930ca09f-d011-4401-990e-cada49bd192d", "createdAt": "2026-06-05T15:23:55.000Z", "updatedAt": "2026-06-05T15:23:55.000Z", "uid": "35240-930ca09f-d011-4401-990e-cada49bd192d" } ], "id": "3c8a33a4-57b7-48f5-812d-1a8b5113c4a2", "createdAt": "2026-06-05T15:23:55.000Z", "updatedAt": "2026-06-05T15:23:55.000Z", "uid": "35240-3c8a33a4-57b7-48f5-812d-1a8b5113c4a2" }, { "name": "organizations", "item": [ { "name": "{organization_id}", "item": [ { "name": "make_default", "item": [ { "name": "Zendesk Put Api V2 Users User_id Organizations Organization_id Make_default", "id": "ff039508-5b98-43e1-8985-11aa75db847e", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v2/users/:user_id/organizations/:organization_id/make_default", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "users", ":user_id", "organizations", ":organization_id", "make_default" ], "variable": [ { "id": "4b3b31f6-24d0-4b02-a99b-37d8414e9991", "key": "user_id" }, { "id": "23396048-73bf-431e-9078-65e7d4a79549", "key": "organization_id" } ] }, "description": "Sets the default organization membership of a given user.\n\n#### Allowed For\n\n* Agents\n" }, "response": [ { "id": "e92ab9dd-c4fb-432a-9d09-16505c164f1c", "name": "Success response", "originalRequest": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v2/users/:user_id/organizations/:organization_id/make_default", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "users", ":user_id", "organizations", ":organization_id", "make_default" ], "variable": [ { "key": "user_id" }, { "key": "organization_id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"organization_membership\": {\n \"value\": \"reference #/components/schemas/OrganizationMembershipObject not found in the OpenAPI spec\"\n }\n}", "createdAt": "2026-06-05T15:23:55.000Z", "updatedAt": "2026-06-05T15:23:55.000Z", "uid": "35240-e92ab9dd-c4fb-432a-9d09-16505c164f1c" } ], "createdAt": "2026-06-05T15:23:55.000Z", "updatedAt": "2026-06-05T15:23:55.000Z", "uid": "35240-ff039508-5b98-43e1-8985-11aa75db847e" } ], "id": "dc8f6deb-0007-486a-bd32-4d86941e042e", "createdAt": "2026-06-05T15:23:55.000Z", "updatedAt": "2026-06-05T15:23:55.000Z", "uid": "35240-dc8f6deb-0007-486a-bd32-4d86941e042e" }, { "name": "Zendesk Delete Api V2 Users User_id Organizations Organization_id", "id": "f36af051-d6a1-4fc2-b5a8-a40cf6866fa7", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "DELETE", "header": [], "url": { "raw": "{{baseUrl}}/api/v2/users/:user_id/organizations/:organization_id", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "users", ":user_id", "organizations", ":organization_id" ], "variable": [ { "id": "ae398bd5-bf61-4283-bfb1-7aae89743c19", "key": "user_id" }, { "id": "76b76098-a4ee-40ca-9a21-d8ccd10aadde", "key": "organization_id" } ] }, "description": "Immediately removes a user from an organization and schedules a job to unassign all working tickets currently assigned to the user and organization combination. The `organization_id` of the unassigned tickets is set to null.\n\n#### Allowed For\n\n* Agents\n" }, "response": [ { "id": "b7c0fb56-db6e-4e18-9e28-21a21c75f83e", "name": "No Content response", "originalRequest": { "method": "DELETE", "header": [], "url": { "raw": "{{baseUrl}}/api/v2/users/:user_id/organizations/:organization_id", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "users", ":user_id", "organizations", ":organization_id" ], "variable": [ { "key": "user_id" }, { "key": "organization_id" } ] } }, "status": "No Content", "code": 204, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:23:55.000Z", "updatedAt": "2026-06-05T15:23:55.000Z", "uid": "35240-b7c0fb56-db6e-4e18-9e28-21a21c75f83e" } ], "createdAt": "2026-06-05T15:23:55.000Z", "updatedAt": "2026-06-05T15:23:55.000Z", "uid": "35240-f36af051-d6a1-4fc2-b5a8-a40cf6866fa7" } ], "id": "cafc36c5-01ce-4e04-8095-cf6057198566", "createdAt": "2026-06-05T15:23:55.000Z", "updatedAt": "2026-06-05T15:23:55.000Z", "uid": "35240-cafc36c5-01ce-4e04-8095-cf6057198566" } ], "id": "4218f96c-93cb-4ee0-b4f7-4fe75637f278", "createdAt": "2026-06-05T15:23:55.000Z", "updatedAt": "2026-06-05T15:23:55.000Z", "uid": "35240-4218f96c-93cb-4ee0-b4f7-4fe75637f278" }, { "name": "password", "item": [ { "name": "requirements", "item": [ { "name": "Zendesk Get Api V2 Users User_id Password Requirements", "id": "ad4c0031-4bd0-4d09-9790-66f51dfb12d9", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v2/users/:user_id/password/requirements", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "users", ":user_id", "password", "requirements" ], "variable": [ { "id": "f68719cf-e741-4263-80ca-ad353c3d6d00", "key": "user_id" } ] }, "description": "#### Allowed For\n\n* Agents\n* End Users\n" }, "response": [ { "id": "60d48df4-f503-443a-8f54-3a0c19cc451d", "name": "Success response", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v2/users/:user_id/password/requirements", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "users", ":user_id", "password", "requirements" ], "variable": [ { "key": "user_id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"requirements\": [\n \"\",\n \"\"\n ]\n}", "createdAt": "2026-06-05T15:23:55.000Z", "updatedAt": "2026-06-05T15:23:55.000Z", "uid": "35240-60d48df4-f503-443a-8f54-3a0c19cc451d" } ], "createdAt": "2026-06-05T15:23:55.000Z", "updatedAt": "2026-06-05T15:23:55.000Z", "uid": "35240-ad4c0031-4bd0-4d09-9790-66f51dfb12d9" } ], "id": "3b56d466-6bc9-490d-95a0-6b7fcd278bf4", "createdAt": "2026-06-05T15:23:55.000Z", "updatedAt": "2026-06-05T15:23:55.000Z", "uid": "35240-3b56d466-6bc9-490d-95a0-6b7fcd278bf4" }, { "name": "Zendesk Post Api V2 Users User_id Password", "id": "4cf54f5a-94f2-4aee-b42a-f55c343a9903", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v2/users/:user_id/password", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "users", ":user_id", "password" ], "variable": [ { "id": "9027fd14-1c06-4f54-b50f-c384c36c7fd8", "key": "user_id" } ] }, "description": "An admin can set a user's password only if the setting is enabled in Zendesk Support under **Settings** > **Security** > **Global**. The setting is off by default. Only the account owner can access and change this setting.\n\n#### Allowed For\n\n* Admins\n" }, "response": [ { "id": "4e0e011f-bd4d-4497-b77c-e994038017c6", "name": "Success description", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v2/users/:user_id/password", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "users", ":user_id", "password" ], "variable": [ { "key": "user_id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "", "createdAt": "2026-06-05T15:23:55.000Z", "updatedAt": "2026-06-05T15:23:55.000Z", "uid": "35240-4e0e011f-bd4d-4497-b77c-e994038017c6" } ], "createdAt": "2026-06-05T15:23:55.000Z", "updatedAt": "2026-06-05T15:23:55.000Z", "uid": "35240-4cf54f5a-94f2-4aee-b42a-f55c343a9903" }, { "name": "Zendesk Put Api V2 Users User_id Password", "id": "d7cc38a5-a822-43a0-acdf-c2d35a6b6da4", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v2/users/:user_id/password", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "users", ":user_id", "password" ], "variable": [ { "id": "1514e0bb-01e3-4d33-83a9-aae90434b8d0", "key": "user_id" } ] }, "description": "You can only change your own password. Nobody can change the password of another user because it requires knowing the user's existing password. However, an admin can set a new password for another user without knowing the existing password. See [Set a User's Password](#set-a-users-password) above.\n\n#### Allowed For\n\n* Agents\n* End Users\n" }, "response": [ { "id": "6650d473-3d7d-4bec-a8f5-5d8f8ff1f16a", "name": "Success description", "originalRequest": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v2/users/:user_id/password", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "users", ":user_id", "password" ], "variable": [ { "key": "user_id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "", "createdAt": "2026-06-05T15:23:55.000Z", "updatedAt": "2026-06-05T15:23:55.000Z", "uid": "35240-6650d473-3d7d-4bec-a8f5-5d8f8ff1f16a" } ], "createdAt": "2026-06-05T15:23:55.000Z", "updatedAt": "2026-06-05T15:23:55.000Z", "uid": "35240-d7cc38a5-a822-43a0-acdf-c2d35a6b6da4" } ], "id": "2f4d3ad0-d6e9-4667-b01a-f7b585880935", "createdAt": "2026-06-05T15:23:55.000Z", "updatedAt": "2026-06-05T15:23:55.000Z", "uid": "35240-2f4d3ad0-d6e9-4667-b01a-f7b585880935" }, { "name": "related", "item": [ { "name": "Zendesk Get Api V2 Users User_id Related", "id": "588fa93b-60ee-4d2e-8d4e-c3ebd860b39f", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v2/users/:user_id/related", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "users", ":user_id", "related" ], "variable": [ { "id": "17409ab9-3121-4ce3-b199-c0298c414245", "key": "user_id" } ] } }, "response": [ { "id": "fb92f5af-734e-453b-9e9b-33731304c56d", "name": "Success response", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v2/users/:user_id/related", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "users", ":user_id", "related" ], "variable": [ { "key": "user_id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"user_related\": {\n \"value\": \"reference #/components/schemas/UserRelatedObject not found in the OpenAPI spec\"\n }\n}", "createdAt": "2026-06-05T15:23:55.000Z", "updatedAt": "2026-06-05T15:23:55.000Z", "uid": "35240-fb92f5af-734e-453b-9e9b-33731304c56d" } ], "createdAt": "2026-06-05T15:23:55.000Z", "updatedAt": "2026-06-05T15:23:55.000Z", "uid": "35240-588fa93b-60ee-4d2e-8d4e-c3ebd860b39f" } ], "id": "c92a6d2a-c05b-4732-bc20-ce4e69a06744", "createdAt": "2026-06-05T15:23:55.000Z", "updatedAt": "2026-06-05T15:23:55.000Z", "uid": "35240-c92a6d2a-c05b-4732-bc20-ce4e69a06744" }, { "name": "sessions", "item": [ { "name": "{session_id}", "item": [ { "name": "Zendesk Get Api V2 Users User_id Sessions Session_id", "id": "99621d8a-4cea-41e7-a853-2644e7b0bb42", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v2/users/:user_id/sessions/:session_id", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "users", ":user_id", "sessions", ":session_id" ], "variable": [ { "id": "fdfb6108-63ca-429d-8133-6827eb3c33f3", "key": "user_id" }, { "id": "c8b474c6-2ab6-43e6-a4a3-f0c5d958e527", "key": "session_id" } ] }, "description": "#### Allowed For\n\n* Admins, Agents, End users\n" }, "response": [ { "id": "3fd8d30c-29d3-44e0-a547-b18b3d02739a", "name": "Success response", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v2/users/:user_id/sessions/:session_id", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "users", ":user_id", "sessions", ":session_id" ], "variable": [ { "key": "user_id" }, { "key": "session_id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"session\": [\n {\n \"value\": \"reference #/components/schemas/SessionObject not found in the OpenAPI spec\"\n },\n {\n \"value\": \"reference #/components/schemas/SessionObject not found in the OpenAPI spec\"\n }\n ]\n}", "createdAt": "2026-06-05T15:23:55.000Z", "updatedAt": "2026-06-05T15:23:55.000Z", "uid": "35240-3fd8d30c-29d3-44e0-a547-b18b3d02739a" } ], "createdAt": "2026-06-05T15:23:55.000Z", "updatedAt": "2026-06-05T15:23:55.000Z", "uid": "35240-99621d8a-4cea-41e7-a853-2644e7b0bb42" }, { "name": "Zendesk Delete Api V2 Users User_id Sessions Session_id", "id": "9d2eb67a-1964-4cc4-95d6-d39a63006dd7", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "DELETE", "header": [], "url": { "raw": "{{baseUrl}}/api/v2/users/:user_id/sessions/:session_id", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "users", ":user_id", "sessions", ":session_id" ], "variable": [ { "id": "995858c4-0266-463a-882c-24c6e980e481", "key": "user_id" }, { "id": "d22a5354-97d0-4fe8-af7b-6781a18ef47d", "key": "session_id" } ] }, "description": "#### Allowed For\n\n* Admins, Agents, End users\n" }, "response": [ { "id": "7ef67bac-71f6-46cc-8fa4-45aeab186be5", "name": "No Content", "originalRequest": { "method": "DELETE", "header": [], "url": { "raw": "{{baseUrl}}/api/v2/users/:user_id/sessions/:session_id", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "users", ":user_id", "sessions", ":session_id" ], "variable": [ { "key": "user_id" }, { "key": "session_id" } ] } }, "status": "No Content", "code": 204, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:23:55.000Z", "updatedAt": "2026-06-05T15:23:55.000Z", "uid": "35240-7ef67bac-71f6-46cc-8fa4-45aeab186be5" } ], "createdAt": "2026-06-05T15:23:55.000Z", "updatedAt": "2026-06-05T15:23:55.000Z", "uid": "35240-9d2eb67a-1964-4cc4-95d6-d39a63006dd7" } ], "id": "9bd13efe-67d5-4161-88de-0d728b7711c4", "createdAt": "2026-06-05T15:23:55.000Z", "updatedAt": "2026-06-05T15:23:55.000Z", "uid": "35240-9bd13efe-67d5-4161-88de-0d728b7711c4" }, { "name": "Zendesk Delete Api V2 Users User_id Sessions", "id": "faecece1-309e-4059-8702-1fa45d93cab8", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "DELETE", "header": [], "url": { "raw": "{{baseUrl}}/api/v2/users/:user_id/sessions", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "users", ":user_id", "sessions" ], "variable": [ { "id": "2151e7ec-2984-477d-adac-77d333a5931c", "key": "user_id" } ] }, "description": "Deletes all the sessions for a user.\n\n#### Allowed For\n\n* Admins, Agents, End users\n" }, "response": [ { "id": "d37bf026-0cc4-439c-8d92-fe2e849e6289", "name": "No Content", "originalRequest": { "method": "DELETE", "header": [], "url": { "raw": "{{baseUrl}}/api/v2/users/:user_id/sessions", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "users", ":user_id", "sessions" ], "variable": [ { "key": "user_id" } ] } }, "status": "No Content", "code": 204, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:23:55.000Z", "updatedAt": "2026-06-05T15:23:55.000Z", "uid": "35240-d37bf026-0cc4-439c-8d92-fe2e849e6289" } ], "createdAt": "2026-06-05T15:23:55.000Z", "updatedAt": "2026-06-05T15:23:55.000Z", "uid": "35240-faecece1-309e-4059-8702-1fa45d93cab8" } ], "id": "55c9630b-3835-443e-93af-e0d4aac21b65", "createdAt": "2026-06-05T15:23:55.000Z", "updatedAt": "2026-06-05T15:23:55.000Z", "uid": "35240-55c9630b-3835-443e-93af-e0d4aac21b65" }, { "name": "skips", "item": [ { "name": "Zendesk Get Api V2 Users User_id Skips", "id": "ace7c56b-c410-4934-b7a3-1e80b2a4b850", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v2/users/:user_id/skips", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "users", ":user_id", "skips" ], "variable": [ { "id": "1e373c92-0d92-4982-9805-069bf49ee021", "key": "user_id" } ] }, "description": "Archived tickets are not included in the response. See\n[About archived tickets](https://support.zendesk.com/hc/en-us/articles/203657756) in\nthe Support Help Center.\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* Agents with \"View only\" or higher reports permissions in Support.\n These permissions are distinct from Explore permissions.\n* Agents retrieving their own skips\n" }, "response": [ { "id": "7333d971-b3a8-4c17-8983-e17601bfb825", "name": "Success response", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v2/users/:user_id/skips", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "users", ":user_id", "skips" ], "variable": [ { "key": "user_id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"skips\": [\n {\n \"value\": \"reference #/components/schemas/TicketSkipObject not found in the OpenAPI spec\"\n },\n {\n \"value\": \"reference #/components/schemas/TicketSkipObject not found in the OpenAPI spec\"\n }\n ]\n}", "createdAt": "2026-06-05T15:23:55.000Z", "updatedAt": "2026-06-05T15:23:55.000Z", "uid": "35240-7333d971-b3a8-4c17-8983-e17601bfb825" } ], "createdAt": "2026-06-05T15:23:55.000Z", "updatedAt": "2026-06-05T15:23:55.000Z", "uid": "35240-ace7c56b-c410-4934-b7a3-1e80b2a4b850" } ], "id": "a502be32-afcd-4fc2-83eb-13c13e798408", "createdAt": "2026-06-05T15:23:55.000Z", "updatedAt": "2026-06-05T15:23:55.000Z", "uid": "35240-a502be32-afcd-4fc2-83eb-13c13e798408" }, { "name": "Zendesk Get Api V2 Users User_id", "id": "e9f8504d-fa85-4bb2-9b31-49be2d041e4a", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v2/users/:user_id", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "users", ":user_id" ], "variable": [ { "id": "710f6fb4-e608-4eb4-9173-fa7579893ef6", "key": "user_id" } ] }, "description": "#### Allowed For\n\n* Agents\n" }, "response": [ { "id": "f1cee75c-69e2-49e4-b4ae-a5dea82870de", "name": "Success response", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v2/users/:user_id", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "users", ":user_id" ], "variable": [ { "key": "user_id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"user\": {\n \"value\": \"reference #/components/schemas/UserObject not found in the OpenAPI spec\"\n }\n}", "createdAt": "2026-06-05T15:23:55.000Z", "updatedAt": "2026-06-05T15:23:55.000Z", "uid": "35240-f1cee75c-69e2-49e4-b4ae-a5dea82870de" } ], "createdAt": "2026-06-05T15:23:55.000Z", "updatedAt": "2026-06-05T15:23:55.000Z", "uid": "35240-e9f8504d-fa85-4bb2-9b31-49be2d041e4a" }, { "name": "Zendesk Put Api V2 Users User_id", "id": "01f54986-e1b2-4261-a462-5b749ffccb11", "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/UserRequest not found in the OpenAPI spec\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/users/:user_id", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "users", ":user_id" ], "variable": [ { "id": "1158c00a-72b1-4494-8daa-6c2cf9042e42", "key": "user_id" } ] } }, "response": [ { "id": "ac6381da-7d69-44cb-bb4c-c6665f793cc0", "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/UserRequest not found in the OpenAPI spec\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/users/:user_id", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "users", ":user_id" ], "variable": [ { "key": "user_id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"user\": {\n \"value\": \"reference #/components/schemas/UserObject not found in the OpenAPI spec\"\n }\n}", "createdAt": "2026-06-05T15:23:55.000Z", "updatedAt": "2026-06-05T15:23:55.000Z", "uid": "35240-ac6381da-7d69-44cb-bb4c-c6665f793cc0" } ], "createdAt": "2026-06-05T15:23:55.000Z", "updatedAt": "2026-06-05T15:23:55.000Z", "uid": "35240-01f54986-e1b2-4261-a462-5b749ffccb11" }, { "name": "Zendesk Delete Api V2 Users User_id", "id": "0a4376a6-9473-4b6e-b0c3-a1eb8c3981ed", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v2/users/:user_id", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "users", ":user_id" ], "variable": [ { "id": "ef186949-b1dd-46d7-aef5-43ebd9a8852d", "key": "user_id" } ] }, "description": "Deletes the user and associated records from the account.\n\n**Warning**:\n\n* Deleted users are not recoverable.\n* Both agents and administrators can soft delete users in the agent interface in Zendesk Support. Agents with permission can delete end users, while administrators can delete all users except the account owner.\n\nTo comply with GDPR, a further step is needed. See [Permanently Delete User](/api-reference/ticketing/users/users/#permanently-delete-user).\n\n#### Allowed For\n\n* Admins and [agents in custom roles with permission](https://support.zendesk.com/hc/en-us/articles/4408882153882#topic_cxn_hig_bd) to manage end users or team members\n" }, "response": [ { "id": "13a34900-a7a2-423f-9a01-fb98cce6e411", "name": "Success response", "originalRequest": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v2/users/:user_id", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "users", ":user_id" ], "variable": [ { "key": "user_id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"user\": {\n \"value\": \"reference #/components/schemas/UserObject not found in the OpenAPI spec\"\n }\n}", "createdAt": "2026-06-05T15:23:55.000Z", "updatedAt": "2026-06-05T15:23:55.000Z", "uid": "35240-13a34900-a7a2-423f-9a01-fb98cce6e411" } ], "createdAt": "2026-06-05T15:23:55.000Z", "updatedAt": "2026-06-05T15:23:55.000Z", "uid": "35240-0a4376a6-9473-4b6e-b0c3-a1eb8c3981ed" } ], "id": "cc8be09a-ed34-4552-9485-911e8a115215", "createdAt": "2026-06-05T15:23:55.000Z", "updatedAt": "2026-06-05T15:23:55.000Z", "uid": "35240-cc8be09a-ed34-4552-9485-911e8a115215" }, { "name": "autocomplete", "item": [ { "name": "Zendesk Get Api V2 Users Autocomplete", "id": "11febe3c-b375-443e-a1c0-cdff1f7cf43e", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v2/users/autocomplete?name=", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "users", "autocomplete" ], "query": [ { "description": "(Required) The name to search for the user.\n", "key": "name", "value": "" } ] }, "description": "Returns an array of users whose name starts with the value specified in the `name` parameter.\nIt only returns users with no foreign identities.\n\n#### Allowed For\n\n* Agents\n" }, "response": [ { "id": "37c8883d-2515-497e-b0f9-54fdf8c4c053", "name": "Success response", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v2/users/autocomplete?name=", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "users", "autocomplete" ], "query": [ { "description": "(Required) The name to search for the user.\n", "key": "name", "value": "" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"users\": [\n {\n \"value\": \"reference #/components/schemas/UserObject not found in the OpenAPI spec\"\n },\n {\n \"value\": \"reference #/components/schemas/UserObject not found in the OpenAPI spec\"\n }\n ]\n}", "createdAt": "2026-06-05T15:23:55.000Z", "updatedAt": "2026-06-05T15:23:55.000Z", "uid": "35240-37c8883d-2515-497e-b0f9-54fdf8c4c053" } ], "createdAt": "2026-06-05T15:23:55.000Z", "updatedAt": "2026-06-05T15:23:55.000Z", "uid": "35240-11febe3c-b375-443e-a1c0-cdff1f7cf43e" } ], "id": "7676e4b0-7f12-4119-ab11-994e2e9c0b4f", "createdAt": "2026-06-05T15:23:55.000Z", "updatedAt": "2026-06-05T15:23:55.000Z", "uid": "35240-7676e4b0-7f12-4119-ab11-994e2e9c0b4f" }, { "name": "count", "item": [ { "name": "Zendesk Get Api V2 Users Count", "id": "3582c22d-d365-45d0-8e14-a08104391e58", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v2/users/count", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "users", "count" ] }, "description": "Returns an approximate count of users. If the count exceeds 100,000, it is updated every 24 hours.\n\nThe response includes a `refreshed_at` property in a `count` object that contains a timestamp indicating when the count was last updated.\n\n**Note**: When the count exceeds 100,000, the `refreshed_at` property may occasionally be null.\nThis indicates that the count is being updated in the background. The `count` object's `value` property is limited to 100,000 until the update is complete.\n\n#### Allowed For\n\n* Admins, Agents and Light Agents\n" }, "response": [ { "id": "5173cf1a-ac83-4401-8290-055200bcf2d1", "name": "Success response", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v2/users/count", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "users", "count" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"count\": {\n \"refreshed_at\": \"\",\n \"value\": \"\"\n }\n}", "createdAt": "2026-06-05T15:23:55.000Z", "updatedAt": "2026-06-05T15:23:55.000Z", "uid": "35240-5173cf1a-ac83-4401-8290-055200bcf2d1" } ], "createdAt": "2026-06-05T15:23:55.000Z", "updatedAt": "2026-06-05T15:23:55.000Z", "uid": "35240-3582c22d-d365-45d0-8e14-a08104391e58" } ], "id": "bbaabe57-4b64-478b-8367-7bb94ede6c39", "createdAt": "2026-06-05T15:23:55.000Z", "updatedAt": "2026-06-05T15:23:55.000Z", "uid": "35240-bbaabe57-4b64-478b-8367-7bb94ede6c39" }, { "name": "create_many", "item": [ { "name": "Zendesk Post Api V2 Users Create_many", "id": "3785fae7-03c8-466f-baa1-93a05d66316c", "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/UsersRequest not found in the OpenAPI spec\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/users/create_many", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "users", "create_many" ] }, "description": "Accepts an array of up to 100 user objects.\n\n**Note**: To protect the data in your Zendesk account, bulk user imports are not enabled by default in Zendesk accounts. The account owner must contact [Zendesk Customer Support](https://support.zendesk.com/hc/en-us/articles/4408843597850) to enable the imports. A 403 Forbidden\nerror is returned if data imports are not enabled.\n\n#### Allowed For\n\n* Admins and [agents in custom roles with permission](https://support.zendesk.com/hc/en-us/articles/4408882153882#topic_cxn_hig_bd) to manage end users or team members\n\n#### Specifying an organization\n\nYou can assign a user to an existing organization by setting an\n`organization_id` property in the user object.\n\n#### Response\n\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": "3919615f-6eac-455d-84cd-dc33f3928142", "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/UsersRequest not found in the OpenAPI spec\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/users/create_many", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "users", "create_many" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"job_status\": {\n \"value\": \"reference #/components/schemas/JobStatusObject not found in the OpenAPI spec\"\n }\n}", "createdAt": "2026-06-05T15:23:55.000Z", "updatedAt": "2026-06-05T15:23:55.000Z", "uid": "35240-3919615f-6eac-455d-84cd-dc33f3928142" } ], "createdAt": "2026-06-05T15:23:55.000Z", "updatedAt": "2026-06-05T15:23:55.000Z", "uid": "35240-3785fae7-03c8-466f-baa1-93a05d66316c" } ], "id": "d4c56b39-461e-4fae-b903-07324ac5932e", "createdAt": "2026-06-05T15:23:55.000Z", "updatedAt": "2026-06-05T15:23:55.000Z", "uid": "35240-d4c56b39-461e-4fae-b903-07324ac5932e" }, { "name": "create_or_update", "item": [ { "name": "Zendesk Post Api V2 Users Create_or_update", "id": "97c740a7-deb9-4a9e-9425-425f3c6c3e52", "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/UserRequest not found in the OpenAPI spec\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/users/create_or_update", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "users", "create_or_update" ] }, "description": "Creates a user if the user does not already exist, or updates an existing user\nidentified by e-mail address or external ID.\n\nIf you don't specify a role parameter, the new user is assigned the role of end user.\n\nIf you need to create users without sending out a verification email, include a `\"skip_verify_email\": true` property in the body.\n\n#### External ID Case Sensitivity\n\nWhen providing an external id to identify an existing user to update, the search for the user record is not case sensitive.\n\nHowever, if an existing user is found, the system will update the user's external id to match the case of the external id used to find the user.\n\n#### Response Status Code\n\n- If the user exists in Zendesk, a successful request returns a 200 status code with \"Location: /api/v2/users/{user_id}.json\".\n- If the user does not exist in Zendesk, a successful request returns a 201 status code with \"Location: /api/v2/users/{new_user_id}.json\".\n\n#### Allowed For\n\n* Admins and [agents in custom roles with permission](https://support.zendesk.com/hc/en-us/articles/4408882153882#topic_cxn_hig_bd) to manage end users or team members\n" }, "response": [ { "id": "89db4612-1b20-4a72-82f2-107ea889f8e3", "name": "Successful response, when user exits", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"value\": \"reference #/components/schemas/UserRequest not found in the OpenAPI spec\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/users/create_or_update", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "users", "create_or_update" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"user\": {\n \"value\": \"reference #/components/schemas/UserObject not found in the OpenAPI spec\"\n }\n}", "createdAt": "2026-06-05T15:23:55.000Z", "updatedAt": "2026-06-05T15:23:55.000Z", "uid": "35240-89db4612-1b20-4a72-82f2-107ea889f8e3" }, { "id": "183f5441-5cfd-4a50-87ce-a6f7c575d8a1", "name": "Created response, when user is new", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"value\": \"reference #/components/schemas/UserRequest not found in the OpenAPI spec\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/users/create_or_update", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "users", "create_or_update" ] } }, "status": "Created", "code": 201, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"user\": {\n \"value\": \"reference #/components/schemas/UserObject not found in the OpenAPI spec\"\n }\n}", "createdAt": "2026-06-05T15:23:55.000Z", "updatedAt": "2026-06-05T15:23:55.000Z", "uid": "35240-183f5441-5cfd-4a50-87ce-a6f7c575d8a1" } ], "createdAt": "2026-06-05T15:23:55.000Z", "updatedAt": "2026-06-05T15:23:55.000Z", "uid": "35240-97c740a7-deb9-4a9e-9425-425f3c6c3e52" } ], "id": "c316788a-d8ea-4da8-98f9-d4f71c63c83c", "createdAt": "2026-06-05T15:23:55.000Z", "updatedAt": "2026-06-05T15:23:55.000Z", "uid": "35240-c316788a-d8ea-4da8-98f9-d4f71c63c83c" }, { "name": "create_or_update_many", "item": [ { "name": "Zendesk Post Api V2 Users Create_or_update_many", "id": "335fdb4b-b515-459d-9922-b9f1874c2fba", "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/UsersRequest not found in the OpenAPI spec\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/users/create_or_update_many", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "users", "create_or_update_many" ] }, "description": "Accepts an array of up to 100 user objects. For each user, the user is created if it does not\nalready exist, or the existing user is updated.\n\n**Note**: To protect the data in your Zendesk account, bulk user imports are not enabled by default in Zendesk accounts. The account owner must contact [Zendesk Customer Support](https://support.zendesk.com/hc/en-us/articles/4408843597850) to enable the imports. A 403 Forbidden\nerror is returned if data imports are not enabled. \n\nEach individual user object can identify an existing user by `email` or by `external_id`.\n\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\n#### Allowed For\n\n* Admins and [agents in custom roles with permission](https://support.zendesk.com/hc/en-us/articles/4408882153882#topic_cxn_hig_bd) to manage end users or team members\n" }, "response": [ { "id": "3cd4d8d0-c724-42c4-b1b1-19b686a6ff17", "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/UsersRequest not found in the OpenAPI spec\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/users/create_or_update_many", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "users", "create_or_update_many" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"job_status\": {\n \"value\": \"reference #/components/schemas/JobStatusObject not found in the OpenAPI spec\"\n }\n}", "createdAt": "2026-06-05T15:23:55.000Z", "updatedAt": "2026-06-05T15:23:55.000Z", "uid": "35240-3cd4d8d0-c724-42c4-b1b1-19b686a6ff17" } ], "createdAt": "2026-06-05T15:23:55.000Z", "updatedAt": "2026-06-05T15:23:55.000Z", "uid": "35240-335fdb4b-b515-459d-9922-b9f1874c2fba" } ], "id": "f2e19355-be09-45c6-870e-ba403297cb7d", "createdAt": "2026-06-05T15:23:55.000Z", "updatedAt": "2026-06-05T15:23:55.000Z", "uid": "35240-f2e19355-be09-45c6-870e-ba403297cb7d" }, { "name": "destroy_many", "item": [ { "name": "Zendesk Delete Api V2 Users Destroy_many", "id": "d5055e9c-144a-4a17-8d32-bbb6509192a0", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v2/users/destroy_many?ids=&external_ids=", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "users", "destroy_many" ], "query": [ { "description": "Id of the users to delete. Comma separated", "key": "ids", "value": "" }, { "description": "External Id of the users to delete. Comma separated", "key": "external_ids", "value": "" } ] }, "description": "Accepts a comma-separated list of up to 100 user ids.\n\nThe request takes an `ids` or an `external_ids` query parameter.\n\n#### Allowed for\n\n- Admins\n\n#### Response\n\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": "031e8b42-5e1d-457b-a1f1-8f2bc8e7a03f", "name": "Success response", "originalRequest": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v2/users/destroy_many?ids=&external_ids=", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "users", "destroy_many" ], "query": [ { "description": "Id of the users to delete. Comma separated", "key": "ids", "value": "" }, { "description": "External Id of the users to delete. Comma separated", "key": "external_ids", "value": "" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"job_status\": {\n \"value\": \"reference #/components/schemas/JobStatusObject not found in the OpenAPI spec\"\n }\n}", "createdAt": "2026-06-05T15:23:55.000Z", "updatedAt": "2026-06-05T15:23:55.000Z", "uid": "35240-031e8b42-5e1d-457b-a1f1-8f2bc8e7a03f" } ], "createdAt": "2026-06-05T15:23:55.000Z", "updatedAt": "2026-06-05T15:23:55.000Z", "uid": "35240-d5055e9c-144a-4a17-8d32-bbb6509192a0" } ], "id": "80afe553-252c-43eb-a382-501d476cbbb7", "createdAt": "2026-06-05T15:23:55.000Z", "updatedAt": "2026-06-05T15:23:55.000Z", "uid": "35240-80afe553-252c-43eb-a382-501d476cbbb7" }, { "name": "logout_many", "item": [ { "name": "Zendesk Post Api V2 Users Logout_many", "id": "4d4ffdc3-db63-4435-a41b-35351ecfc49d", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v2/users/logout_many?ids=", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "users", "logout_many" ], "query": [ { "description": "Accepts a comma-separated list of up to 100 user ids.\n", "key": "ids", "value": "" } ] }, "description": "Accepts a comma-separated list of up to 100 user ids.\n\n#### Allowed For:\n\n* Admins\n" }, "response": [ { "id": "5be54454-8be2-4ad4-b28c-d71d2aae6b40", "name": "Accepted response", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v2/users/logout_many?ids=", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "users", "logout_many" ], "query": [ { "description": "Accepts a comma-separated list of up to 100 user ids.\n", "key": "ids", "value": "" } ] } }, "status": "Accepted", "code": 202, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "", "createdAt": "2026-06-05T15:23:55.000Z", "updatedAt": "2026-06-05T15:23:55.000Z", "uid": "35240-5be54454-8be2-4ad4-b28c-d71d2aae6b40" } ], "createdAt": "2026-06-05T15:23:55.000Z", "updatedAt": "2026-06-05T15:23:55.000Z", "uid": "35240-4d4ffdc3-db63-4435-a41b-35351ecfc49d" } ], "id": "520e10ec-ebb3-48a3-aa98-edbc18815e56", "createdAt": "2026-06-05T15:23:55.000Z", "updatedAt": "2026-06-05T15:23:55.000Z", "uid": "35240-520e10ec-ebb3-48a3-aa98-edbc18815e56" }, { "name": "me", "item": [ { "name": "logout", "item": [ { "name": "Zendesk Delete Api V2 Users Me Logout", "id": "f3411059-764b-443b-89dd-1f22a8238029", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "DELETE", "header": [], "url": { "raw": "{{baseUrl}}/api/v2/users/me/logout", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "users", "me", "logout" ] }, "description": "Deletes the current session. In practice, this only works when using session auth for requests, such as client-side requests\nmade from a Zendesk app. When using OAuth or basic authentication, you don't have a current session so this endpoint has no effect.\n\n#### Allowed For\n\n* Admins, Agents, End users\n" }, "response": [ { "id": "2e5e3578-ffd4-48dc-8527-df32e1dee4ea", "name": "No Content", "originalRequest": { "method": "DELETE", "header": [], "url": { "raw": "{{baseUrl}}/api/v2/users/me/logout", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "users", "me", "logout" ] } }, "status": "No Content", "code": 204, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:23:55.000Z", "updatedAt": "2026-06-05T15:23:55.000Z", "uid": "35240-2e5e3578-ffd4-48dc-8527-df32e1dee4ea" } ], "createdAt": "2026-06-05T15:23:55.000Z", "updatedAt": "2026-06-05T15:23:55.000Z", "uid": "35240-f3411059-764b-443b-89dd-1f22a8238029" } ], "id": "05581ea2-f588-4c59-b0ce-b4ca22aa2eeb", "createdAt": "2026-06-05T15:23:55.000Z", "updatedAt": "2026-06-05T15:23:55.000Z", "uid": "35240-05581ea2-f588-4c59-b0ce-b4ca22aa2eeb" }, { "name": "session", "item": [ { "name": "renew", "item": [ { "name": "Zendesk Get Api V2 Users Me Session Renew", "id": "cadeec6c-27ba-4d4f-b029-aca2e90a05a0", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v2/users/me/session/renew", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "users", "me", "session", "renew" ] }, "description": "#### Allowed For\n\n* Admins, Agents, End users\n" }, "response": [ { "id": "57339736-f7ea-4c13-b2ef-469962d46e77", "name": "Success response", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v2/users/me/session/renew", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "users", "me", "session", "renew" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"authenticity_token\": \"\"\n}", "createdAt": "2026-06-05T15:23:55.000Z", "updatedAt": "2026-06-05T15:23:55.000Z", "uid": "35240-57339736-f7ea-4c13-b2ef-469962d46e77" } ], "createdAt": "2026-06-05T15:23:55.000Z", "updatedAt": "2026-06-05T15:23:55.000Z", "uid": "35240-cadeec6c-27ba-4d4f-b029-aca2e90a05a0" } ], "id": "92a22fb3-22ea-4dea-82a3-ace01791fbb7", "createdAt": "2026-06-05T15:23:55.000Z", "updatedAt": "2026-06-05T15:23:55.000Z", "uid": "35240-92a22fb3-22ea-4dea-82a3-ace01791fbb7" }, { "name": "Zendesk Get Api V2 Users Me Session", "id": "890ba0ae-aee6-448c-a539-fa5bf1ca1d38", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v2/users/me/session", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "users", "me", "session" ] }, "description": "#### Allowed For\n\n* Admins, Agents, End users\n" }, "response": [ { "id": "9e46561f-5eb8-44b6-b898-757b32ebbb22", "name": "Success response", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v2/users/me/session", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "users", "me", "session" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"session\": [\n {\n \"value\": \"reference #/components/schemas/SessionObject not found in the OpenAPI spec\"\n },\n {\n \"value\": \"reference #/components/schemas/SessionObject not found in the OpenAPI spec\"\n }\n ]\n}", "createdAt": "2026-06-05T15:23:55.000Z", "updatedAt": "2026-06-05T15:23:55.000Z", "uid": "35240-9e46561f-5eb8-44b6-b898-757b32ebbb22" } ], "createdAt": "2026-06-05T15:23:55.000Z", "updatedAt": "2026-06-05T15:23:55.000Z", "uid": "35240-890ba0ae-aee6-448c-a539-fa5bf1ca1d38" } ], "id": "92413ec5-4ed2-43f8-8c54-a1b11abd5ce8", "createdAt": "2026-06-05T15:23:55.000Z", "updatedAt": "2026-06-05T15:23:55.000Z", "uid": "35240-92413ec5-4ed2-43f8-8c54-a1b11abd5ce8" }, { "name": "Zendesk Get Api V2 Users Me", "id": "e04bb317-985e-4926-971c-d018646fa3af", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v2/users/me", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "users", "me" ] }, "description": "The endpoint returns [user information](/api-reference/ticketing/users/users/) and an `authenticity_token`. \n\n#### Allowed For\n\n* Anonymous users\n\n#### Authenticity Token\n\nZendesk API calls made by end users from a Zendesk help center must include `authenticity_token` in the `X-CSRF-Token` HTTP header. This helps prevent [cross-site request forgery (CSRF)](https://en.wikipedia.org/wiki/Cross-site_request_forgery) attacks.\n\nFor an example using an authenticity token, see the AJAX request in the [Upgrading from Templating API v1](https://developer.zendesk.com/documentation/help_center/help-center-templates/v1#jquery) documentation.\n" }, "response": [ { "id": "17e15c42-ffb1-40d7-8934-3d76ff1fa526", "name": "Success response", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v2/users/me", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "users", "me" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"user\": {\n \"authenticity_token\": \"\"\n }\n}", "createdAt": "2026-06-05T15:23:55.000Z", "updatedAt": "2026-06-05T15:23:55.000Z", "uid": "35240-17e15c42-ffb1-40d7-8934-3d76ff1fa526" } ], "createdAt": "2026-06-05T15:23:55.000Z", "updatedAt": "2026-06-05T15:23:55.000Z", "uid": "35240-e04bb317-985e-4926-971c-d018646fa3af" } ], "id": "8f29504a-70c6-478f-aa1b-e87e53d6f522", "createdAt": "2026-06-05T15:23:55.000Z", "updatedAt": "2026-06-05T15:23:55.000Z", "uid": "35240-8f29504a-70c6-478f-aa1b-e87e53d6f522" }, { "name": "request_create", "item": [ { "name": "Zendesk Post Api V2 Users Request_create", "id": "01055bf4-f796-4058-9c44-5fd8ae853f41", "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/UserRequest not found in the OpenAPI spec\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/users/request_create", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "users", "request_create" ] }, "description": "Sends the owner a reminder email to update their subscription so more agents can be created.\n\n#### Allowed For\n\n* Agents\n" }, "response": [ { "id": "3223fdc0-19f4-4a5b-9683-b1de776fb7ef", "name": "description", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"value\": \"reference #/components/schemas/UserRequest not found in the OpenAPI spec\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/users/request_create", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "users", "request_create" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "", "createdAt": "2026-06-05T15:23:55.000Z", "updatedAt": "2026-06-05T15:23:55.000Z", "uid": "35240-3223fdc0-19f4-4a5b-9683-b1de776fb7ef" } ], "createdAt": "2026-06-05T15:23:55.000Z", "updatedAt": "2026-06-05T15:23:55.000Z", "uid": "35240-01055bf4-f796-4058-9c44-5fd8ae853f41" } ], "id": "5612aa55-1f07-48a2-a058-5954910e8012", "createdAt": "2026-06-05T15:23:55.000Z", "updatedAt": "2026-06-05T15:23:55.000Z", "uid": "35240-5612aa55-1f07-48a2-a058-5954910e8012" }, { "name": "search", "item": [ { "name": "Zendesk Get Api V2 Users Search", "id": "45e6730c-a29d-45db-8c3f-d9ffd057568e", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v2/users/search?query=&external_id=", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "users", "search" ], "query": [ { "description": "The `query` parameter supports the Zendesk search syntax for more advanced\nuser searches. It can specify a partial or full value of any\nuser property, including name, email address, notes, or phone. Example:\n`query=\"jdoe\"`.\nSee the [Search API](/api-reference/ticketing/ticket-management/search/).\n", "key": "query", "value": "" }, { "description": "The `external_id` parameter does not support the search syntax. It only accepts ids.\n", "key": "external_id", "value": "" } ] }, "description": "Returns an array of users who meet the search criteria.\n\nReturns up to 100 records per page to a maximum of 10,000 records per query. See [Using offset pagination](/api-reference/introduction/pagination/#using-offset-pagination).\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" }, "response": [ { "id": "a7b38703-6c02-4214-9d07-ce1be422f550", "name": "Success response", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v2/users/search?query=&external_id=", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "users", "search" ], "query": [ { "description": "The `query` parameter supports the Zendesk search syntax for more advanced\nuser searches. It can specify a partial or full value of any\nuser property, including name, email address, notes, or phone. Example:\n`query=\"jdoe\"`.\nSee the [Search API](/api-reference/ticketing/ticket-management/search/).\n", "key": "query", "value": "" }, { "description": "The `external_id` parameter does not support the search syntax. It only accepts ids.\n", "key": "external_id", "value": "" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"users\": [\n {\n \"value\": \"reference #/components/schemas/UserObject not found in the OpenAPI spec\"\n },\n {\n \"value\": \"reference #/components/schemas/UserObject not found in the OpenAPI spec\"\n }\n ]\n}", "createdAt": "2026-06-05T15:23:55.000Z", "updatedAt": "2026-06-05T15:23:55.000Z", "uid": "35240-a7b38703-6c02-4214-9d07-ce1be422f550" } ], "createdAt": "2026-06-05T15:23:55.000Z", "updatedAt": "2026-06-05T15:23:55.000Z", "uid": "35240-45e6730c-a29d-45db-8c3f-d9ffd057568e" } ], "id": "b432dd4c-2391-459b-b15f-e46f5d19ddf4", "createdAt": "2026-06-05T15:23:55.000Z", "updatedAt": "2026-06-05T15:23:55.000Z", "uid": "35240-b432dd4c-2391-459b-b15f-e46f5d19ddf4" }, { "name": "show_many", "item": [ { "name": "Zendesk Get Api V2 Users Show_many", "id": "e7546f60-52ff-4a81-b50b-6192b437280a", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v2/users/show_many?ids=&external_ids=", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "users", "show_many" ], "query": [ { "description": "Accepts a comma-separated list of up to 100 user ids.\n", "key": "ids", "value": "" }, { "description": "Accepts a comma-separated list of up to 100 external ids.\n", "key": "external_ids", "value": "" } ] }, "description": "Accepts a comma-separated list of up to 100 user ids or external ids.\n\n#### Allowed For:\n\n* Agents\n" }, "response": [ { "id": "53f52171-fcad-4a2e-a1c9-0de02865778c", "name": "Success response", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v2/users/show_many?ids=&external_ids=", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "users", "show_many" ], "query": [ { "description": "Accepts a comma-separated list of up to 100 user ids.\n", "key": "ids", "value": "" }, { "description": "Accepts a comma-separated list of up to 100 external ids.\n", "key": "external_ids", "value": "" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"users\": [\n {\n \"value\": \"reference #/components/schemas/UserObject not found in the OpenAPI spec\"\n },\n {\n \"value\": \"reference #/components/schemas/UserObject not found in the OpenAPI spec\"\n }\n ]\n}", "createdAt": "2026-06-05T15:23:55.000Z", "updatedAt": "2026-06-05T15:23:55.000Z", "uid": "35240-53f52171-fcad-4a2e-a1c9-0de02865778c" } ], "createdAt": "2026-06-05T15:23:55.000Z", "updatedAt": "2026-06-05T15:23:55.000Z", "uid": "35240-e7546f60-52ff-4a81-b50b-6192b437280a" } ], "id": "7cc04213-5f14-4c13-b513-7357d6bfc6b8", "createdAt": "2026-06-05T15:23:55.000Z", "updatedAt": "2026-06-05T15:23:55.000Z", "uid": "35240-7cc04213-5f14-4c13-b513-7357d6bfc6b8" }, { "name": "update_many", "item": [ { "name": "Zendesk Put Api V2 Users Update_many", "id": "81cfd75d-4951-4d80-8e18-b189e5128aef", "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/UserRequest not found in the OpenAPI spec\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/users/update_many?ids=&external_ids=", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "users", "update_many" ], "query": [ { "description": "Id of the users to update. Comma separated", "key": "ids", "value": "" }, { "description": "External Id of the users to update. Comma separated", "key": "external_ids", "value": "" } ] } }, "response": [ { "id": "631f29be-5b6c-4d04-87c9-b59ba56296dc", "name": "Successful 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/UserRequest not found in the OpenAPI spec\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/users/update_many?ids=&external_ids=", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "users", "update_many" ], "query": [ { "description": "Id of the users to update. Comma separated", "key": "ids", "value": "" }, { "description": "External Id of the users to update. Comma separated", "key": "external_ids", "value": "" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"job_status\": {\n \"value\": \"reference #/components/schemas/JobStatusObject not found in the OpenAPI spec\"\n }\n}", "createdAt": "2026-06-05T15:23:55.000Z", "updatedAt": "2026-06-05T15:23:55.000Z", "uid": "35240-631f29be-5b6c-4d04-87c9-b59ba56296dc" } ], "createdAt": "2026-06-05T15:23:55.000Z", "updatedAt": "2026-06-05T15:23:55.000Z", "uid": "35240-81cfd75d-4951-4d80-8e18-b189e5128aef" } ], "id": "bbb167fd-6f62-4195-b875-e1b514252117", "createdAt": "2026-06-05T15:23:55.000Z", "updatedAt": "2026-06-05T15:23:55.000Z", "uid": "35240-bbb167fd-6f62-4195-b875-e1b514252117" }, { "name": "Zendesk Get Api V2 Users", "id": "39e98d03-0a1d-466e-8f3a-9d79a216437a", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v2/users", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "users" ] }, "description": "#### 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* Admins, Agents and Light Agents\n" }, "response": [ { "id": "b307a04b-f6eb-4283-aa6f-1c4cc2c4723b", "name": "Success response", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v2/users", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "users" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"users\": [\n {\n \"value\": \"reference #/components/schemas/UserObject not found in the OpenAPI spec\"\n },\n {\n \"value\": \"reference #/components/schemas/UserObject not found in the OpenAPI spec\"\n }\n ]\n}", "createdAt": "2026-06-05T15:23:55.000Z", "updatedAt": "2026-06-05T15:23:55.000Z", "uid": "35240-b307a04b-f6eb-4283-aa6f-1c4cc2c4723b" } ], "createdAt": "2026-06-05T15:23:55.000Z", "updatedAt": "2026-06-05T15:23:55.000Z", "uid": "35240-39e98d03-0a1d-466e-8f3a-9d79a216437a" }, { "name": "Zendesk Post Api V2 Users", "id": "4a667947-5205-42ea-a07d-f83fd34e42e5", "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/UserRequest not found in the OpenAPI spec\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/users", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "users" ] } }, "response": [ { "id": "3a229468-a1b2-4363-9718-9d02f0bd1135", "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/UserRequest not found in the OpenAPI spec\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/users", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "users" ] } }, "status": "Created", "code": 201, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"user\": {\n \"value\": \"reference #/components/schemas/UserObject not found in the OpenAPI spec\"\n }\n}", "createdAt": "2026-06-05T15:23:55.000Z", "updatedAt": "2026-06-05T15:23:55.000Z", "uid": "35240-3a229468-a1b2-4363-9718-9d02f0bd1135" } ], "createdAt": "2026-06-05T15:23:55.000Z", "updatedAt": "2026-06-05T15:23:55.000Z", "uid": "35240-4a667947-5205-42ea-a07d-f83fd34e42e5" } ], "id": "f52c2e25-c5e4-46ef-8725-27bac86ea09d", "createdAt": "2026-06-05T15:23:55.000Z", "updatedAt": "2026-06-05T15:23:55.000Z", "uid": "35240-f52c2e25-c5e4-46ef-8725-27bac86ea09d" } ], "id": "aea4f0f2-4db8-440e-b0b0-ecd3a7ea12fb", "createdAt": "2026-06-05T15:23:55.000Z", "updatedAt": "2026-06-05T15:23:55.000Z", "uid": "35240-aea4f0f2-4db8-440e-b0b0-ecd3a7ea12fb" } ], "id": "26ea1c4d-62ae-48d5-a488-a043db77f483", "createdAt": "2026-06-05T15:23:55.000Z", "updatedAt": "2026-06-05T15:23:55.000Z", "uid": "35240-26ea1c4d-62ae-48d5-a488-a043db77f483" } ], "variable": [ { "key": "baseUrl", "value": "/" } ] }