Operations (sample payloads)
Main operationsCopy
Add comment to ticketCopy
Add a comment to a ticket.
Sample Input
1{2"ticket_id": 12345,3"comment_author": 67890,4"comment_body": "Thank you for reaching out. We've reviewed your issue and our technical team is working on a solution. We'll update you as soon as we have more information.",5"comment_public": true,6"uploads": [7"abc123",8"def456"9]10}
Sample Output
1{2"ticket": {3"url": "https://example.zendesk.com/api/v2/tickets/12345.json",4"id": 12345,5"external_id": null,6"via": {7"channel": "api",8"source": {9"from": {10"id": 67890,11"title": "Agent Name",12"deleted": false13},14"to": {},15"rel": null16}17},18"created_at": "2023-06-15T10:30:00Z",19"updated_at": "2023-06-15T14:45:00Z",20"type": "incident",21"subject": "Technical Issue with Product X",22"raw_subject": "Technical Issue with Product X",23"description": "I'm experiencing problems with Product X. It's not working as expected.",24"priority": "high",25"status": "open",26"recipient": "customer@example.com",27"requester_id": 11111,28"submitter_id": 67890,29"assignee_id": 67890,30"organization_id": 22222,31"group_id": 33333,32"collaborator_ids": [],33"follower_ids": [],34"email_cc_ids": [],35"forum_topic_id": null,36"problem_id": null,37"has_incidents": false,38"is_public": true,39"due_at": null,40"tags": [41"product_x",42"technical_issue"43],44"custom_fields": [],45"satisfaction_rating": null,46"sharing_agreement_ids": [],47"fields": [],48"followup_ids": [],49"ticket_form_id": 44444,50"brand_id": 55555,51"satisfaction_probability": null,52"allow_channelback": false,53"allow_attachments": true54},55"audit": {56"id": 98765,57"ticket_id": 12345,58"created_at": "2023-06-15T14:45:00Z",59"author_id": 67890,60"metadata": {61"system": {62"client": "Zendesk API",63"ip_address": "192.0.2.1",64"location": "San Francisco, CA, United States",65"latitude": 37.7749,66"longitude": -122.419467},68"custom": {}69},70"events": [71{72"id": 87654,73"type": "Comment",74"author_id": 67890,75"body": "Thank you for reaching out. We've reviewed your issue and our technical team is working on a solution. We'll update you as soon as we have more information.",76"html_body": "<p>Thank you for reaching out. We've reviewed your issue and our technical team is working on a solution. We'll update you as soon as we have more information.</p>",77"plain_body": "Thank you for reaching out. We've reviewed your issue and our technical team is working on a solution. We'll update you as soon as we have more information.",78"public": true,79"attachments": [80{81"url": "https://example.zendesk.com/api/v2/attachments/10001.json",82"id": 10001,83"file_name": "screenshot.png",84"content_url": "https://example.zendesk.com/attachments/token/abc123/?name=screenshot.png",85"mapped_content_url": "https://example.zendesk.com/attachments/token/abc123/?name=screenshot.png",86"content_type": "image/png",87"size": 153600,88"inline": false,89"deleted": false,90"thumbnails": []91},92{93"url": "https://example.zendesk.com/api/v2/attachments/10002.json",94"id": 10002,95"file_name": "error_log.txt",96"content_url": "https://example.zendesk.com/attachments/token/def456/?name=error_log.txt",97"mapped_content_url": "https://example.zendesk.com/attachments/token/def456/?name=error_log.txt",98"content_type": "text/plain",99"size": 2048,100"inline": false,101"deleted": false,102"thumbnails": []103}104],105"audit_id": 98765,106"via": {107"channel": "api",108"source": {109"from": {110"id": 67890,111"title": "Agent Name",112"deleted": false113},114"to": {},115"rel": null116}117}118}119],120"via": {121"channel": "api",122"source": {123"from": {124"id": 67890,125"title": "Agent Name",126"deleted": false127},128"to": {},129"rel": null130}131}132}133}
Count organization membersCopy
Count the number of members of an organization.
Sample Input
1{2"organization_id": "123456"3}
Sample Output
1{2"count": 423}
Create automationCopy
Create an automation.
Sample Input
1{2"title": "Auto-assign urgent tickets",3"actions": [4{5"priority": "urgent"6},7{8"group_id": "123456"9},10{11"notification_group": {12"recipient": "123456",13"subject": "Urgent ticket assigned to your group",14"body": "An urgent ticket has been automatically assigned to your group. Please review and take action as soon as possible."15}16}17],18"automation_all": [19{20"field": "status",21"operator": "is",22"value": "new"23},24{25"field": "priority",26"operator": "is",27"value": "urgent"28},29{30"field": "NEW",31"operator": "less_than",32"value": "1"33}34],35"active": true,36"position": 137}
Sample Output
1{2"automation": {3"url": "https://your-domain.zendesk.com/api/v2/automations/123456789",4"id": 123456789,5"title": "Auto-assign urgent tickets",6"active": true,7"updated_at": "2023-06-15T10:30:00Z",8"created_at": "2023-06-15T10:30:00Z",9"actions": [10{11"field": "priority",12"value": "urgent"13},14{15"field": "group_id",16"value": "123456"17},18{19"field": "notification_group",20"value": {21"recipient": "123456",22"subject": "Urgent ticket assigned to your group",23"body": "An urgent ticket has been automatically assigned to your group. Please review and take action as soon as possible."24}25}26],27"conditions": {28"all": [29{30"field": "status",31"operator": "is",32"value": "new"33},34{35"field": "priority",36"operator": "is",37"value": "urgent"38},39{40"field": "NEW",41"operator": "less_than",42"value": "1"43}44],45"any": []46},47"position": 1,48"raw_title": "Auto-assign urgent tickets"49}50}
Create brandCopy
Create a brand.
Sample Input
1{2"name": "Acme Support",3"subdomain": "acme-support"4}
Sample Output
1{2"brand": {3"url": "https://acme.zendesk.com/api/v2/brands/123456.json",4"id": 123456,5"name": "Acme Support",6"brand_url": "https://acme-support.zendesk.com",7"subdomain": "acme-support",8"has_help_center": true,9"help_center_state": "enabled",10"active": true,11"default": false,12"is_deleted": false,13"logo": {14"content_type": "image/png",15"content_url": "https://acme.zendesk.com/system/logos/123456/original/acme_logo.png",16"file_name": "acme_logo.png",17"id": 987654,18"size": 24680,19"thumbnails": [20{21"content_type": "image/png",22"content_url": "https://acme.zendesk.com/system/logos/123456/small/acme_logo.png",23"file_name": "acme_logo_small.png",24"id": 987655,25"mapped_content_url": "https://acme-support.zendesk.com/hc/logo-small.png",26"size": 12340,27"url": "https://acme.zendesk.com/system/logos/123456/small/acme_logo.png"28}29],30"url": "https://acme.zendesk.com/system/logos/123456/original/acme_logo.png"31},32"ticket_form_ids": [331,342,35336],37"signature_template": "{{agent.signature}}",38"created_at": "2023-06-15T10:30:00Z",39"updated_at": "2023-06-15T10:30:00Z",40"host_mapping": "support.acme.com"41}42}
Create groupCopy
Create a group.
Sample Input
1{2"name": "Customer Support Team"3}
Sample Output
1{2"group": {3"url": "https://example.zendesk.com/api/v2/groups/123456.json",4"id": 123456,5"name": "Customer Support Team",6"description": null,7"default": false,8"deleted": false,9"created_at": "2023-05-15T10:30:00Z",10"updated_at": "2023-05-15T10:30:00Z"11}12}
Create group membershipCopy
Create a group membership entry. This links an agent to a group.
Sample Input
1{2"user_id": 12345,3"group_id": 678904}
Sample Output
1{2"group_membership": {3"url": "https://example.zendesk.com/api/v2/group_memberships/987654",4"id": 987654,5"user_id": 12345,6"group_id": 67890,7"default": false,8"created_at": "2023-05-15T10:30:00Z",9"updated_at": "2023-05-15T10:30:00Z"10}11}
Create group memberships (bulk)Copy
Create one or more group membership entries. This links agents to groups. Assigns a maximum of 100 agents to given groups.
Sample Input
1{2"link_users_to_groups": [3{4"user_id": 12345,5"group_id": 678906},7{8"user_id": 23456,9"group_id": 7890110},11{12"user_id": 34567,13"group_id": 8901214}15]16}
Sample Output
1{2"job_status": {3"id": "job_12345abcde",4"url": "https://your-domain.zendesk.com/api/v2/job_statuses/job_12345abcde",5"total": 3,6"progress": 3,7"status": "completed",8"message": "3 group memberships created",9"results": [10{11"action": "create",12"id": 98765,13"status": "success",14"success": true15},16{17"action": "create",18"id": 87654,19"status": "success",20"success": true21},22{23"action": "create",24"id": 76543,25"status": "success",26"success": true27}28]29}30}
Create jira linkCopy
Create a link to connect between a Jira issue and a Zendesk ticket.
Sample Input
1{2"link": {3"ticket_id": "12345",4"issue_id": "67890",5"issue_key": "PROJ-123"6}7}
Sample Output
1{2"link": {3"id": 98765,4"ticket_id": "12345",5"issue_id": "67890",6"issue_key": "PROJ-123",7"url": "https://your-domain.atlassian.net/browse/PROJ-123",8"created_at": "2023-05-15T10:30:45Z",9"updated_at": "2023-05-15T10:30:45Z"10}11}
Create macroCopy
Create a macro (one or more actions that modify the values of a ticket's fields).
Sample Input
1{2"title": "Escalate to Urgent",3"actions": [4{5"priority": "urgent"6},7{8"status": "open"9},10{11"group_id": "20934852"12},13{14"set_tags": [15"escalated",16"urgent",17"high-priority"18]19},20{21"comment_value": "This ticket has been escalated to urgent priority. Our team will address it immediately."22},23{24"notification_user": {25"recipient": "all_agents",26"subject": "Urgent Ticket Escalation",27"body": "A ticket has been escalated to urgent priority. Please review and take necessary action."28}29}30],31"active": true,32"description": "Escalates a ticket to urgent priority and notifies all agents"33}
Sample Output
1{2"macro": {3"url": "https://yourdomain.zendesk.com/api/v2/macros/123456",4"id": 123456,5"title": "Escalate to Urgent",6"active": true,7"updated_at": "2023-06-15T10:30:00Z",8"created_at": "2023-06-15T10:30:00Z",9"position": 5,10"description": "Escalates a ticket to urgent priority and notifies all agents",11"actions": [12{13"field": "priority",14"value": "urgent"15},16{17"field": "status",18"value": "open"19},20{21"field": "group_id",22"value": "20934852"23},24{25"field": "set_tags",26"value": "[\"escalated\", \"urgent\", \"high-priority\"]"27},28{29"field": "comment_value",30"value": "This ticket has been escalated to urgent priority. Our team will address it immediately."31},32{33"field": "notification_user",34"value": "{\"recipient\":\"all_agents\",\"subject\":\"Urgent Ticket Escalation\",\"body\":\"A ticket has been escalated to urgent priority. Please review and take necessary action.\"}"35}36],37"restriction": null38}39}
Create or update organizationCopy
Create or update an organization.
Sample Input
1{2"required_field": {3"name": "Acme Corporation"4},5"domain_names": [6"acme.com",7"www.acme.com"8],9"details": "Global leader in innovative solutions",10"notes": "Key account, high priority",11"group_id": 12345,12"shared_tickets": true,13"shared_comments": false,14"tags": [15"enterprise",16"tech",17"priority"18],19"organization_fields": [20{21"key": "account_manager",22"value": "John Doe"23},24{25"key": "contract_renewal_date",26"value": "2024-06-30"27}28]29}
Sample Output
1{2"organization": {3"url": "https://example.zendesk.com/api/v2/organizations/987654321",4"id": 987654321,5"name": "Acme Corporation",6"shared_tickets": true,7"shared_comments": false,8"external_id": null,9"created_at": "2023-05-15T10:30:00Z",10"updated_at": "2023-05-15T10:30:00Z",11"domain_names": [12"acme.com",13"www.acme.com"14],15"details": "Global leader in innovative solutions",16"notes": "Key account, high priority",17"group_id": 12345,18"tags": [19"enterprise",20"tech",21"priority"22],23"organization_fields": {24"account_manager": "John Doe",25"contract_renewal_date": "2024-06-30"26}27}28}
Create organizationCopy
Create a new organization.
Sample Input
1{2"name": "Acme Corporation",3"external_id": "ACM123",4"domain_names": [5"acme.com",6"acmecorp.com"7],8"details": "Global technology company headquartered in Silicon Valley",9"notes": "Key account, high priority support",10"group_id": 12345,11"shared_tickets": true,12"shared_comments": false,13"tags": [14"enterprise",15"tech",16"priority"17],18"organization_fields": [19{20"key": "account_manager",21"value": "John Doe"22},23{24"key": "contract_renewal_date",25"value": "2024-06-30"26}27]28}
Sample Output
1{2"organization": {3"url": "https://example.zendesk.com/api/v2/organizations/987654321",4"id": 987654321,5"name": "Acme Corporation",6"shared_tickets": true,7"shared_comments": false,8"external_id": "ACM123",9"created_at": "2023-05-15T09:30:00Z",10"updated_at": "2023-05-15T09:30:00Z",11"domain_names": [12"acme.com",13"acmecorp.com"14],15"details": "Global technology company headquartered in Silicon Valley",16"notes": "Key account, high priority support",17"group_id": 12345,18"tags": [19"enterprise",20"tech",21"priority"22],23"organization_fields": {24"account_manager": "John Doe",25"contract_renewal_date": "2024-06-30"26}27}28}
Create organization fieldCopy
Create an organization field.
Sample Input
1{2"title": "Customer Size",3"field_type": "tagger",4"key": "customer_size",5"description": "Categorizes organizations by their size",6"position": 1,7"active": true,8"dropdown_options": [9{10"name": "Small",11"value": "small"12},13{14"name": "Medium",15"value": "medium"16},17{18"name": "Large",19"value": "large"20}21]22}
Sample Output
1{2"organization_field": {3"url": "https://your-domain.zendesk.com/api/v2/organization_fields/123456",4"id": 123456,5"type": "tagger",6"key": "customer_size",7"title": "Customer Size",8"description": "Categorizes organizations by their size",9"raw_title": "Customer Size",10"raw_description": "Categorizes organizations by their size",11"position": 1,12"active": true,13"system": false,14"regexp_for_validation": null,15"created_at": "2023-05-15T10:30:00Z",16"updated_at": "2023-05-15T10:30:00Z",17"custom_field_options": [18{19"id": 1,20"name": "Small",21"raw_name": "Small",22"value": "small"23},24{25"id": 2,26"name": "Medium",27"raw_name": "Medium",28"value": "medium"29},30{31"id": 3,32"name": "Large",33"raw_name": "Large",34"value": "large"35}36]37}38}
Create scheduleCopy
Create a support schedule.
Sample Input
1{2"name": "Customer Support Schedule",3"time_zone": "London",4"intervals": [5{6"start_time": {7"day": 1,8"hours": 9,9"minutes": 010},11"end_time": {12"day": 1,13"hours": 17,14"minutes": 015}16},17{18"start_time": {19"day": 2,20"hours": 9,21"minutes": 022},23"end_time": {24"day": 2,25"hours": 17,26"minutes": 027}28},29{30"start_time": {31"day": 3,32"hours": 9,33"minutes": 034},35"end_time": {36"day": 3,37"hours": 17,38"minutes": 039}40},41{42"start_time": {43"day": 4,44"hours": 9,45"minutes": 046},47"end_time": {48"day": 4,49"hours": 17,50"minutes": 051}52},53{54"start_time": {55"day": 5,56"hours": 9,57"minutes": 058},59"end_time": {60"day": 5,61"hours": 17,62"minutes": 063}64}65]66}
Sample Output
1{2"schedule": {3"id": 123456,4"name": "Customer Support Schedule",5"time_zone": "London",6"created_at": "2023-06-15T10:30:00Z",7"updated_at": "2023-06-15T10:30:00Z",8"intervals": [9{10"start_time": 540,11"end_time": 102012},13{14"start_time": 1980,15"end_time": 246016},17{18"start_time": 3420,19"end_time": 390020},21{22"start_time": 4860,23"end_time": 534024},25{26"start_time": 6300,27"end_time": 678028}29]30},31"url": "https://example.zendesk.com/api/v2/business_hours/schedules/123456"32}
Create sla policyCopy
Create a service level agreement policy.
Sample Input
1{2"title": "Premium Support SLA",3"description": "SLA policy for premium support customers",4"position": 1,5"filter": {6"all": [7{8"field": "organization_id",9"operator": "is",10"value": "123456"11}12],13"any": [14{15"field": "ticket_type_id",16"operator": "is",17"value": "incident"18},19{20"field": "ticket_type_id",21"operator": "is",22"value": "problem"23}24]25},26"policy_metrics": [27{28"priority": "urgent",29"metric": "first_reply_time",30"target": 60,31"business_hours": true32},33{34"priority": "high",35"metric": "first_reply_time",36"target": 120,37"business_hours": true38},39{40"priority": "normal",41"metric": "first_reply_time",42"target": 240,43"business_hours": true44},45{46"priority": "low",47"metric": "first_reply_time",48"target": 480,49"business_hours": true50}51]52}
Sample Output
1{2"sla_policy": {3"url": "https://your-domain.zendesk.com/api/v2/sla_policies/12345",4"id": 12345,5"title": "Premium Support SLA",6"description": "SLA policy for premium support customers",7"position": 1,8"filter": {9"all": [10{11"field": "organization_id",12"operator": "is",13"value": "123456"14}15],16"any": [17{18"field": "ticket_type_id",19"operator": "is",20"value": "incident"21},22{23"field": "ticket_type_id",24"operator": "is",25"value": "problem"26}27]28},29"policy_metrics": [30{31"business_hours": true,32"metric": "first_reply_time",33"priority": "urgent",34"target": 6035},36{37"business_hours": true,38"metric": "first_reply_time",39"priority": "high",40"target": 12041},42{43"business_hours": true,44"metric": "first_reply_time",45"priority": "normal",46"target": 24047},48{49"business_hours": true,50"metric": "first_reply_time",51"priority": "low",52"target": 48053}54],55"created_at": "2023-06-01T12:00:00Z",56"updated_at": "2023-06-01T12:00:00Z"57}58}
Create targetCopy
Create an external target to send notifications to with triggers and automations.
Sample Input
1{2"title": "New Email Notification Target",3"type": {4"email_target": {5"email": "support@example.com",6"subject": "New Zendesk Ticket"7}8},9"active": true10}
Sample Output
1{2"target": {3"url": "https://example.zendesk.com/api/v2/targets/12345.json",4"id": 12345,5"created_at": "2023-05-15T10:30:00Z",6"type": "email_target",7"title": "New Email Notification Target",8"active": true9}10}
Create ticketCopy
Create a new ticket.
Sample Input
1{2"subject": "Printer not working",3"description": "The office printer on the 3rd floor is not responding.",4"comment": {5"body": "I've tried restarting the printer, but it's still not working. Can someone please take a look?",6"public": true7},8"requester_id": 12345,9"submitter_id": 12345,10"assignee_id": 67890,11"group_id": 5678,12"priority": "high",13"status": "open",14"type": "problem",15"tags": [16"hardware",17"printer",18"3rd-floor"19],20"custom_fields": [21{22"id": 9876,23"value": "IT Equipment"24}25]26}
Sample Output
1{2"ticket": {3"url": "https://company.zendesk.com/api/v2/tickets/1234.json",4"id": 1234,5"external_id": null,6"via": {7"channel": "api",8"source": {9"from": {},10"to": {},11"rel": null12}13},14"created_at": "2023-05-15T10:30:00Z",15"updated_at": "2023-05-15T10:30:00Z",16"type": "problem",17"subject": "Printer not working",18"raw_subject": "Printer not working",19"description": "The office printer on the 3rd floor is not responding.",20"priority": "high",21"status": "open",22"recipient": null,23"requester_id": 12345,24"submitter_id": 12345,25"assignee_id": 67890,26"organization_id": null,27"group_id": 5678,28"collaborator_ids": [],29"follower_ids": [],30"email_cc_ids": [],31"forum_topic_id": null,32"problem_id": null,33"has_incidents": false,34"is_public": true,35"due_at": null,36"tags": [37"hardware",38"printer",39"3rd-floor"40],41"custom_fields": [42{43"id": 9876,44"value": "IT Equipment"45}46],47"satisfaction_rating": null,48"sharing_agreement_ids": [],49"fields": [50{51"id": 9876,52"value": "IT Equipment"53}54],55"followup_ids": [],56"ticket_form_id": null,57"brand_id": null,58"satisfaction_probability": null,59"allow_channelback": false,60"allow_attachments": true61},62"audit": {63"id": 9876543,64"ticket_id": 1234,65"created_at": "2023-05-15T10:30:00Z",66"author_id": 12345,67"metadata": {68"system": {69"client": "Zendesk API",70"ip_address": "203.0.113.10",71"location": "San Francisco, CA, United States",72"latitude": 37.7749,73"longitude": -122.419474},75"custom": {}76},77"events": [78{79"id": 123456789,80"type": "Comment",81"author_id": 12345,82"body": "I've tried restarting the printer, but it's still not working. Can someone please take a look?",83"html_body": "<p>I've tried restarting the printer, but it's still not working. Can someone please take a look?</p>",84"plain_body": "I've tried restarting the printer, but it's still not working. Can someone please take a look?",85"public": true,86"attachments": [],87"audit_id": 9876543,88"via": {89"channel": "api",90"source": {91"from": {},92"to": {},93"rel": null94}95}96}97],98"via": {99"channel": "api",100"source": {101"from": {},102"to": {},103"rel": null104}105}106}107}
Create ticket fieldCopy
Create a ticket field.
Sample Input
1{2"title": "Priority Level",3"type": "tagger",4"description": "Select the priority level for this ticket",5"position": 8,6"active": true,7"required": true,8"visible_in_portal": true,9"editable_in_portal": false,10"custom_field_options": [11{12"name": "Low",13"value": "low"14},15{16"name": "Medium",17"value": "medium"18},19{20"name": "High",21"value": "high"22},23{24"name": "Urgent",25"value": "urgent"26}27]28}
Sample Output
1{2"ticket_field": {3"url": "https://example.zendesk.com/api/v2/ticket_fields/123456",4"id": 123456,5"type": "tagger",6"title": "Priority Level",7"raw_title": "Priority Level",8"description": "Select the priority level for this ticket",9"raw_description": "Select the priority level for this ticket",10"position": 8,11"active": true,12"required": true,13"collapsed_for_agents": false,14"regexp_for_validation": null,15"title_in_portal": "Priority Level",16"raw_title_in_portal": "Priority Level",17"visible_in_portal": true,18"editable_in_portal": false,19"required_in_portal": false,20"tag": null,21"created_at": "2023-06-15T10:30:00Z",22"updated_at": "2023-06-15T10:30:00Z",23"removable": true,24"agent_description": null,25"custom_field_options": [26{27"id": 1001,28"name": "Low",29"raw_name": "Low",30"value": "low",31"default": false32},33{34"id": 1002,35"name": "Medium",36"raw_name": "Medium",37"value": "medium",38"default": false39},40{41"id": 1003,42"name": "High",43"raw_name": "High",44"value": "high",45"default": false46},47{48"id": 1004,49"name": "Urgent",50"raw_name": "Urgent",51"value": "urgent",52"default": false53}54]55}56}
Create ticket formCopy
Create a ticket form.
Sample Input
1{2"name": "Customer Support Form",3"position": 1,4"display_name": "Support Request",5"end_user_visible": true,6"active": true,7"default": false,8"in_all_brands": true,9"ticket_field_ids": [10123,11456,1278913],14"agent_conditions": [15{16"parent_field_id": 123,17"value": "high",18"child_fields": [19{20"id": 456,21"is_required": true,22"required_on_statuses": {23"type": "SOME_STATUSES",24"statuses": [25"new",26"open"27]28}29}30]31}32],33"end_user_conditions": [34{35"parent_field_id": 789,36"value": "billing",37"child_fields": [38{39"id": 456,40"is_required": true41}42]43}44]45}
Sample Output
1{2"ticket_form": {3"url": "https://example.zendesk.com/api/v2/ticket_forms/12345.json",4"id": 12345,5"name": "Customer Support Form",6"raw_name": "Customer Support Form",7"display_name": "Support Request",8"raw_display_name": "Support Request",9"end_user_visible": true,10"position": 1,11"ticket_field_ids": [12123,13456,1478915],16"active": true,17"default": false,18"created_at": "2023-06-15T10:30:00Z",19"updated_at": "2023-06-15T10:30:00Z",20"in_all_brands": true,21"restricted_brand_ids": [],22"end_user_conditions": [23{24"parent_field_id": 789,25"value": "billing",26"child_fields": [27{28"id": 456,29"is_required": true30}31]32}33],34"agent_conditions": [35{36"parent_field_id": 123,37"value": "high",38"child_fields": [39{40"id": 456,41"is_required": true,42"required_on_statuses": {43"type": "SOME_STATUSES",44"statuses": [45"new",46"open"47]48}49}50]51}52]53}54}
Create triggerCopy
Create a trigger (one or more actions performed when a ticket is created or updated).
Sample Input
1{2"title": "High Priority Support Ticket",3"description": "Automatically assign high priority tickets to the urgent support group",4"active": true,5"trigger_actions": [6{7"field": "group_id",8"value": "123456"9},10{11"field": "priority",12"value": "urgent"13}14],15"category_id": "200",16"position": 1,17"conditions": {18"all": [19{20"field": "priority",21"operator": "is",22"value": "high"23},24{25"field": "status",26"operator": "is",27"value": "new"28}29],30"any": [31{32"field": "subject_includes_word",33"operator": "includes",34"value": "urgent"35},36{37"field": "comment_includes_word",38"operator": "includes",39"value": "critical"40}41]42}43}
Sample Output
1{2"trigger": {3"url": "https://your-domain.zendesk.com/api/v2/triggers/12345.json",4"id": 12345,5"title": "High Priority Support Ticket",6"active": true,7"updated_at": "2023-05-15T10:30:00Z",8"created_at": "2023-05-15T10:30:00Z",9"actions": [10{11"field": "group_id",12"value": "123456"13},14{15"field": "priority",16"value": "urgent"17}18],19"conditions": {20"all": [21{22"field": "priority",23"operator": "is",24"value": "high"25},26{27"field": "status",28"operator": "is",29"value": "new"30}31],32"any": [33{34"field": "subject_includes_word",35"operator": "includes",36"value": "urgent"37},38{39"field": "comment_includes_word",40"operator": "includes",41"value": "critical"42}43]44},45"description": "Automatically assign high priority tickets to the urgent support group",46"position": 1,47"raw_title": "High Priority Support Ticket"48}49}
Create userCopy
Create a new user.
Sample Input
1{2"name": "John Doe",3"email": "johndoe@example.com",4"role": "agent",5"custom_role_id": 12345,6"verified": true,7"phone": "+1 555-123-4567",8"organization_id": 67890,9"alias": "JD",10"default_group_id": 54321,11"locale": "en-US",12"time_zone": "America/New_York",13"signature": "Best regards,\nJohn Doe\nCustomer Support",14"tags": [15"vip",16"tech-savvy"17],18"ticket_restriction": "groups",19"user_fields": [20{21"key": "department",22"value": "IT Support"23},24{25"key": "employee_id",26"value": "EMP001"27}28],29"notes": "Experienced support agent with 5 years of experience",30"details": "Office location: New York",31"external_id": "EXT12345"32}
Sample Output
1{2"user": {3"id": 987654,4"url": "https://example.zendesk.com/api/v2/users/987654.json",5"name": "John Doe",6"email": "johndoe@example.com",7"created_at": "2023-05-15T10:30:00Z",8"updated_at": "2023-05-15T10:30:00Z",9"time_zone": "America/New_York",10"iana_time_zone": "America/New_York",11"phone": "+1 555-123-4567",12"shared_phone_number": false,13"photo": {14"id": 12345,15"name": "profile_picture.jpg",16"content_url": "https://example.zendesk.com/system/photos/12345/profile_picture.jpg",17"content_type": "image/jpeg",18"size": 102400,19"thumbnails": [20{21"id": 67890,22"name": "profile_picture_thumb.jpg",23"content_url": "https://example.zendesk.com/system/photos/67890/profile_picture_thumb.jpg",24"content_type": "image/jpeg",25"size": 1024026}27]28},29"locale_id": 1,30"locale": "en-US",31"organization_id": 67890,32"role": "agent",33"verified": true,34"external_id": "EXT12345",35"tags": [36"vip",37"tech-savvy"38],39"alias": "JD",40"active": true,41"shared": false,42"shared_agent": false,43"last_login_at": "2023-05-15T10:35:00Z",44"two_factor_auth_enabled": false,45"signature": "Best regards,\nJohn Doe\nCustomer Support",46"details": "Office location: New York",47"notes": "Experienced support agent with 5 years of experience",48"role_type": "agent",49"custom_role_id": 12345,50"moderator": false,51"ticket_restriction": "groups",52"only_private_comments": false,53"restricted_agent": false,54"suspended": false,55"chat_only": false,56"default_group_id": 54321,57"report_csv": true,58"user_fields": {59"department": "IT Support",60"employee_id": "EMP001"61}62}63}
Create user fieldCopy
Create a custom user field.
Sample Input
1{2"field_type": "text",3"key": "customer_loyalty_level",4"title": "Customer Loyalty Level",5"raw_title": "Customer Loyalty Level",6"description": "Indicates the customer's loyalty program status",7"raw_description": "Indicates the customer's loyalty program status",8"position": 1,9"active": true10}
Sample Output
1{2"user_field": {3"url": "https://your-domain.zendesk.com/api/v2/user_fields/123456",4"id": 123456,5"type": "user_field",6"key": "customer_loyalty_level",7"title": "Customer Loyalty Level",8"description": "Indicates the customer's loyalty program status",9"raw_title": "Customer Loyalty Level",10"raw_description": "Indicates the customer's loyalty program status",11"position": 1,12"active": true,13"system": false,14"regexp_for_validation": null,15"created_at": "2023-05-15T10:30:00Z",16"updated_at": "2023-05-15T10:30:00Z"17}18}
Create user identityCopy
Create an identity for a user.
Sample Input
1{2"user_id": "123456",3"user_identity_type": "email",4"value": "john.doe@example.com",5"verified": true6}
Sample Output
1{2"identity": {3"url": "https://example.zendesk.com/api/v2/users/123456/identities/987654",4"id": 987654,5"user_id": 123456,6"type": "email",7"value": "john.doe@example.com",8"verified": true,9"primary": false,10"created_at": "2023-05-15T10:30:00Z",11"updated_at": "2023-05-15T10:30:00Z"12}13}
Create viewCopy
Create a view.
Sample Input
1{2"title": "High Priority Tickets",3"all": [4{5"field": "priority",6"operator": "is",7"value": "high"8},9{10"field": "status",11"operator": "is_not",12"value": "solved"13}14],15"any": [16{17"field": "type",18"operator": "is",19"value": "incident"20},21{22"field": "type",23"operator": "is",24"value": "problem"25}26],27"description": "View for all high priority tickets that are not solved",28"active": true,29"output": {30"columns": [31"nice_id",32"requester",33"subject",34"status",35"priority",36"group",37"assignee"38],39"group_by": "status",40"sort_by": "priority",41"sort_order": "desc",42"group_order": "asc"43},44"restriction": {45"type": "Group",46"id": 12347}48}
Sample Output
1{2"view": {3"url": "https://your-domain.zendesk.com/api/v2/views/12345.json",4"id": 12345,5"title": "High Priority Tickets",6"active": true,7"updated_at": "2023-06-15T10:30:00Z",8"created_at": "2023-06-15T10:30:00Z",9"position": 1,10"description": "View for all high priority tickets that are not solved",11"execution": {12"group_by": "status",13"group_order": "asc",14"sort_by": "priority",15"sort_order": "desc",16"group": {17"id": "status",18"title": "Status",19"order": "asc"20},21"sort": {22"id": "priority",23"title": "Priority",24"order": "desc"25},26"columns": [27{28"id": "nice_id",29"title": "ID"30},31{32"id": "requester",33"title": "Requester"34},35{36"id": "subject",37"title": "Subject"38},39{40"id": "status",41"title": "Status"42},43{44"id": "priority",45"title": "Priority"46},47{48"id": "group",49"title": "Group"50},51{52"id": "assignee",53"title": "Assignee"54}55],56"fields": [57{58"id": "nice_id",59"title": "ID"60},61{62"id": "requester",63"title": "Requester"64},65{66"id": "subject",67"title": "Subject"68},69{70"id": "status",71"title": "Status"72},73{74"id": "priority",75"title": "Priority"76},77{78"id": "group",79"title": "Group"80},81{82"id": "assignee",83"title": "Assignee"84}85],86"custom_fields": []87},88"conditions": {89"all": [90{91"field": "priority",92"operator": "is",93"value": "high"94},95{96"field": "status",97"operator": "is_not",98"value": "solved"99}100],101"any": [102{103"field": "type",104"operator": "is",105"value": "incident"106},107{108"field": "type",109"operator": "is",110"value": "problem"111}112]113},114"restriction": {115"type": "Group",116"id": 123117},118"watchable": true,119"raw_title": "High Priority Tickets"120}121}
Create/update userCopy
Create a new user if the user does not already exist or update an existing user identified by e-mail address or external ID. To create a new user, please provide a name. To update an existing user, please provide either an email address or external ID
Sample Input
1{2"name": "John Doe",3"email": "johndoe@example.com",4"role": "end-user",5"verified": true,6"phone": "+1 555-123-4567",7"organization_id": 123456,8"alias": "JD",9"locale": "en-US",10"time_zone": "America/New_York",11"signature": "Best regards,\nJohn Doe",12"tags": [13"vip",14"new_customer"15],16"ticket_restriction": "organization",17"user_fields": [18{19"key": "department",20"value": "Sales"21},22{23"key": "employee_id",24"value": "EMP001"25}26],27"notes": "Prefers email communication",28"details": "Address: 123 Main St, Anytown, USA",29"external_id": "CUS-001"30}
Sample Output
1{2"user": {3"id": 987654,4"url": "https://example.zendesk.com/api/v2/users/987654.json",5"name": "John Doe",6"email": "johndoe@example.com",7"created_at": "2023-05-15T10:30:00Z",8"updated_at": "2023-05-15T10:30:00Z",9"time_zone": "America/New_York",10"iana_time_zone": "America/New_York",11"phone": "+1 555-123-4567",12"shared_phone_number": false,13"photo": null,14"locale_id": 1,15"locale": "en-US",16"organization_id": 123456,17"role": "end-user",18"verified": true,19"external_id": "CUS-001",20"tags": [21"vip",22"new_customer"23],24"alias": "JD",25"active": true,26"shared": false,27"shared_agent": false,28"last_login_at": null,29"two_factor_auth_enabled": false,30"signature": "Best regards,\nJohn Doe",31"details": "Address: 123 Main St, Anytown, USA",32"notes": "Prefers email communication",33"role_type": null,34"custom_role_id": null,35"moderator": false,36"ticket_restriction": "organization",37"only_private_comments": false,38"restricted_agent": false,39"suspended": false,40"chat_only": false,41"default_group_id": null,42"report_csv": false,43"user_fields": {44"department": "Sales",45"employee_id": "EMP001"46}47}48}
Delete group membershipCopy
Removes an agent from a group
Sample Input
1{2"group_membership_id": 1234563}
Sample Output
1{2"success": true3}
Delete group memberships (bulk)Copy
Removes an agent from a group.
Sample Input
1{2"group_membership_ids": [3123456,4234567,53456786]7}
Sample Output
1{2"job_status": {3"id": "1234567890abcdef",4"url": "https://your-domain.zendesk.com/api/v2/job_statuses/1234567890abcdef",5"total": 3,6"progress": 3,7"status": "completed",8"message": "Completed at 2023-06-15 14:30:00 +0000",9"results": [10{11"action": "delete",12"id": 123456,13"status": "OK",14"success": true15},16{17"action": "delete",18"id": 234567,19"status": "OK",20"success": true21},22{23"action": "delete",24"id": 345678,25"status": "OK",26"success": true27}28]29}30}
Delete jira linkCopy
Delete a link between a Jira issue and a Zendesk ticket.
Sample Input
1{2"link_id": 123453}
Sample Output
1{2"success": true3}
Delete ticketCopy
Delete a ticket.
Sample Input
1{2"ticket_id": 123453}
Sample Output
1{2"success": true3}
Delete ticket formCopy
Delete a ticket form.
Sample Input
1{2"ticket_form_id": 1234563}
Sample Output
1{2"success": true3}
Delete ticket tagsCopy
Delete tags from a ticket.
Sample Input
1{2"ticket_id": 12345,3"tags": [4"urgent",5"customer_request",6"bug"7]8}
Sample Output
1{2"success": true,3"remaining_tags": [4"high_priority",5"feature_request"6]7}
Delete user fieldCopy
Delete a custom user field.
Sample Input
1{2"user_field_id": 1234563}
Sample Output
1{2"success": true3}
Delete user identityCopy
Delete a specified user identity.
Sample Input
1{2"user_id": "12345",3"identity_id": "67890"4}
Sample Output
1{2"success": true3}
Filter articlesCopy
Filter articles by specified fields.
Sample Input
1{2"articles_list_by": {3"category_id": "123456"4},5"sort_order": "desc",6"sort_by": "updated_at",7"label_names": "product,feature",8"page_size": 509}
Sample Output
1{2"meta": {3"has_more": true,4"after_cursor": "eyJvIjoibmljZV9pZCIsInYiOiJhUmtBQUFBQUFBQUEifQ==",5"before_cursor": "eyJvIjoibmljZV9pZCIsInYiOiJhUmtBQUFBQUFBQUEifQ=="6},7"links": {8"first": "https://example.zendesk.com/api/v2/help_center/articles.json?page[size]=50&sort=-updated_at",9"last": "https://example.zendesk.com/api/v2/help_center/articles.json?page[size]=50&sort=-updated_at&page[after]=eyJvIjoibmljZV9pZCIsInYiOiJhUmtBQUFBQUFBQUEifQ==",10"next": "https://example.zendesk.com/api/v2/help_center/articles.json?page[size]=50&sort=-updated_at&page[after]=eyJvIjoibmljZV9pZCIsInYiOiJhUmtBQUFBQUFBQUEifQ=="11},12"articles": [13{14"id": 360001234567,15"url": "https://example.zendesk.com/api/v2/help_center/en-us/articles/360001234567.json",16"html_url": "https://example.zendesk.com/hc/en-us/articles/360001234567",17"author_id": 123456,18"comments_disabled": false,19"draft": false,20"promoted": true,21"position": 1,22"vote_sum": 5,23"vote_count": 10,24"section_id": 789012,25"created_at": "2023-05-15T10:00:00Z",26"updated_at": "2023-05-16T14:30:00Z",27"name": "How to use our new feature",28"title": "How to use our new feature",29"source_locale": "en-us",30"locale": "en-us",31"outdated": false,32"outdated_locales": [],33"edited_at": "2023-05-16T14:30:00Z",34"user_segment_id": null,35"permission_group_id": 345678,36"content_tag_ids": [37"tag1",38"tag2"39],40"label_names": [41"product",42"feature"43],44"body": "<p>This is the content of the article explaining how to use our new feature...</p>"45}46]47}
Get articleCopy
Retrieve a specific article.
Sample Input
1{2"article_id": 123453}
Sample Output
1{2"article": {3"id": 12345,4"url": "https://example.zendesk.com/api/v2/help_center/en-us/articles/12345.json",5"html_url": "https://example.zendesk.com/hc/en-us/articles/12345",6"author_id": 67890,7"comments_disabled": false,8"draft": false,9"promoted": true,10"position": 1,11"vote_sum": 15,12"vote_count": 20,13"section_id": 98765,14"created_at": "2023-05-15T10:30:00Z",15"updated_at": "2023-05-20T14:45:00Z",16"name": "How to Reset Your Password",17"title": "How to Reset Your Password",18"source_locale": "en-us",19"locale": "en-us",20"outdated": false,21"outdated_locales": [],22"edited_at": "2023-05-20T14:45:00Z",23"user_segment_id": null,24"permission_group_id": 54321,25"label_names": [26"password",27"account",28"security"29],30"body": "<h1>How to Reset Your Password</h1><p>If you've forgotten your password, follow these steps to reset it:</p><ol><li>Go to the login page</li><li>Click on 'Forgot Password'</li><li>Enter your email address</li><li>Check your email for reset instructions</li><li>Follow the link in the email to create a new password</li></ol><p>If you need further assistance, please contact our support team.</p>"31}32}
Get article attachmentCopy
Retrieve a specific article attachment.
Sample Input
1{2"article_id": 123456,3"attachment_id": 7890124}
Sample Output
1{2"article_attachment": {3"id": 789012,4"url": "https://company.zendesk.com/api/v2/help_center/articles/123456/attachments/789012.json",5"article_id": 123456,6"display_file_name": "product_manual.pdf",7"file_name": "product_manual_v1.2.pdf",8"content_url": "https://company.zendesk.com/hc/article_attachments/789012/product_manual_v1.2.pdf",9"relative_path": "/hc/article_attachments/789012/product_manual_v1.2.pdf",10"content_type": "application/pdf",11"size": 2048000,12"inline": false,13"created_at": "2023-05-15T10:30:00Z",14"updated_at": "2023-05-15T10:30:00Z"15}16}
Get article commentCopy
Retrieve a specific article comment from knowledge base.
Sample Input
1{2"article_id": 123456,3"comment_id": 7890124}
Sample Output
1{2"comment": {3"id": 789012,4"url": "https://example.zendesk.com/api/v2/help_center/articles/123456/comments/789012.json",5"body": "This article was very helpful. Thank you for the clear explanation!",6"author_id": 987654,7"source_id": 123456,8"source_type": "Article",9"html_url": "https://example.zendesk.com/hc/en-us/articles/123456-Article-Title#comment_789012",10"locale": "en-us",11"created_at": "2023-05-15T10:30:00Z",12"updated_at": "2023-05-15T10:30:00Z",13"vote_sum": 3,14"vote_count": 3,15"non_author_editor_id": null,16"non_author_updated_at": null17}18}
Get group membershipCopy
Retrieve a group membership.
Sample Input
1{2"group_membership_id": 123456,3"user_id": 9876544}
Sample Output
1{2"group_membership": {3"url": "https://example.zendesk.com/api/v2/group_memberships/123456.json",4"id": 123456,5"user_id": 987654,6"group_id": 246810,7"default": false,8"created_at": "2023-05-15T10:30:00Z",9"updated_at": "2023-05-15T10:30:00Z"10}11}
Get labelCopy
Retrieve a specific label.
Sample Input
1{2"label_id": 1234563}
Sample Output
1{2"label": {3"id": 123456,4"url": "https://example.zendesk.com/api/v2/labels/123456.json",5"name": "Priority",6"created_at": "2023-05-15T10:30:00Z",7"updated_at": "2023-05-15T10:30:00Z"8}9}
Get organizationCopy
Get information about an organization.
Sample Input
1{2"organization_id": "123456",3"include": [4"abilities",5"users"6]7}
Sample Output
1{2"organization": {3"url": "https://example.zendesk.com/api/v2/organizations/123456.json",4"id": 123456,5"name": "Acme Corporation",6"shared_tickets": true,7"shared_comments": false,8"external_id": "acme_corp",9"created_at": "2023-05-15T10:30:00Z",10"updated_at": "2023-05-20T14:45:00Z",11"domain_names": [12"acme.com",13"acmecorp.com"14],15"details": "Global technology company",16"notes": "VIP customer, priority support",17"group_id": "987654",18"tags": [19"enterprise",20"tech",21"vip"22],23"organization_fields": {24"account_owner": "John Doe",25"csm": "Jane Smith",26"external_id": "ACM001",27"had_kick_off_call": true,28"region": "North America",29"salesforce_instance": "NA1",30"tier": "Enterprise"31},32"abilities": {33"url": "https://example.zendesk.com/api/v2/organizations/123456/abilities.json",34"organization_id": 123456,35"can_edit_users": true,36"can_access_tickets": true37}38},39"abilities": [40{41"url": "https://example.zendesk.com/api/v2/organizations/123456/abilities.json",42"organization_id": 123456,43"can_edit_users": true,44"can_access_tickets": true45}46]47}
Get organization custom fieldCopy
Retrieve an organization custom field.
Sample Input
1{2"organization_field_id": "360001234567"3}
Sample Output
1{2"organization_field": {3"url": "https://example.zendesk.com/api/v2/organization_fields/360001234567",4"id": 360001234567,5"type": "dropdown",6"key": "customer_tier",7"title": "Customer Tier",8"description": "The tier level of the customer organization",9"raw_title": "Customer Tier",10"raw_description": "The tier level of the customer organization",11"position": 1,12"active": true,13"system": false,14"regexp_for_validation": null,15"created_at": "2023-05-15T10:30:00Z",16"updated_at": "2023-05-15T10:30:00Z"17}18}
Get settingsCopy
Retrieve the settings that are available for the account.
Sample Input
1{}
Sample Output
1{2"settings": {3"branding": {4"header_color": "#000000",5"page_background_color": "#FFFFFF",6"tab_background_color": "#F2F2F2",7"text_color": "#333333",8"header_logo_url": "https://example.com/logo.png",9"favicon_url": "https://example.com/favicon.ico"10},11"apps": {12"use": true,13"create_private": true,14"create_public": false15},16"tickets": {17"agent_ticket_deletion": false,18"list_newest_comments_first": true,19"collaboration": true,20"private_attachments": true,21"email_attachments": true,22"agent_collision": true,23"tagging": true,24"list_empty_views": false,25"comments_public_by_default": true,26"is_first_comment_private_enabled": false,27"maximum_personal_views_to_list": 10,28"status_hold": true,29"markdown_ticket_comments": true,30"rich_text_comments": true,31"emoji_autocompletion": true,32"assign_tickets_upon_solve": false,33"allow_group_reset": true,34"accepted_new_collaboration_tos": true,35"follower_and_email_cc_collaborations": true,36"auto_updated_ccs_followers_rules": true,37"light_agent_email_ccs_allowed": false,38"using_skill_based_routing": true39},40"agents": {41"agent_workspace": true,42"focus_mode": true43},44"groups": {45"check_group_name_uniqueness": true46},47"chat": {48"enabled": true,49"integrated": true,50"available": true,51"maximum_request_count": 100,52"welcome_message": "Welcome to our support chat!"53},54"voice": {55"enabled": true,56"logging": true,57"outbound_enabled": true,58"agent_confirmation_when_forwarding": true,59"agent_wrap_up_after_calls": true,60"maximum_queue_size": 50,61"maximum_queue_wait_time": 300,62"only_during_business_hours": true,63"recordings_public": false,64"uk_mobile_forwarding": false65},66"twitter": {67"shorten_url": "bit.ly"68},69"google_apps": {70"has_google_apps": true,71"has_google_apps_admin": true72},73"user": {74"tagging": true,75"time_zone_selection": true,76"language_selection": true,77"multiple_organizations": true,78"agent_created_welcome_emails": true,79"end_user_phone_number_validation": true,80"have_gravatars_enabled": true81},82"screencast": {83"enabled_for_tickets": true,84"host": "screencast.example.com",85"tickets_recorder_id": 1234586},87"lotus": {88"prefer_lotus": true,89"reporting": true,90"pod_id": 191},92"gooddata_advanced_analytics": {93"enabled": true94},95"statistics": {96"forum": true,97"search": true,98"rule_usage": true99},100"billing": {101"backend": "stripe"102},103"active_features": {104"on_hold_status": true,105"user_tagging": true,106"ticket_tagging": true,107"topic_suggestion": true,108"voice": true,109"business_hours": true,110"facebook_login": true,111"google_login": true,112"twitter_login": true,113"forum_analytics": true,114"agent_forwarding": true,115"chat": true,116"chat_about_my_ticket": true,117"customer_satisfaction": true,118"satisfaction_prediction": true,119"automatic_answers": true,120"csat_reason_code": true,121"screencasts": true,122"markdown": true,123"bcc_archiving": true,124"allow_ccs": true,125"advanced_analytics": true,126"insights": true,127"explore": true,128"explore_on_support_ent_plan": true,129"explore_on_support_pro_plan": false,130"good_data_and_explore": true,131"good_data_only": false,132"explore_forbidden": false,133"explore_not_set": false,134"sandbox": true,135"suspended_ticket_notification": true,136"twitter": true,137"facebook": true,138"dynamic_contents": true,139"light_agents": true,140"ticket_forms": true,141"user_org_fields": true,142"is_abusive": false,143"rich_content_in_emails": true,144"customer_context_as_default": true,145"benchmark_opt_out": false146},147"ticket_form": {148"ticket_forms_instructions": "Please fill out the form below",149"raw_ticket_forms_instructions": "<p>Please fill out the form below</p>"150},151"brands": {152"default_brand_id": 123456,153"require_brand_on_new_tickets": true154},155"api": {156"accepted_api_agreement": true,157"api_password_access": "allowed",158"api_token_access": "allowed"159},160"rule": {161"macro_most_used": true,162"macro_order": "alphabetical",163"skill_based_filtered_views": [164"support",165"billing",166"technical"167],168"using_skill_based_routing": true169},170"limits": {171"attachment_size": 20971520172},173"onboarding": {174"checklist_onboarding_version": 2,175"onboarding_segments": "small_business",176"product_sign_up": "support"177},178"cross_sell": {179"show_chat_tooltip": true,180"xsell_source": "in_product"181},182"cdn": {183"cdn_provider": "fastly",184"fallback_cdn_provider": "akamai",185"hosts": [186{187"name": "assets",188"url": "https://assets.zendesk.com"189},190{191"name": "static",192"url": "https://static.zdassets.com"193}194]195},196"metrics": {197"account_size": "medium"198},199"ticket_sharing_partners": {200"support_addresses": [201"partner1@example.com",202"partner2@example.com"203]204},205"localization": {206"locale_ids": [2071,2082,2093,2104211]212}213}214}
Get ticketCopy
Get information about a specific ticket.
Sample Input
1{2"ticket_id": 12345,3"include": [4"users",5"groups",6"organizations"7]8}
Sample Output
1{2"ticket": {3"url": "https://example.zendesk.com/api/v2/tickets/12345.json",4"id": 12345,5"external_id": "ABC-123",6"via": {7"channel": "web"8},9"created_at": "2023-05-15T10:30:00Z",10"updated_at": "2023-05-15T14:45:00Z",11"type": "incident",12"subject": "Unable to access account",13"raw_subject": "Unable to access account",14"description": "I'm having trouble logging into my account. The password reset option is not working.",15"priority": "high",16"status": "open",17"recipient": "support@example.com",18"requester_id": 67890,19"submitter_id": 67890,20"assignee_id": 54321,21"organization_id": 98765,22"group_id": 11111,23"collaborator_ids": [2422222,253333326],27"follower_ids": [284444429],30"email_cc_ids": [315555532],33"forum_topic_id": null,34"problem_id": null,35"has_incidents": false,36"is_public": false,37"due_at": "2023-05-16T17:00:00Z",38"tags": [39"account_access",40"password_reset"41],42"custom_fields": [43{44"id": 1001,45"value": "Premium"46},47{48"id": 1002,49"value": "Web"50}51],52"satisfaction_rating": null,53"sharing_agreement_ids": [],54"fields": [55{56"id": 2001,57"value": "High"58},59{60"id": 2002,61"value": "Account Management"62}63],64"followup_ids": [],65"ticket_form_id": 3001,66"brand_id": 4001,67"allow_channelback": true,68"allow_attachments": true69}70}
Get ticket auditCopy
Get information about a specific ticket audit.
Sample Input
1{2"ticket_id": 12345,3"ticket_audit_id": 67890,4"include": [5"users",6"organizations"7]8}
Sample Output
1{2"audit": {3"id": 67890,4"ticket_id": 12345,5"created_at": "2023-05-15T14:30:00Z",6"author_id": 98765,7"metadata": {8"system": {9"client": "web_browser",10"ip_address": "192.168.1.100",11"location": "New York, USA"12},13"custom": {}14},15"events": [16{17"id": 111222,18"type": "Comment",19"via": {20"channel": "web",21"source": {22"from": {23"deleted": false,24"title": "John Doe",25"id": 98765,26"revision_id": 127},28"rel": "customer"29}30},31"resource": "ticket",32"body": "This is a sample comment on the ticket."33}34],35"via": {36"channel": "web",37"source": {38"from": {39"deleted": false,40"title": "John Doe",41"id": 9876542},43"rel": "customer"44}45}46}47}
Get ticket formCopy
Get information about a specific ticket form.
Sample Input
1{2"ticket_form_id": 1234563}
Sample Output
1{2"ticket_form": {3"url": "https://example.zendesk.com/api/v2/ticket_forms/123456.json",4"id": 123456,5"name": "Customer Support Form",6"raw_name": "Customer Support Form",7"display_name": "Customer Support",8"raw_display_name": "Customer Support",9"end_user_visible": true,10"position": 1,11"ticket_field_ids": [12987654,13876543,1476543215],16"active": true,17"default": false,18"created_at": "2023-05-15T10:30:00Z",19"updated_at": "2023-05-20T14:45:00Z",20"in_all_brands": false,21"restricted_brand_ids": [22111222,2333344424],25"end_user_conditions": [26{27"child_fields": [28{29"id": 555666,30"is_required": true31}32],33"parent_field_id": 777888,34"value": "high_priority"35}36],37"agent_conditions": [38{39"child_fields": [40{41"id": 999000,42"is_required": true,43"required_on_statuses": {44"statuses": [45"open",46"pending"47],48"type": "all"49}50}51],52"parent_field_id": 111222,53"value": "technical_issue"54}55]56}57}
Get userCopy
Retrieve a specified user.
Sample Input
1{2"user_id": 123453}
Sample Output
1{2"user": {3"id": 12345,4"url": "https://example.zendesk.com/api/v2/users/12345.json",5"name": "John Doe",6"email": "johndoe@example.com",7"created_at": "2023-05-15T10:30:00Z",8"updated_at": "2023-05-15T14:45:00Z",9"time_zone": "America/New_York",10"iana_time_zone": "America/New_York",11"phone": "+1 555-123-4567",12"shared_phone_number": null,13"photo": "https://example.zendesk.com/system/photos/12345/avatar.png",14"locale_id": 1,15"locale": "en-US",16"organization_id": 67890,17"role": "agent",18"verified": true,19"external_id": "EXT-12345",20"tags": [21"support",22"billing"23],24"alias": "JD",25"active": true,26"shared": false,27"shared_agent": false,28"last_login_at": "2023-05-15T09:00:00Z",29"two_factor_auth_enabled": true,30"signature": "Best regards,\nJohn Doe\nCustomer Support",31"details": "Senior Support Agent",32"notes": "Specializes in technical issues",33"role_type": null,34"custom_role_id": null,35"moderator": false,36"ticket_restriction": "none",37"only_private_comments": false,38"restricted_agent": false,39"suspended": false,40"chat_only": false,41"default_group_id": 54321,42"report_csv": true,43"user_fields": {44"meteor_url": "https://meteor.example.com/users/12345",45"recurly_url": "https://recurly.example.com/users/12345",46"sample_user_field": "Sample Value",47"tickets_allowed": true48}49}50}
Import ticketCopy
Imports a ticket to Zendesk from a legacy system. Unlike 'Create ticket', this operation allows you to set system parameters like 'created_at', 'updated_at', and 'solved_at'.
Sample Input
1{2"description": "Customer reported issues with login functionality on our mobile app.",3"subject": "Mobile App Login Problem",4"comments": [5{6"body": "I've been unable to log in to the mobile app for the past two days. It keeps showing an error message.",7"public": true,8"author_id": "1234567",9"uploads": [10"abc123",11"def456"12]13}14],15"created_at": "2023-06-01T10:30:00Z",16"updated_at": "2023-06-01T10:30:00Z",17"requester_id": 9876543,18"submitter_id": 9876543,19"assignee_id": 1122334,20"group_id": 5566778,21"type": "problem",22"priority": "high",23"status": "open",24"tags": [25"mobile",26"login",27"error"28],29"custom_fields": [30{31"id": 360001234567,32"value": "iOS 14.5"33}34]35}
Sample Output
1{2"ticket": {3"url": "https://company.zendesk.com/api/v2/tickets/12345.json",4"id": 12345,5"external_id": null,6"via": {7"channel": "api",8"source": {9"from": {},10"to": {},11"rel": null12}13},14"created_at": "2023-06-01T10:30:00Z",15"updated_at": "2023-06-01T10:30:00Z",16"type": "problem",17"subject": "Mobile App Login Problem",18"raw_subject": "Mobile App Login Problem",19"description": "Customer reported issues with login functionality on our mobile app.",20"priority": "high",21"status": "open",22"recipient": null,23"requester_id": 9876543,24"submitter_id": 9876543,25"assignee_id": 1122334,26"organization_id": null,27"group_id": 5566778,28"collaborator_ids": [],29"follower_ids": [],30"email_cc_ids": [],31"forum_topic_id": null,32"problem_id": null,33"has_incidents": false,34"is_public": true,35"due_at": null,36"tags": [37"mobile",38"login",39"error"40],41"custom_fields": [42{43"id": 360001234567,44"value": "iOS 14.5"45}46],47"satisfaction_rating": null,48"sharing_agreement_ids": [],49"fields": [50{51"id": 360001234567,52"value": "iOS 14.5"53}54],55"followup_ids": [],56"ticket_form_id": null,57"brand_id": null,58"satisfaction_probability": null,59"allow_channelback": false,60"allow_attachments": true61}62}
List article attachmentsCopy
List all attachments in a specific article.
Sample Input
1{2"article_id": 123456,3"attachment_type": "all",4"page_size": 505}
Sample Output
1{2"meta": {3"after_cursor": "eyJvIjoiZGVzYyIsInYiOiIyMDIzLTA1LTEwVDE1OjMwOjAwWiJ9",4"before_cursor": "eyJvIjoiYXNjIiwidiI6IjIwMjMtMDUtMDFUMDk6MDA6MDBaIn0="5},6"links": {7"first": "https://api.zendesk.com/v2/help_center/articles/123456/attachments?page[size]=50",8"last": "https://api.zendesk.com/v2/help_center/articles/123456/attachments?page[size]=50&page[after]=eyJvIjoiZGVzYyIsInYiOiIyMDIzLTA1LTEwVDE1OjMwOjAwWiJ9",9"next": "https://api.zendesk.com/v2/help_center/articles/123456/attachments?page[size]=50&page[after]=eyJvIjoiZGVzYyIsInYiOiIyMDIzLTA1LTEwVDE1OjMwOjAwWiJ9"10},11"article_attachments": [12{13"id": 987654,14"url": "https://company.zendesk.com/api/v2/help_center/articles/123456/attachments/987654.json",15"article_id": 123456,16"display_file_name": "product_screenshot.png",17"file_name": "product_screenshot.png",18"content_url": "https://company.zendesk.com/hc/article_attachments/987654/product_screenshot.png",19"relative_path": "/hc/article_attachments/987654/product_screenshot.png",20"content_type": "image/png",21"size": 256000,22"inline": false,23"created_at": "2023-05-05T10:15:30Z",24"updated_at": "2023-05-05T10:15:30Z"25},26{27"id": 987655,28"url": "https://company.zendesk.com/api/v2/help_center/articles/123456/attachments/987655.json",29"article_id": 123456,30"display_file_name": "user_manual.pdf",31"file_name": "user_manual.pdf",32"content_url": "https://company.zendesk.com/hc/article_attachments/987655/user_manual.pdf",33"relative_path": "/hc/article_attachments/987655/user_manual.pdf",34"content_type": "application/pdf",35"size": 2048000,36"inline": false,37"created_at": "2023-05-07T14:20:00Z",38"updated_at": "2023-05-07T14:20:00Z"39}40]41}
List article commentsCopy
List the comments created by a specific user, or all comments made by all users on a specific article.
Sample Input
1{2"article_id": 12345,3"user_id": 67890,4"page_size": 50,5"page_after": "cursor_abc123"6}
Sample Output
1{2"meta": {3"has_more": true,4"after_cursor": "cursor_def456",5"before_cursor": "cursor_abc123"6},7"links": {8"first": "https://api.zendesk.com/v2/help_center/articles/12345/comments.json?page[size]=50&page[after]=cursor_abc123",9"last": "https://api.zendesk.com/v2/help_center/articles/12345/comments.json?page[size]=50&page[after]=cursor_xyz789"10},11"comments": [12{13"id": 98765,14"url": "https://api.zendesk.com/v2/help_center/articles/12345/comments/98765.json",15"body": "This article was very helpful. Thank you!",16"author_id": 67890,17"source_id": 12345,18"source_type": "Article",19"html_url": "https://support.example.com/hc/en-us/articles/12345-Article-Title#comment_98765",20"locale": "en-us",21"created_at": "2023-05-15T10:30:00Z",22"updated_at": "2023-05-15T10:30:00Z",23"vote_sum": 3,24"vote_count": 3,25"non_author_editor_id": null,26"non_author_updated_at": null27},28{29"id": 98766,30"url": "https://api.zendesk.com/v2/help_center/articles/12345/comments/98766.json",31"body": "Could you please clarify the third point?",32"author_id": 11111,33"source_id": 12345,34"source_type": "Article",35"html_url": "https://support.example.com/hc/en-us/articles/12345-Article-Title#comment_98766",36"locale": "en-us",37"created_at": "2023-05-16T14:45:00Z",38"updated_at": "2023-05-16T14:45:00Z",39"vote_sum": 1,40"vote_count": 1,41"non_author_editor_id": null,42"non_author_updated_at": null43}44]45}
List article labelsCopy
Retrieve all labels given to a specific article.
Sample Input
1{2"article_id": 123456,3"page_size": 50,4"page_after": "eyJvIjoiY3JlYXRlZF9hdCIsInYiOiIyMDIzLTA1LTEwVDA4OjMwOjAwWiJ9"5}
Sample Output
1{2"meta": {3"after_cursor": "eyJvIjoiY3JlYXRlZF9hdCIsInYiOiIyMDIzLTA1LTEwVDA5OjAwOjAwWiJ9",4"before_cursor": "eyJvIjoiY3JlYXRlZF9hdCIsInYiOiIyMDIzLTA1LTEwVDA4OjAwOjAwWiJ9"5},6"links": {7"first": "https://api.zendesk.com/v2/help_center/articles/123456/labels.json?page[size]=50",8"last": "https://api.zendesk.com/v2/help_center/articles/123456/labels.json?page[size]=50&page[after]=eyJvIjoiY3JlYXRlZF9hdCIsInYiOiIyMDIzLTA1LTEwVDE3OjAwOjAwWiJ9",9"next": "https://api.zendesk.com/v2/help_center/articles/123456/labels.json?page[size]=50&page[after]=eyJvIjoiY3JlYXRlZF9hdCIsInYiOiIyMDIzLTA1LTEwVDA5OjAwOjAwWiJ9"10},11"labels": [12{13"id": 987654,14"url": "https://api.zendesk.com/v2/help_center/articles/123456/labels/987654.json",15"name": "troubleshooting",16"created_at": "2023-05-10T08:15:00Z",17"updated_at": "2023-05-10T08:15:00Z"18},19{20"id": 987655,21"url": "https://api.zendesk.com/v2/help_center/articles/123456/labels/987655.json",22"name": "getting-started",23"created_at": "2023-05-10T08:20:00Z",24"updated_at": "2023-05-10T08:20:00Z"25},26{27"id": 987656,28"url": "https://api.zendesk.com/v2/help_center/articles/123456/labels/987656.json",29"name": "faq",30"created_at": "2023-05-10T08:25:00Z",31"updated_at": "2023-05-10T08:25:00Z"32}33]34}
List article translationsCopy
Retrieve translations for a specific article.
Sample Input
1{2"article_id": 123456,3"locale": "fr",4"page_size": 505}
Sample Output
1{2"meta": {3"after_cursor": "eyJvIjoiY3JlYXRlZF9hdCIsInYiOiIyMDIzLTA1LTEwVDA5OjMwOjAwWiJ9",4"before_cursor": "eyJvIjoiY3JlYXRlZF9hdCIsInYiOiIyMDIzLTA1LTAxVDEwOjAwOjAwWiJ9"5},6"links": {7"first": "https://api.zendesk.com/v2/help_center/articles/123456/translations.json?page[size]=50",8"last": "https://api.zendesk.com/v2/help_center/articles/123456/translations.json?page[size]=50&page[after]=eyJvIjoiY3JlYXRlZF9hdCIsInYiOiIyMDIzLTA1LTEwVDA5OjMwOjAwWiJ9",9"next": "https://api.zendesk.com/v2/help_center/articles/123456/translations.json?page[size]=50&page[after]=eyJvIjoiY3JlYXRlZF9hdCIsInYiOiIyMDIzLTA1LTEwVDA5OjMwOjAwWiJ9"10},11"translations": [12{13"id": 987654,14"url": "https://api.zendesk.com/v2/help_center/articles/123456/translations/987654.json",15"html_url": "https://example.zendesk.com/hc/fr/articles/123456",16"source_id": 123456,17"source_type": "Article",18"locale": "fr",19"title": "Comment utiliser notre produit",20"body": "<p>Voici les étapes pour utiliser notre produit...</p>",21"outdated": false,22"draft": false,23"hidden": false,24"created_at": "2023-05-01T10:00:00Z",25"updated_at": "2023-05-10T09:30:00Z",26"updated_by_id": 11111,27"created_by_id": 2222228}29]30}
List articlesCopy
Retrieve list of all articles.
Sample Input
1{2"sort_order": "desc",3"sort_by": "updated_at",4"label_names": "product,faq",5"locale": "en-US",6"page_size": 507}
Sample Output
1{2"meta": {3"has_more": true,4"after_cursor": "eyJvIjoiZGVzYyIsInMiOiJ1cGRhdGVkX2F0In0=",5"before_cursor": null6},7"links": {8"first": "https://api.zendesk.com/v2/help_center/articles.json?page[size]=50&sort=-updated_at",9"last": "https://api.zendesk.com/v2/help_center/articles.json?page[size]=50&sort=-updated_at&page[after]=eyJvIjoiZGVzYyIsInMiOiJ1cGRhdGVkX2F0In0=",10"prev": null,11"next": "https://api.zendesk.com/v2/help_center/articles.json?page[size]=50&sort=-updated_at&page[after]=eyJvIjoiZGVzYyIsInMiOiJ1cGRhdGVkX2F0In0="12},13"articles": [14{15"id": 360001234567,16"url": "https://example.zendesk.com/api/v2/help_center/en-us/articles/360001234567.json",17"html_url": "https://example.zendesk.com/hc/en-us/articles/360001234567",18"author_id": 123456,19"comments_disabled": false,20"draft": false,21"promoted": true,22"position": 0,23"vote_sum": 15,24"vote_count": 20,25"section_id": 987654,26"created_at": "2023-06-15T10:00:00Z",27"updated_at": "2023-06-20T14:30:00Z",28"name": "How to use our product",29"title": "How to use our product",30"source_locale": "en-US",31"locale": "en-US",32"outdated": false,33"outdated_locales": [],34"edited_at": "2023-06-20T14:30:00Z",35"user_segment_id": null,36"permission_group_id": 111222,37"content_tag_ids": [38"123",39"456"40],41"label_names": [42"product",43"faq"44],45"body": "<p>Here's how to use our product effectively...</p>"46}47]48}
List audits for a ticketCopy
List the audits linked to a specific ticket.
Sample Input
1{2"ticket_id": 12345,3"include": [4"users",5"organizations"6],7"sort_order": "desc",8"page_size": 509}
Sample Output
1{2"audits": [3{4"id": 987654,5"ticket_id": 12345,6"created_at": "2023-05-15T14:30:00Z",7"author_id": 67890,8"metadata": {9"system": {10"client": "web_browser",11"ip_address": "192.168.1.100",12"location": "New York, USA",13"latitude": 40.7128,14"longitude": -74.00615},16"custom": {}17},18"events": [19{20"id": 111222,21"type": "Comment",22"via": {23"channel": "web",24"source": {25"from": {26"deleted": false,27"title": "John Doe",28"id": 67890,29"revision_id": 130},31"rel": "user"32}33},34"resource": "ticket",35"body": "This is a sample comment on the ticket."36}37],38"via": {39"channel": "web",40"source": {41"from": {42"deleted": false,43"title": "John Doe",44"id": 6789045},46"to": {},47"rel": "user"48}49}50}51],52"meta": {53"has_more": true,54"after_cursor": "eyJvIjoibmljZV9pZCIsInYiOiJhUmtBQUFBQUFBQUEifQ==",55"before_cursor": "eyJvIjoibmljZV9pZCIsInYiOiJhUmtBQUFBQUFBQUEifQ=="56},57"links": {58"prev": "https://your-domain.zendesk.com/api/v2/tickets/12345/audits.json?page[size]=50&page[before]=eyJvIjoibmljZV9pZCIsInYiOiJhUmtBQUFBQUFBQUEifQ==",59"next": "https://your-domain.zendesk.com/api/v2/tickets/12345/audits.json?page[size]=50&page[after]=eyJvIjoibmljZV9pZCIsInYiOiJhUmtBQUFBQUFBQUEifQ=="60}61}
List brandsCopy
Retrieve a list of all brands for your account sorted by name.
Sample Input
1{2"page_size": 2,3"page_after": "eyJvIjoiMjAyMy0wNS0xNVQxNDozMDowMC4wMDBaIiwiZCI6ImFzYyJ9"4}
Sample Output
1{2"brands": [3{4"url": "https://example.zendesk.com/api/v2/brands/123456.json",5"id": 123456,6"name": "Acme Support",7"brand_url": "https://acme.zendesk.com",8"subdomain": "acme",9"host_mapping": "support.acme.com",10"has_help_center": true,11"help_center_state": "enabled",12"active": true,13"default": true,14"is_deleted": false,15"logo": {16"content_type": "image/png",17"content_url": "https://acme.zendesk.com/system/logos/123456/original/acme_logo.png",18"file_name": "acme_logo.png",19"id": 987654,20"mapped_content_url": "https://acme.zendesk.com/system/logos/123456/original/acme_logo.png",21"thumbnails": [22{23"content_type": "image/png",24"content_url": "https://acme.zendesk.com/system/logos/123456/small/acme_logo.png",25"file_name": "acme_logo.png",26"id": 987655,27"mapped_content_url": "https://acme.zendesk.com/system/logos/123456/small/acme_logo.png",28"size": 10240,29"url": "https://acme.zendesk.com/system/logos/123456/small/acme_logo.png"30}31],32"url": "https://acme.zendesk.com/system/logos/123456/original/acme_logo.png"33},34"ticket_form_ids": [3598765,369876637],38"signature_template": "{{agent.signature}}",39"created_at": "2023-01-15T10:00:00Z",40"updated_at": "2023-05-15T14:30:00Z"41},42{43"url": "https://example.zendesk.com/api/v2/brands/123457.json",44"id": 123457,45"name": "Beta Support",46"brand_url": "https://beta.zendesk.com",47"subdomain": "beta",48"host_mapping": "support.beta.com",49"has_help_center": true,50"help_center_state": "enabled",51"active": true,52"default": false,53"is_deleted": false,54"logo": {55"content_type": "image/jpeg",56"content_url": "https://beta.zendesk.com/system/logos/123457/original/beta_logo.jpg",57"file_name": "beta_logo.jpg",58"id": 987656,59"mapped_content_url": "https://beta.zendesk.com/system/logos/123457/original/beta_logo.jpg",60"thumbnails": [61{62"content_type": "image/jpeg",63"content_url": "https://beta.zendesk.com/system/logos/123457/small/beta_logo.jpg",64"file_name": "beta_logo.jpg",65"id": 987657,66"mapped_content_url": "https://beta.zendesk.com/system/logos/123457/small/beta_logo.jpg",67"size": 8192,68"url": "https://beta.zendesk.com/system/logos/123457/small/beta_logo.jpg"69}70],71"url": "https://beta.zendesk.com/system/logos/123457/original/beta_logo.jpg"72},73"ticket_form_ids": [749876775],76"signature_template": "{{agent.signature}}",77"created_at": "2023-03-01T09:00:00Z",78"updated_at": "2023-05-16T11:45:00Z"79}80],81"meta": {82"has_more": true,83"after_cursor": "eyJvIjoiMjAyMy0wNS0xNlQxMTo0NTowMC4wMDBaIiwiZCI6ImFzYyJ9",84"before_cursor": "eyJvIjoiMjAyMy0wNS0xNVQxNDozMDowMC4wMDBaIiwiZCI6ImFzYyJ9"85},86"links": {87"prev": "https://example.zendesk.com/api/v2/brands?page[size]=2&page[before]=eyJvIjoiMjAyMy0wNS0xNVQxNDozMDowMC4wMDBaIiwiZCI6ImFzYyJ9",88"next": "https://example.zendesk.com/api/v2/brands?page[size]=2&page[after]=eyJvIjoiMjAyMy0wNS0xNlQxMTo0NTowMC4wMDBaIiwiZCI6ImFzYyJ9"89}90}
List categoriesCopy
List all categories in knowledge base.
Sample Input
1{2"sort_order": "desc",3"sort_by": "updated_at",4"page_size": 505}
Sample Output
1{2"meta": {3"after_cursor": "eyJvIjoiZGVzYyIsInMiOiJ1cGRhdGVkX2F0In0=",4"before_cursor": null5},6"links": {7"first": "https://example.zendesk.com/api/v2/help_center/categories.json?page[size]=50&sort=-updated_at",8"last": "https://example.zendesk.com/api/v2/help_center/categories.json?page[size]=50&sort=-updated_at&page[after]=eyJvIjoiZGVzYyIsInMiOiJ1cGRhdGVkX2F0In0=",9"next": "https://example.zendesk.com/api/v2/help_center/categories.json?page[size]=50&sort=-updated_at&page[after]=eyJvIjoiZGVzYyIsInMiOiJ1cGRhdGVkX2F0In0="10},11"categories": [12{13"id": 12345,14"url": "https://example.zendesk.com/api/v2/help_center/categories/12345.json",15"html_url": "https://example.zendesk.com/hc/en-us/categories/12345-Getting-Started",16"position": 1,17"created_at": "2023-05-15T10:30:00Z",18"updated_at": "2023-05-20T14:45:00Z",19"name": "Getting Started",20"description": "Learn the basics of our product",21"locale": "en-us",22"source_locale": "en-us",23"outdated": false24},25{26"id": 67890,27"url": "https://example.zendesk.com/api/v2/help_center/categories/67890.json",28"html_url": "https://example.zendesk.com/hc/en-us/categories/67890-Troubleshooting",29"position": 2,30"created_at": "2023-05-10T09:15:00Z",31"updated_at": "2023-05-19T16:30:00Z",32"name": "Troubleshooting",33"description": "Common issues and their solutions",34"locale": "en-us",35"source_locale": "en-us",36"outdated": false37}38]39}
List custom user rolesCopy
Retrieve a list of custom user roles.
Sample Input
1{}
Sample Output
1{2"custom_roles": [3{4"id": 1234567,5"name": "Support Specialist",6"description": "Handles customer support tickets and basic account management",7"role_type": 0,8"created_at": "2023-05-15T10:30:00Z",9"updated_at": "2023-05-15T10:30:00Z",10"configuration": {11"chat_access": true,12"manage_business_rules": false,13"manage_dynamic_content": false,14"manage_extensions_and_channels": false,15"manage_facebook": true,16"organization_editing": true,17"organization_notes_editing": true,18"ticket_deletion": false,19"view_deleted_tickets": false,20"ticket_tag_editing": true,21"twitter_search_access": true,22"forum_access_restricted_content": false,23"end_user_list_access": "full",24"ticket_access": "all",25"ticket_comment_access": "public",26"voice_access": true,27"moderate_forums": false,28"group_access": true,29"light_agent": false,30"side_conversation_create": true,31"end_user_profile_access": "full",32"explore_access": "read",33"forum_access": "full",34"macro_access": "full",35"report_access": "full",36"ticket_editing": true,37"ticket_merge": true,38"view_access": "full",39"user_view_access": "full"40}41}42],43"next_page": "https://your-domain.zendesk.com/api/v2/custom_roles.json?page=2",44"previous_page": null,45"count": 146}
List group membershipsCopy
List the group memberships e.g. list the agents and the groups that they are assigned to.
Sample Input
1{2"filter": {3"user_id": 123454},5"page_size": 506}
Sample Output
1{2"group_memberships": [3{4"url": "https://example.zendesk.com/api/v2/group_memberships/67890",5"id": 67890,6"user_id": 12345,7"group_id": 98765,8"default": true,9"created_at": "2023-05-15T10:30:00Z",10"updated_at": "2023-05-15T10:30:00Z"11},12{13"url": "https://example.zendesk.com/api/v2/group_memberships/67891",14"id": 67891,15"user_id": 12345,16"group_id": 98766,17"default": false,18"created_at": "2023-05-16T14:45:00Z",19"updated_at": "2023-05-16T14:45:00Z"20}21],22"meta": {23"has_more": false,24"after_cursor": "eyJvIjoibmljZV9pZCIsInYiOiJhUmtBQUFBQUFBQUEifQ==",25"before_cursor": "eyJvIjoibmljZV9pZCIsInYiOiJhUmtBQUFBQUFBQUEifQ=="26},27"links": {28"prev": "https://example.zendesk.com/api/v2/group_memberships?page[before]=eyJvIjoibmljZV9pZCIsInYiOiJhUmtBQUFBQUFBQUEifQ==&page[size]=50",29"next": "https://example.zendesk.com/api/v2/group_memberships?page[after]=eyJvIjoibmljZV9pZCIsInYiOiJhUmtBQUFBQUFBQUEifQ==&page[size]=50"30}31}
List groupsCopy
Get a list of all of the groups in your Zendesk account.
Sample Input
1{2"include": [3"users"4],5"page_size": 50,6"page_after": "eyJvIjoiZGVzYyIsInYiOiIyMDIzLTA1LTEwVDE1OjMwOjAwWiJ9"7}
Sample Output
1{2"groups": [3{4"url": "https://example.zendesk.com/api/v2/groups/123.json",5"id": 123,6"is_public": true,7"name": "Support Team",8"description": "Handles customer support tickets",9"default": false,10"deleted": false,11"created_at": "2023-01-15T10:00:00Z",12"updated_at": "2023-05-01T14:30:00Z",13"user_ids": [141001,151002,16100317]18},19{20"url": "https://example.zendesk.com/api/v2/groups/124.json",21"id": 124,22"is_public": false,23"name": "Sales Team",24"description": "Handles sales inquiries",25"default": false,26"deleted": false,27"created_at": "2023-02-01T09:00:00Z",28"updated_at": "2023-04-15T11:45:00Z",29"user_ids": [302001,31200232]33}34],35"users": [36{37"id": 1001,38"name": "John Doe",39"email": "john.doe@example.com"40},41{42"id": 1002,43"name": "Jane Smith",44"email": "jane.smith@example.com"45}46],47"meta": {48"has_more": true,49"after_cursor": "eyJvIjoiZGVzYyIsInYiOiIyMDIzLTA1LTEwVDE2OjAwOjAwWiJ9",50"before_cursor": "eyJvIjoiZGVzYyIsInYiOiIyMDIzLTA1LTEwVDE1OjMwOjAwWiJ9"51},52"links": {53"prev": "https://example.zendesk.com/api/v2/groups.json?page[size]=50&page[before]=eyJvIjoiZGVzYyIsInYiOiIyMDIzLTA1LTEwVDE1OjMwOjAwWiJ9",54"next": "https://example.zendesk.com/api/v2/groups.json?page[size]=50&page[after]=eyJvIjoiZGVzYyIsInYiOiIyMDIzLTA1LTEwVDE2OjAwOjAwWiJ9"55}56}
List labelsCopy
List all labels in knowledge base that can be applied to articles.
Sample Input
1{2"page_size": 50,3"page_after": "eyJvIjoiMjAyMy0wNS0wMVQxMjozNDo1Ni4wMDBaIiwiZCI6ImRlc2MifQ==",4"page_before": null5}
Sample Output
1{2"meta": {3"after_cursor": "eyJvIjoiMjAyMy0wNS0wNVQwOToxNTozMC4wMDBaIiwiZCI6ImRlc2MifQ==",4"before_cursor": "eyJvIjoiMjAyMy0wNS0wMVQxMjozNDo1Ni4wMDBaIiwiZCI6ImRlc2MifQ=="5},6"links": {7"first": "https://api.zendesk.com/v2/help_center/articles/labels?page[size]=50",8"last": "https://api.zendesk.com/v2/help_center/articles/labels?page[size]=50&page[after]=eyJvIjoiMjAyMy0wNS0zMVQxNzoyMzoxMC4wMDBaIiwiZCI6ImRlc2MifQ==",9"next": "https://api.zendesk.com/v2/help_center/articles/labels?page[size]=50&page[after]=eyJvIjoiMjAyMy0wNS0wNVQwOToxNTozMC4wMDBaIiwiZCI6ImRlc2MifQ=="10},11"labels": [12{13"id": 12345,14"url": "https://example.zendesk.com/api/v2/help_center/articles/labels/12345",15"name": "Getting Started",16"created_at": "2023-05-01T12:34:56Z",17"updated_at": "2023-05-01T12:34:56Z"18},19{20"id": 12346,21"url": "https://example.zendesk.com/api/v2/help_center/articles/labels/12346",22"name": "Troubleshooting",23"created_at": "2023-05-02T09:12:34Z",24"updated_at": "2023-05-02T09:12:34Z"25},26{27"id": 12347,28"url": "https://example.zendesk.com/api/v2/help_center/articles/labels/12347",29"name": "Advanced Features",30"created_at": "2023-05-03T15:45:23Z",31"updated_at": "2023-05-03T15:45:23Z"32}33]34}
List localesCopy
Retrieve a list of locales available to the account.
Sample Input
1{2"per_page": 50,3"page": 14}
Sample Output
1{2"locales": [3{4"url": "https://example.zendesk.com/api/v2/locales/1.json",5"id": 1,6"locale": "en-US",7"name": "English",8"native_name": "English",9"presentation_name": "English (United States)",10"rtl": false,11"created_at": "2023-05-15T10:30:00Z",12"updated_at": "2023-05-15T10:30:00Z",13"default": true14},15{16"url": "https://example.zendesk.com/api/v2/locales/2.json",17"id": 2,18"locale": "es",19"name": "Spanish",20"native_name": "Español",21"presentation_name": "Español",22"rtl": false,23"created_at": "2023-05-15T10:31:00Z",24"updated_at": "2023-05-15T10:31:00Z",25"default": false26}27],28"next_page": "https://example.zendesk.com/api/v2/locales.json?page=2",29"previous_page": null,30"count": 231}
List organization fieldsCopy
Get a list of all of the available organization fields in your Zendesk account.
Sample Input
1{2"per_page": 50,3"next_page_token": "eyJvIjoibmljZV9pZCIsInYiOiJhUmtBQUFBQUFBQUEifQ=="4}
Sample Output
1{2"organization_fields": [3{4"url": "https://example.zendesk.com/api/v2/organization_fields/123456",5"id": 123456,6"type": "text",7"key": "custom_field_1",8"title": "Company Size",9"description": "Number of employees in the organization",10"raw_title": "Company Size",11"raw_description": "Number of employees in the organization",12"position": 1,13"active": true,14"system": false,15"regexp_for_validation": null,16"created_at": "2023-05-15T10:30:00Z",17"updated_at": "2023-05-15T10:30:00Z"18},19{20"url": "https://example.zendesk.com/api/v2/organization_fields/123457",21"id": 123457,22"type": "dropdown",23"key": "custom_field_2",24"title": "Industry",25"description": "The primary industry of the organization",26"raw_title": "Industry",27"raw_description": "The primary industry of the organization",28"position": 2,29"active": true,30"system": false,31"regexp_for_validation": null,32"created_at": "2023-05-15T11:00:00Z",33"updated_at": "2023-05-15T11:00:00Z"34}35],36"meta": {37"has_more": true,38"after_cursor": "eyJvIjoibmljZV9pZCIsInYiOiJhUmtBQUFBQUFBQUEifQ==",39"before_cursor": null40},41"links": {42"prev": null,43"next": "https://example.zendesk.com/api/v2/organization_fields?page[after]=eyJvIjoibmljZV9pZCIsInYiOiJhUmtBQUFBQUFBQUEifQ=="44}45}
List organization membershipsCopy
Get a list of all of the memberships (users) attached to this organization.
Sample Input
1{2"organization_id": "123456",3"page_size": 50,4"page_after": "eyJvIjoibmljZV9pZCIsInYiOiJhUmtBQUFBQUFBQUEifQ=="5}
Sample Output
1{2"organization_memberships": [3{4"url": "https://example.zendesk.com/api/v2/organization_memberships/987654321",5"id": 987654321,6"user_id": 12345,7"organization_id": 123456,8"default": true,9"created_at": "2023-05-15T10:30:00Z",10"organization_name": "Acme Corporation",11"updated_at": "2023-05-15T10:30:00Z",12"view_tickets": true13},14{15"url": "https://example.zendesk.com/api/v2/organization_memberships/987654322",16"id": 987654322,17"user_id": 12346,18"organization_id": 123456,19"default": false,20"created_at": "2023-05-15T11:00:00Z",21"organization_name": "Acme Corporation",22"updated_at": "2023-05-15T11:00:00Z",23"view_tickets": false24}25],26"meta": {27"has_more": true,28"after_cursor": "eyJvIjoibmljZV9pZCIsInYiOiJhUmtBQUFBQUFBQUEifQ==",29"before_cursor": "eyJvIjoibmljZV9pZCIsInYiOiJhUmtBQUFBQUFBQUEifQ=="30},31"links": {32"prev": "https://example.zendesk.com/api/v2/organizations/123456/organization_memberships.json?page[size]=50&page[before]=eyJvIjoibmljZV9pZCIsInYiOiJhUmtBQUFBQUFBQUEifQ==",33"next": "https://example.zendesk.com/api/v2/organizations/123456/organization_memberships.json?page[size]=50&page[after]=eyJvIjoibmljZV9pZCIsInYiOiJhUmtBQUFBQUFBQUEifQ=="34}35}
List organizationsCopy
Get a list of all of the organizations in your Zendesk account, grouped into pages.
Sample Input
1{2"page_size": 2,3"page_after": "eyJvIjoiMTIzNDU2Nzg5MCJ9"4}
Sample Output
1{2"organizations": [3{4"url": "https://example.zendesk.com/api/v2/organizations/123456.json",5"id": 123456,6"name": "Acme Corporation",7"shared_tickets": false,8"shared_comments": false,9"external_id": "acme_corp",10"created_at": "2023-05-15T10:30:00Z",11"updated_at": "2023-05-15T10:30:00Z",12"domain_names": [13"acmecorp.com",14"acme-inc.net"15],16"details": "Global technology company",17"notes": "Key account, high priority",18"group_id": 98765,19"tags": [20"enterprise",21"tech"22],23"organization_fields": {24"account_owner": "John Doe",25"had_kick_off_call": true,26"region": "North America",27"salesforce_instance": "NA1"28}29},30{31"url": "https://example.zendesk.com/api/v2/organizations/789012.json",32"id": 789012,33"name": "TechStart Inc.",34"shared_tickets": true,35"shared_comments": true,36"external_id": "techstart_inc",37"created_at": "2023-05-16T09:15:00Z",38"updated_at": "2023-05-16T09:15:00Z",39"domain_names": [40"techstart.io"41],42"details": "Emerging startup in AI sector",43"notes": "Potential for rapid growth",44"group_id": 54321,45"tags": [46"startup",47"ai"48],49"organization_fields": {50"account_owner": "Jane Smith",51"had_kick_off_call": false,52"region": "Europe",53"salesforce_instance": "EU0"54}55}56],57"meta": {58"has_more": true,59"after_cursor": "eyJvIjoiNzg5MDEyIn0=",60"before_cursor": "eyJvIjoiMTIzNDU2In0="61},62"links": {63"prev": "https://example.zendesk.com/api/v2/organizations.json?page[size]=2&page[before]=eyJvIjoiMTIzNDU2In0=",64"next": "https://example.zendesk.com/api/v2/organizations.json?page[size]=2&page[after]=eyJvIjoiNzg5MDEyIn0="65}66}
List sectionsCopy
List sections.
Sample Input
1{2"category_id": 123456,3"sort_order": "desc",4"sort_by": "updated_at",5"page_size": 506}
Sample Output
1{2"meta": {3"after_cursor": "eyJvIjoiMjAyMy0wNS0yMFQxNTozMDowMFoiLCJkIjoiYWZ0ZXIifQ==",4"before_cursor": "eyJvIjoiMjAyMy0wNS0xOFQwOTowMDowMFoiLCJkIjoiYmVmb3JlIn0="5},6"links": {7"first": "https://api.zendesk.com/v2/help_center/categories/123456/sections.json?page[size]=50&sort=-updated_at",8"last": "https://api.zendesk.com/v2/help_center/categories/123456/sections.json?page[size]=50&sort=-updated_at&page[after]=eyJvIjoiMjAyMy0wNS0xOFQwOTowMDowMFoiLCJkIjoiYWZ0ZXIifQ==",9"next": "https://api.zendesk.com/v2/help_center/categories/123456/sections.json?page[size]=50&sort=-updated_at&page[after]=eyJvIjoiMjAyMy0wNS0yMFQxNTozMDowMFoiLCJkIjoiYWZ0ZXIifQ=="10},11"sections": [12{13"id": 987654,14"url": "https://example.zendesk.com/api/v2/help_center/en-us/sections/987654.json",15"html_url": "https://example.zendesk.com/hc/en-us/sections/987654-Getting-Started",16"category_id": 123456,17"position": 1,18"sorting": "manual",19"created_at": "2023-05-18T09:00:00Z",20"updated_at": "2023-05-20T15:30:00Z",21"name": "Getting Started",22"description": "Learn how to set up and use our product",23"locale": "en-us",24"source_locale": "en-us",25"outdated": false,26"parent_section_id": null,27"theme_template": "section_page"28},29{30"id": 987655,31"url": "https://example.zendesk.com/api/v2/help_center/en-us/sections/987655.json",32"html_url": "https://example.zendesk.com/hc/en-us/sections/987655-Troubleshooting",33"category_id": 123456,34"position": 2,35"sorting": "manual",36"created_at": "2023-05-19T11:15:00Z",37"updated_at": "2023-05-20T14:45:00Z",38"name": "Troubleshooting",39"description": "Common issues and how to resolve them",40"locale": "en-us",41"source_locale": "en-us",42"outdated": false,43"parent_section_id": null,44"theme_template": "section_page"45}46]47}
List ticket commentsCopy
List the comments (both public and private) linked to a specific ticket.
Sample Input
1{2"ticket_id": 12345,3"include": [4"users"5],6"sort_order": "desc",7"page_size": 508}
Sample Output
1{2"comments": [3{4"id": 67890,5"type": "Comment",6"author_id": 9876,7"body": "Thank you for your patience. We're working on resolving your issue.",8"html_body": "<p>Thank you for your patience. We're working on resolving your issue.</p>",9"plain_body": "Thank you for your patience. We're working on resolving your issue.",10"public": true,11"attachments": [],12"audit_id": 54321,13"via": {14"channel": "web",15"source": {16"from": {},17"to": {},18"rel": null19}20},21"created_at": "2023-05-15T14:30:00Z",22"metadata": {23"system": {24"client": "Mozilla/5.0",25"ip_address": "192.168.1.1",26"location": "New York, NY",27"latitude": 40.7128,28"longitude": -74.00629},30"custom": {}31}32}33],34"meta": {35"has_more": true,36"after_cursor": "eyJvIjoibmljZV9pZCIsInYiOiJhUmtBQUFBQUFBQUEifQ==",37"before_cursor": null38},39"links": {40"prev": null,41"next": "https://your-domain.zendesk.com/api/v2/tickets/12345/comments.json?page[after]=eyJvIjoibmljZV9pZCIsInYiOiJhUmtBQUFBQUFBQUEifQ=="42}43}
List ticket fieldsCopy
Get a list of all the ticket fields.
Sample Input
1{2"page_size": 23}
Sample Output
1{2"ticket_fields": [3{4"url": "https://example.zendesk.com/api/v2/ticket_fields/123456",5"id": 123456,6"type": "text",7"title": "Subject",8"raw_title": "Subject",9"description": "Ticket subject",10"raw_description": "Ticket subject",11"position": 1,12"active": true,13"required": true,14"collapsed_for_agents": false,15"regexp_for_validation": null,16"title_in_portal": "Subject",17"raw_title_in_portal": "Subject",18"visible_in_portal": true,19"editable_in_portal": true,20"required_in_portal": true,21"tag": null,22"created_at": "2023-05-01T10:00:00Z",23"updated_at": "2023-05-01T10:00:00Z",24"removable": false,25"agent_description": "Enter the subject of the ticket"26},27{28"url": "https://example.zendesk.com/api/v2/ticket_fields/789012",29"id": 789012,30"type": "textarea",31"title": "Description",32"raw_title": "Description",33"description": "Ticket description",34"raw_description": "Ticket description",35"position": 2,36"active": true,37"required": true,38"collapsed_for_agents": false,39"regexp_for_validation": null,40"title_in_portal": "Description",41"raw_title_in_portal": "Description",42"visible_in_portal": true,43"editable_in_portal": true,44"required_in_portal": true,45"tag": null,46"created_at": "2023-05-01T10:00:00Z",47"updated_at": "2023-05-01T10:00:00Z",48"removable": false,49"agent_description": "Enter the description of the ticket"50}51],52"meta": {53"has_more": true,54"after_cursor": "eyJvIjoibmljZV9pZCIsInYiOiJhUmtBQUFBQUFBQUEifQ==",55"before_cursor": null56},57"links": {58"prev": null,59"next": "https://example.zendesk.com/api/v2/ticket_fields?page[size]=2&page[after]=eyJvIjoibmljZV9pZCIsInYiOiJhUmtBQUFBQUFBQUEifQ=="60}61}
List ticket formsCopy
List of all ticket forms for your account if accessed as an admin or agent.
Sample Input
1{2"ticket_status": "active",3"end_user_visibility": "visible",4"fallback_to_default": true,5"associated_to_brand": false6}
Sample Output
1{2"ticket_forms": [3{4"url": "https://example.zendesk.com/api/v2/ticket_forms/123456.json",5"id": 123456,6"name": "Customer Support Form",7"raw_name": "Customer Support Form",8"display_name": "Customer Support",9"raw_display_name": "Customer Support",10"end_user_visible": true,11"position": 1,12"ticket_field_ids": [13987654,14876543,1576543216],17"active": true,18"default": false,19"created_at": "2023-05-15T10:30:00Z",20"updated_at": "2023-05-20T14:45:00Z",21"in_all_brands": true,22"restricted_brand_ids": [],23"end_user_conditions": [24{25"child_fields": [26{27"id": 654321,28"is_required": true29}30],31"parent_field_id": 543210,32"value": "high_priority"33}34],35"agent_conditions": [36{37"child_fields": [38{39"id": 432109,40"is_required": true,41"required_on_statuses": {42"statuses": [43"open",44"pending"45],46"type": "inclusive"47}48}49],50"parent_field_id": 321098,51"value": "technical_issue"52}53]54}55],56"next_page": "https://example.zendesk.com/api/v2/ticket_forms.json?page=2",57"previous_page": null,58"count": 159}
List ticket tagsCopy
List the tags linked to a specific ticket.
Sample Input
1{2"ticket_id": 123453}
Sample Output
1{2"tags": [3"urgent",4"customer_support",5"billing_issue",6"high_priority",7"needs_follow_up"8]9}
List ticketsCopy
Get a list of all the tickets.
Sample Input
1{2"include": [3"users",4"organizations"5],6"sort_by": "updated_at",7"sort_order": "desc",8"page_size": 29}
Sample Output
1{2"tickets": [3{4"url": "https://company.zendesk.com/api/v2/tickets/35.json",5"id": 35,6"external_id": "ahg35",7"created_at": "2023-06-15T14:30:00Z",8"updated_at": "2023-06-15T15:45:00Z",9"type": "incident",10"subject": "Website down",11"raw_subject": "Website down",12"description": "Our company website is not loading for customers.",13"priority": "high",14"status": "open",15"requester_id": 20,16"submitter_id": 20,17"assignee_id": 15,18"organization_id": 5,19"group_id": 3,20"tags": [21"urgent",22"website"23],24"custom_fields": [25{26"id": 1,27"value": "IT"28}29],30"satisfaction_rating": null,31"ticket_form_id": 1,32"brand_id": 1,33"allow_channelback": false,34"allow_attachments": true35},36{37"url": "https://company.zendesk.com/api/v2/tickets/34.json",38"id": 34,39"external_id": "bhj34",40"created_at": "2023-06-15T10:00:00Z",41"updated_at": "2023-06-15T11:30:00Z",42"type": "question",43"subject": "How to reset password",44"raw_subject": "How to reset password",45"description": "I forgot my password and need help resetting it.",46"priority": "normal",47"status": "solved",48"requester_id": 21,49"submitter_id": 21,50"assignee_id": 16,51"organization_id": 6,52"group_id": 4,53"tags": [54"password",55"account"56],57"custom_fields": [58{59"id": 1,60"value": "Customer Support"61}62],63"satisfaction_rating": {64"score": "good",65"id": 1234,66"comment": "Quick and helpful response!"67},68"ticket_form_id": 2,69"brand_id": 1,70"allow_channelback": false,71"allow_attachments": true72}73],74"users": [75{76"id": 20,77"url": "https://company.zendesk.com/api/v2/users/20.json",78"name": "John Doe",79"email": "john.doe@example.com",80"created_at": "2023-01-01T00:00:00Z",81"updated_at": "2023-06-15T15:45:00Z",82"role": "end-user",83"verified": true,84"active": true85},86{87"id": 21,88"url": "https://company.zendesk.com/api/v2/users/21.json",89"name": "Jane Smith",90"email": "jane.smith@example.com",91"created_at": "2023-02-15T00:00:00Z",92"updated_at": "2023-06-15T11:30:00Z",93"role": "end-user",94"verified": true,95"active": true96}97],98"meta": {99"has_more": true,100"after_cursor": "eyJvIjoibmljZV9pZCIsInYiOiJhUmtBQUFBQUFBQUEifQ==",101"before_cursor": "eyJvIjoibmljZV9pZCIsInYiOiJhUmtBQUFBQUFBQUEifQ=="102},103"links": {104"prev": "https://company.zendesk.com/api/v2/tickets.json?page[before]=eyJvIjoibmljZV9pZCIsInYiOiJhUmtBQUFBQUFBQUEifQ==&page[size]=2",105"next": "https://company.zendesk.com/api/v2/tickets.json?page[after]=eyJvIjoibmljZV9pZCIsInYiOiJhUmtBQUFBQUFBQUEifQ==&page[size]=2"106}107}
List tickets for organizationCopy
Get a list of all the tickets for an organization.
Sample Input
1{2"organization_id": "123456",3"include": [4"users",5"groups"6],7"sort_by": "updated_at",8"sort_order": "desc",9"page_size": 5010}
Sample Output
1{2"tickets": [3{4"url": "https://example.zendesk.com/api/v2/tickets/1.json",5"id": 1,6"external_id": "ext-1",7"via": {8"channel": "web"9},10"created_at": "2023-05-01T10:00:00Z",11"updated_at": "2023-05-02T15:30:00Z",12"generated_timestamp": 1683036600,13"type": "incident",14"subject": "Cannot access account",15"raw_subject": "Cannot access account",16"description": "I am unable to log into my account. Please help.",17"priority": "high",18"status": "open",19"recipient": 12345,20"requester_id": 67890,21"submitter_id": 67890,22"assignee_id": 11111,23"organization_id": 123456,24"group_id": 22222,25"collaborator_ids": [2633333,274444428],29"follower_ids": [305555531],32"email_cc_ids": [336666634],35"forum_topic_id": null,36"problem_id": null,37"has_incidents": false,38"is_public": false,39"due_at": null,40"tags": [41"account",42"login"43],44"custom_fields": [45{46"id": 77777,47"value": "Premium"48}49],50"satisfaction_rating": null,51"sharing_agreement_ids": [],52"fields": [53{54"id": 88888,55"value": "High"56}57],58"comment_count": 3,59"followup_ids": [],60"ticket_form_id": 99999,61"brand_id": 12121,62"allow_channelback": true,63"allow_attachments": true,64"from_messaging_channel": false65}66],67"meta": {68"has_more": true,69"after_cursor": "eyJvIjoibmljZV9pZCIsInYiOiJhUmtBQUFBQUFBQUEifQ==",70"before_cursor": null71},72"links": {73"prev": null,74"next": "https://example.zendesk.com/api/v2/organizations/123456/tickets.json?page[after]=eyJvIjoibmljZV9pZCIsInYiOiJhUmtBQUFBQUFBQUEifQ=="75}76}
List tickets for userCopy
Get a list of all the tickets for a user.
Sample Input
1{2"user_id": 12345,3"include": [4"users",5"organizations"6],7"sort_by": "updated_at",8"sort_order": "desc",9"page_size": 5010}
Sample Output
1{2"tickets": [3{4"url": "https://example.zendesk.com/api/v2/tickets/1.json",5"id": 1,6"external_id": "abc123",7"via": {8"channel": "web"9},10"created_at": "2023-05-15T10:30:00Z",11"updated_at": "2023-05-16T14:45:00Z",12"generated_timestamp": 1684245900,13"type": "incident",14"subject": "Cannot access my account",15"raw_subject": "Cannot access my account",16"description": "I'm unable to log in to my account. It says my password is incorrect, but I'm sure it's right.",17"priority": "high",18"status": "open",19"recipient": 67890,20"requester_id": 12345,21"submitter_id": 12345,22"assignee_id": 54321,23"organization_id": 98765,24"group_id": 11111,25"collaborator_ids": [2622222,273333328],29"follower_ids": [304444431],32"email_cc_ids": [],33"forum_topic_id": null,34"problem_id": null,35"has_incidents": false,36"is_public": false,37"due_at": null,38"tags": [39"account",40"login",41"password"42],43"custom_fields": [44{45"id": 27384,46"value": "Chrome"47}48],49"satisfaction_rating": null,50"sharing_agreement_ids": [],51"fields": [52{53"id": 27384,54"value": "Chrome"55}56],57"followup_ids": [],58"ticket_form_id": 87654,59"brand_id": 55555,60"allow_channelback": false,61"allow_attachments": true,62"from_messaging_channel": false63}64],65"meta": {66"has_more": true,67"after_cursor": "eyJvIjoibmljZV9pZCIsInYiOiJhUmtBQUFBQUFBQUEifQ==",68"before_cursor": null69},70"links": {71"prev": null,72"next": "https://example.zendesk.com/api/v2/users/12345/tickets.json?page[after]=eyJvIjoibmljZV9pZCIsInYiOiJhUmtBQUFBQUFBQUEifQ=="73}74}
List translationsCopy
List all translations for a given article, section, or category.
Sample Input
1{2"translations_list_by": {3"article_id": "12345"4},5"page_size": 506}
Sample Output
1{2"meta": {3"after_cursor": "eyJvIjoiZGVzYyIsInYiOiIyMDIzLTA1LTEwVDE1OjMwOjAwWiJ9",4"before_cursor": "eyJvIjoiYXNjIiwidiI6IjIwMjMtMDUtMDFUMDk6MDA6MDBaIn0="5},6"links": {7"first": "https://api.zendesk.com/v2/help_center/articles/12345/translations.json?page[size]=50",8"last": "https://api.zendesk.com/v2/help_center/articles/12345/translations.json?page[size]=50&page[after]=eyJvIjoiZGVzYyIsInYiOiIyMDIzLTA1LTEwVDE1OjMwOjAwWiJ9",9"next": "https://api.zendesk.com/v2/help_center/articles/12345/translations.json?page[size]=50&page[after]=eyJvIjoiZGVzYyIsInYiOiIyMDIzLTA1LTA1VDEyOjAwOjAwWiJ9"10},11"translations": [12{13"id": 67890,14"url": "https://example.zendesk.com/api/v2/help_center/articles/12345/translations/67890.json",15"html_url": "https://example.zendesk.com/hc/en-us/articles/12345",16"source_id": 12345,17"source_type": "Article",18"locale": "en-us",19"title": "How to reset your password",20"body": "<p>Follow these steps to reset your password:</p><ol><li>Click on 'Forgot Password'</li><li>Enter your email address</li><li>Check your email for reset instructions</li><li>Follow the link to create a new password</li></ol>",21"outdated": false,22"draft": false,23"hidden": false,24"created_at": "2023-05-01T10:00:00Z",25"updated_at": "2023-05-05T14:30:00Z",26"updated_by_id": 98765,27"created_by_id": 5432128}29]30}
List triggersCopy
Retrieve a list of triggers for the current account.
Sample Input
1{2"active": "true",3"category_id": 123456,4"include": [5"app_installation",6"permissions"7],8"sort_by": "updated_at",9"sort_order": "desc",10"page_size": 5011}
Sample Output
1{2"triggers": [3{4"url": "https://example.zendesk.com/api/v2/triggers/1234567.json",5"id": 1234567,6"title": "Notify all agents of new ticket",7"active": true,8"updated_at": "2023-05-15T10:30:45Z",9"created_at": "2023-01-01T09:00:00Z",10"default": false,11"actions": [12{13"field": "notification_user",14"value": [15"all_agents"16]17},18{19"field": "notification_subject",20"value": [21"New ticket: {{ticket.title}}"22]23}24],25"conditions": {26"all": [27{28"field": "status",29"operator": "is",30"value": "new"31}32],33"any": []34},35"description": "Sends a notification to all agents when a new ticket is created",36"position": 1,37"raw_title": "Notify all agents of new ticket",38"category_id": "123456"39}40],41"meta": {42"has_more": true,43"after_cursor": "eyJvIjoibmljZV9pZCIsInYiOiJhUmtBQUFBQUFBQUEifQ==",44"before_cursor": null45},46"links": {47"prev": null,48"next": "https://example.zendesk.com/api/v2/triggers.json?page[after]=eyJvIjoibmljZV9pZCIsInYiOiJhUmtBQUFBQUFBQUEifQ=="49}50}
List user fieldsCopy
Retrieve a list of user fields.
Sample Input
1{2"page_size": 2,3"page_after": "eyJvIjoiMjAyMy0wNS0xNVQxMDowMDowMC4wMDBaIiwiZCI6ImFzYyJ9"4}
Sample Output
1{2"user_fields": [3{4"url": "https://example.zendesk.com/api/v2/user_fields/123456",5"id": 123456,6"type": "text",7"key": "customer_id",8"title": "Customer ID",9"description": "Unique identifier for the customer",10"raw_title": "Customer ID",11"raw_description": "Unique identifier for the customer",12"position": 1,13"active": true,14"system": false,15"regexp_for_validation": "^[A-Z]{2}\\d{6}$",16"created_at": "2023-05-01T09:00:00Z",17"updated_at": "2023-05-01T09:00:00Z"18},19{20"url": "https://example.zendesk.com/api/v2/user_fields/123457",21"id": 123457,22"type": "dropdown",23"key": "account_type",24"title": "Account Type",25"description": "Type of customer account",26"raw_title": "Account Type",27"raw_description": "Type of customer account",28"position": 2,29"active": true,30"system": false,31"regexp_for_validation": null,32"created_at": "2023-05-02T10:30:00Z",33"updated_at": "2023-05-02T10:30:00Z"34}35],36"meta": {37"has_more": true,38"after_cursor": "eyJvIjoiMjAyMy0wNS0wMlQxMDozMDowMC4wMDBaIiwiZCI6ImFzYyJ9",39"before_cursor": "eyJvIjoiMjAyMy0wNS0wMVQwOTowMDowMC4wMDBaIiwiZCI6ImRlc2MifQ=="40},41"links": {42"prev": "https://example.zendesk.com/api/v2/user_fields?page[size]=2&page[before]=eyJvIjoiMjAyMy0wNS0wMVQwOTowMDowMC4wMDBaIiwiZCI6ImRlc2MifQ==",43"next": "https://example.zendesk.com/api/v2/user_fields?page[size]=2&page[after]=eyJvIjoiMjAyMy0wNS0wMlQxMDozMDowMC4wMDBaIiwiZCI6ImFzYyJ9"44}45}
List user identitiesCopy
Get a list of all of a user's identities, including emails and phone numbers.
Sample Input
1{2"user_id": "123456",3"per_page": 50,4"next_page_token": "dXNlcl9pZD0xMjM0NTY="5}
Sample Output
1{2"identities": [3{4"url": "https://example.zendesk.com/api/v2/users/123456/identities/987654",5"id": 987654,6"user_id": 123456,7"type": "email",8"value": "john.doe@example.com",9"verified": true,10"primary": true,11"created_at": "2023-05-15T10:30:00Z",12"updated_at": "2023-05-15T10:30:00Z",13"undeliverable_count": 0,14"deliverable_state": "deliverable"15},16{17"url": "https://example.zendesk.com/api/v2/users/123456/identities/987655",18"id": 987655,19"user_id": 123456,20"type": "phone_number",21"value": "+1234567890",22"verified": false,23"primary": false,24"created_at": "2023-05-15T10:35:00Z",25"updated_at": "2023-05-15T10:35:00Z",26"undeliverable_count": 0,27"deliverable_state": "deliverable"28}29],30"meta": {31"has_more": true,32"after_cursor": "dXNlcl9pZD0xMjM0NTY=",33"before_cursor": null34},35"links": {36"prev": null,37"next": "https://example.zendesk.com/api/v2/users/123456/identities?page[after]=dXNlcl9pZD0xMjM0NTY="38}39}
Make user identity primaryCopy
Make one of a user's identities the primary identity.
Sample Input
1{2"user_id": "12345",3"identity_id": "67890"4}
Sample Output
1{2"identities": [3{4"url": "https://example.zendesk.com/api/v2/users/12345/identities/67890.json",5"id": 67890,6"user_id": 12345,7"type": "email",8"value": "john.doe@example.com",9"verified": true,10"primary": true,11"created_at": "2023-05-15T10:30:00Z",12"updated_at": "2023-05-15T10:35:00Z",13"undeliverable_count": 0,14"deliverable_state": "deliverable"15},16{17"url": "https://example.zendesk.com/api/v2/users/12345/identities/67891.json",18"id": 67891,19"user_id": 12345,20"type": "phone",21"value": "+1234567890",22"verified": true,23"primary": false,24"created_at": "2023-05-14T09:00:00Z",25"updated_at": "2023-05-14T09:00:00Z",26"undeliverable_count": 0,27"deliverable_state": "deliverable"28}29],30"next_page": null,31"previous_page": null,32"count": 233}
Raw HTTP request (advanced)Copy
Perform a raw HTTP request with some pre-configuration and processing by the connector, such as authentication.
Sample Input
1{2"method": "GET",3"url": {4"endpoint": "/api/v2/tickets.json"5},6"headers": [7{8"key": "Accept",9"value": "application/json"10}11],12"query_parameters": [13{14"key": "status",15"value": "open"16},17{18"key": "sort_by",19"value": "created_at"20}21],22"body": {23"none": null24},25"include_raw_body": false,26"parse_response": "true"27}
Sample Output
1{2"response": {3"status_code": 200,4"headers": {5"Content-Type": "application/json; charset=UTF-8",6"X-Zendesk-API-Version": "v2",7"X-Zendesk-Application-Version": "v1234"8},9"body": {10"tickets": [11{12"id": 35436,13"subject": "Help! My printer is on fire!",14"description": "I think my printer might be possessed. It started printing on its own and now it's smoking. What should I do?",15"status": "open",16"priority": "urgent",17"created_at": "2023-06-15T14:30:00Z"18},19{20"id": 35437,21"subject": "Cannot access my account",22"description": "I've forgotten my password and the reset link isn't working. Can you help me regain access to my account?",23"status": "open",24"priority": "high",25"created_at": "2023-06-15T15:45:00Z"26}27],28"next_page": "https://yoursubdomain.zendesk.com/api/v2/tickets.json?page=2",29"previous_page": null,30"count": 231}32}33}
SearchCopy
Search for tickets, users, and organizations by query parameter.
Sample Input
1{2"query": "status:open priority:high",3"sort_by": "created_at",4"sort_order": "desc",5"page": 1,6"per_page": 107}
Sample Output
1{2"count": 25,3"facets": null,4"next_page": "https://your-domain.zendesk.com/api/v2/search.json?page=2&query=status:open+priority:high",5"previous_page": null,6"results": [7{8"created_at": "2023-05-15T14:30:22Z",9"id": 12345,10"name": "Urgent server downtime issue",11"result_type": "ticket",12"updated_at": "2023-05-15T15:45:10Z",13"url": "https://your-domain.zendesk.com/api/v2/tickets/12345.json"14},15{16"created_at": "2023-05-14T09:12:05Z",17"id": 12344,18"name": "Critical payment gateway error",19"result_type": "ticket",20"updated_at": "2023-05-14T10:30:18Z",21"url": "https://your-domain.zendesk.com/api/v2/tickets/12344.json"22}23]24}
Search organization by nameCopy
Search for organizations using the name of the organization.
Sample Input
1{2"organization_name": "Acme Corporation"3}
Sample Output
1{2"results": [3{4"url": "https://example.zendesk.com/api/v2/organizations/123456.json",5"id": 123456,6"name": "Acme Corporation",7"shared_tickets": false,8"shared_comments": false,9"external_id": "acme_corp_123",10"created_at": "2023-05-15T10:30:00Z",11"updated_at": "2023-05-20T14:45:00Z",12"domain_names": [13"acmecorp.com",14"acme-support.com"15],16"details": "Global technology company",17"notes": "VIP customer, priority support",18"group_id": 78901,19"tags": [20"enterprise",21"tech",22"vip"23],24"organization_fields": {25"account_owner": "John Smith",26"csm": "Alice Johnson",27"region": "North America",28"tier": "Enterprise",29"salesforce_instance": "NA1",30"had_kick_off_call": true,31"external_id": "SF12345"32},33"result_type": "organization"34}35],36"facets": null,37"next_page": null,38"previous_page": null,39"count": 140}
Search organizations by External ID.Copy
Search for organizations using the value of an "External ID" field previously set.
Sample Input
1{2"external_id": "ACME123"3}
Sample Output
1{2"organizations": [3{4"url": "https://example.zendesk.com/api/v2/organizations/123456.json",5"id": 123456,6"name": "ACME Corporation",7"shared_tickets": false,8"shared_comments": false,9"external_id": "ACME123",10"created_at": "2023-05-15T10:30:00Z",11"updated_at": "2023-05-15T14:45:00Z",12"domain_names": [13"acme.com",14"acmecorp.com"15],16"details": "Global technology company",17"notes": "Key account, high priority",18"group_id": 78901,19"tags": [20"enterprise",21"tech",22"priority"23],24"organization_fields": {25"account_owner": "John Smith",26"api_dropdown_test": "Option A",27"csm": "Jane Doe",28"dropdown_test": "Choice 1",29"external_id": "ACME123",30"had_kick_off_call": true,31"region": "North America",32"salesforce_instance": "NA1",33"tier": "Enterprise",34"workflow_dropdown": "Active"35}36}37],38"next_page": null,39"previous_page": null,40"count": 141}
Update organizationCopy
Update an organization.
Sample Input
1{2"organization_id": 123456,3"name": "Acme Corporation",4"external_id": "ACME001",5"domain_names": [6"acme.com",7"acmecorp.com"8],9"details": "Global technology company",10"notes": "Key account, high priority",11"group_id": 78901,12"shared_tickets": true,13"shared_comments": false,14"tags": [15"enterprise",16"technology",17"vip"18],19"organization_fields": [20{21"key": "account_manager",22"value": "John Doe"23},24{25"key": "contract_renewal_date",26"value": "2023-12-31"27}28]29}
Sample Output
1{2"organization": {3"url": "https://example.zendesk.com/api/v2/organizations/123456",4"id": 123456,5"name": "Acme Corporation",6"shared_tickets": true,7"shared_comments": false,8"external_id": "ACME001",9"created_at": "2022-01-15T09:00:00Z",10"updated_at": "2023-06-01T14:30:00Z",11"domain_names": [12"acme.com",13"acmecorp.com"14],15"details": "Global technology company",16"notes": "Key account, high priority",17"group_id": 78901,18"tags": [19"enterprise",20"technology",21"vip"22],23"organization_fields": {24"account_manager": "John Doe",25"contract_renewal_date": "2023-12-31"26}27}28}
Update organization fieldCopy
Update an organization field using a specified organization ID.
Sample Input
1{2"organization_field_id": 123456,3"title": "Customer Size",4"description": "Number of employees in the customer's organization",5"position": 2,6"active": true,7"dropdown_options": [8{9"name": "Small",10"value": "1-50",11"id": 112},13{14"name": "Medium",15"value": "51-250",16"id": 217},18{19"name": "Large",20"value": "251+",21"id": 322}23]24}
Sample Output
1{2"organization_field": {3"url": "https://example.zendesk.com/api/v2/organization_fields/123456",4"id": 123456,5"type": "dropdown",6"key": "customer_size",7"title": "Customer Size",8"description": "Number of employees in the customer's organization",9"raw_title": "Customer Size",10"raw_description": "Number of employees in the customer's organization",11"position": 2,12"active": true,13"system": false,14"regexp_for_validation": null,15"created_at": "2023-05-15T10:30:00Z",16"updated_at": "2023-05-15T14:45:00Z",17"custom_field_options": [18{19"id": 1,20"name": "Small",21"raw_name": "Small",22"value": "1-50"23},24{25"id": 2,26"name": "Medium",27"raw_name": "Medium",28"value": "51-250"29},30{31"id": 3,32"name": "Large",33"raw_name": "Large",34"value": "251+"35}36]37}38}
Update ticketCopy
Update information about a ticket.
Sample Input
1{2"ticket_id": 12345,3"subject": "Updated: Issue with login page",4"comment": {5"body": "We've made progress on resolving the login issue. Please try again and let us know if you're still experiencing problems.",6"public": true,7"author_id": "1234567890"8},9"status": "open",10"priority": "high",11"assignee_id": 9876,12"tags": [13"login",14"website",15"in-progress"16],17"custom_fields": [18{19"id": 360001234567,20"value": "Web team"21}22]23}
Sample Output
1{2"ticket": {3"url": "https://example.zendesk.com/api/v2/tickets/12345.json",4"id": 12345,5"external_id": null,6"via": {7"channel": "api",8"source": {9"from": {},10"to": {},11"rel": null12}13},14"created_at": "2023-06-15T10:30:00Z",15"updated_at": "2023-06-15T14:45:00Z",16"type": "incident",17"subject": "Updated: Issue with login page",18"raw_subject": "Updated: Issue with login page",19"description": "We've made progress on resolving the login issue. Please try again and let us know if you're still experiencing problems.",20"priority": "high",21"status": "open",22"recipient": "customer@example.com",23"requester_id": 67890,24"submitter_id": 1234567890,25"assignee_id": 9876,26"organization_id": 5678,27"group_id": 1122,28"collaborator_ids": [],29"follower_ids": [],30"email_cc_ids": [],31"forum_topic_id": null,32"problem_id": null,33"has_incidents": false,34"is_public": true,35"due_at": null,36"tags": [37"login",38"website",39"in-progress"40],41"custom_fields": [42{43"id": 360001234567,44"value": "Web team"45}46],47"satisfaction_rating": null,48"sharing_agreement_ids": [],49"fields": [50{51"id": 360001234567,52"value": "Web team"53}54],55"followup_ids": [],56"ticket_form_id": 98765,57"brand_id": 123456,58"satisfaction_probability": null,59"allow_channelback": true,60"allow_attachments": true61},62"audit": {63"id": 987654321,64"ticket_id": 12345,65"created_at": "2023-06-15T14:45:00Z",66"author_id": 1234567890,67"metadata": {68"system": {69"client": "Tray.io",70"ip_address": "203.0.113.0",71"location": "San Francisco, CA, United States",72"latitude": 37.7749,73"longitude": -122.419474},75"custom": {}76},77"events": [78{79"id": 456789,80"type": "Comment",81"author_id": 1234567890,82"body": "We've made progress on resolving the login issue. Please try again and let us know if you're still experiencing problems.",83"html_body": "<p>We've made progress on resolving the login issue. Please try again and let us know if you're still experiencing problems.</p>",84"plain_body": "We've made progress on resolving the login issue. Please try again and let us know if you're still experiencing problems.",85"public": true,86"attachments": [],87"audit_id": 987654321,88"via": {89"channel": "api",90"source": {91"from": {},92"to": {},93"rel": null94}95}96}97],98"via": {99"channel": "api",100"source": {101"from": {},102"to": {},103"rel": null104}105}106}107}
Update userCopy
Update an existing user.
Sample Input
1{2"user_id": 12345,3"name": "John Smith",4"email": "john.smith@example.com",5"role": "agent",6"phone": "+1 555-123-4567",7"organization_id": 67890,8"alias": "JS",9"locale": "en-US",10"time_zone": "America/New_York",11"signature": "Best regards,\nJohn Smith\nCustomer Support",12"tags": [13"vip",14"priority"15],16"ticket_restriction": "groups",17"user_fields": [18{19"key": "department",20"value": "Sales"21},22{23"key": "employee_id",24"value": "EMP001"25}26],27"notes": "Experienced agent with excellent customer service skills",28"details": "Office location: New York",29"external_id": "EXT12345"30}
Sample Output
1{2"user": {3"id": 12345,4"url": "https://example.zendesk.com/api/v2/users/12345.json",5"name": "John Smith",6"email": "john.smith@example.com",7"created_at": "2023-01-15T10:00:00Z",8"updated_at": "2023-06-01T14:30:00Z",9"time_zone": "America/New_York",10"iana_time_zone": "America/New_York",11"phone": "+1 555-123-4567",12"shared_phone_number": false,13"photo": {14"id": 98765,15"name": "john_smith.jpg",16"content_url": "https://example.zendesk.com/system/photos/9876/5432/john_smith.jpg",17"content_type": "image/jpeg",18"size": 12345,19"thumbnails": [20{21"id": 54321,22"name": "john_smith_thumb.jpg",23"content_url": "https://example.zendesk.com/system/photos/5432/1098/john_smith_thumb.jpg",24"content_type": "image/jpeg",25"size": 567826}27]28},29"locale_id": 1,30"locale": "en-US",31"organization_id": 67890,32"role": "agent",33"verified": true,34"external_id": "EXT12345",35"tags": [36"vip",37"priority"38],39"alias": "JS",40"active": true,41"shared": false,42"shared_agent": false,43"last_login_at": "2023-05-31T09:15:00Z",44"two_factor_auth_enabled": true,45"signature": "Best regards,\nJohn Smith\nCustomer Support",46"details": "Office location: New York",47"notes": "Experienced agent with excellent customer service skills",48"role_type": null,49"custom_role_id": null,50"moderator": false,51"ticket_restriction": "groups",52"only_private_comments": false,53"restricted_agent": false,54"suspended": false,55"chat_only": false,56"default_group_id": 11111,57"report_csv": true,58"user_fields": {59"department": "Sales",60"employee_id": "EMP001"61}62}63}
Update user fieldCopy
Update information about a user field.
Sample Input
1{2"user_field_id": 123456,3"field_type": "text",4"title": "Customer Preference",5"raw_title": "{{dc.customer_preference}}",6"description": "Customer's preferred communication method",7"raw_description": "{{dc.customer_preference_description}}",8"position": 3,9"active": true,10"regexp_for_validation": "^(email|phone|mail)$"11}
Sample Output
1{2"user_field": {3"url": "https://example.zendesk.com/api/v2/user_fields/123456",4"id": 123456,5"type": "text",6"key": "customer_preference",7"title": "Customer Preference",8"description": "Customer's preferred communication method",9"raw_title": "{{dc.customer_preference}}",10"raw_description": "{{dc.customer_preference_description}}",11"position": 3,12"active": true,13"system": false,14"regexp_for_validation": "^(email|phone|mail)$",15"created_at": "2023-05-15T10:30:00Z",16"updated_at": "2023-05-15T14:45:00Z"17}18}
Upload attachmentCopy
Upload a file attachment to Zendesk. A token will be returned, allowing you to attach files to tickets.
Sample Input
1{2"file": {3"name": "example.pdf",4"content": "base64_encoded_file_content_here"5},6"file_name": "support_document.pdf"7}
Sample Output
1{2"upload": {3"token": "6bk3gql5ktbm7tqkt8lfTa",4"expires_at": "2023-05-15T10:30:00Z",5"attachments": [6{7"url": "https://company.zendesk.com/api/v2/attachments/123456789.json",8"id": 123456789,9"file_name": "support_document.pdf",10"content_url": "https://company.zendesk.com/attachments/token/abcdefghijklmnop/?name=support_document.pdf",11"mapped_content_url": "https://company.zendesk.com/attachments/token/abcdefghijklmnop/?name=support_document.pdf",12"content_type": "application/pdf",13"size": 1024000,14"width": null,15"height": null,16"inline": false,17"deleted": false,18"thumbnails": []19}20],21"attachment": {22"url": "https://company.zendesk.com/api/v2/attachments/123456789.json",23"id": 123456789,24"file_name": "support_document.pdf",25"content_url": "https://company.zendesk.com/attachments/token/abcdefghijklmnop/?name=support_document.pdf",26"mapped_content_url": "https://company.zendesk.com/attachments/token/abcdefghijklmnop/?name=support_document.pdf",27"content_type": "application/pdf",28"size": 1024000,29"width": null,30"height": null,31"inline": false,32"deleted": false,33"thumbnails": []34}35}36}
DDL operationsCopy
List agents (DDL)Copy
Note that DDL operations can only be called directly by Connectors API, or when using CustomJS in the Embedded solution editor for e.g. DDL-dependent data mapping
Sample Input
1{}
Sample Output
1[2{3"id": 1234567,4"name": "John Doe",5"email": "johndoe@example.com",6"role": "agent",7"active": true,8"time_zone": "America/Los_Angeles",9"phone": "+1 555-123-4567",10"created_at": "2023-05-15T09:30:00Z",11"updated_at": "2023-05-15T09:30:00Z"12},13{14"id": 2345678,15"name": "Jane Smith",16"email": "janesmith@example.com",17"role": "admin",18"active": true,19"time_zone": "Europe/London",20"phone": "+44 20 1234 5678",21"created_at": "2023-05-14T14:45:00Z",22"updated_at": "2023-05-15T10:15:00Z"23}24]
List article attachments (DDL)Copy
Note that DDL operations can only be called directly by Connectors API, or when using CustomJS in the Embedded solution editor for e.g. DDL-dependent data mapping
Sample Input
1{}
Sample Output
1{2"data": [3{4"id": 123456789,5"url": "https://company.zendesk.com/api/v2/help_center/articles/987654321/attachments/123456789.json",6"article_id": 987654321,7"file_name": "product_manual.pdf",8"content_url": "https://company.zendesk.com/hc/article_attachments/123456789/product_manual.pdf",9"content_type": "application/pdf",10"size": 2048000,11"inline": false,12"created_at": "2023-05-15T10:30:00Z",13"updated_at": "2023-05-15T10:30:00Z"14},15{16"id": 987654321,17"url": "https://company.zendesk.com/api/v2/help_center/articles/987654321/attachments/987654321.json",18"article_id": 987654321,19"file_name": "setup_instructions.docx",20"content_url": "https://company.zendesk.com/hc/article_attachments/987654321/setup_instructions.docx",21"content_type": "application/vnd.openxmlformats-officedocument.wordprocessingml.document",22"size": 1024000,23"inline": true,24"created_at": "2023-05-14T15:45:00Z",25"updated_at": "2023-05-14T15:45:00Z"26}27],28"next_page": null,29"previous_page": null,30"count": 231}
List article comments (DDL)Copy
Note that DDL operations can only be called directly by Connectors API, or when using CustomJS in the Embedded solution editor for e.g. DDL-dependent data mapping
Sample Input
1{}
Sample Output
1{2"data": [3{4"id": 123456,5"article_id": 987654,6"author_id": 654321,7"body": "This article was very helpful. Thank you!",8"created_at": "2023-05-15T10:30:00Z",9"updated_at": "2023-05-15T10:30:00Z",10"votes": 5,11"vote_sum": 5,12"official": false,13"public": true14},15{16"id": 123457,17"article_id": 987654,18"author_id": 654322,19"body": "Could you please provide more examples?",20"created_at": "2023-05-16T14:45:00Z",21"updated_at": "2023-05-16T14:45:00Z",22"votes": 2,23"vote_sum": 2,24"official": false,25"public": true26}27],28"next_page": "https://your-subdomain.zendesk.com/api/v2/help_center/articles/987654/comments.json?page=2",29"previous_page": null,30"count": 231}
List articles (DDL)Copy
Note that DDL operations can only be called directly by Connectors API, or when using CustomJS in the Embedded solution editor for e.g. DDL-dependent data mapping
Sample Input
1{}
Sample Output
1{2"articles": [3{4"id": 123456,5"url": "https://example.zendesk.com/api/v2/help_center/en-us/articles/123456.json",6"html_url": "https://example.zendesk.com/hc/en-us/articles/123456-Sample-Article-Title",7"title": "Sample Article Title",8"body": "This is the content of the sample article.",9"author_id": 987654,10"comments_disabled": false,11"draft": false,12"promoted": false,13"position": 0,14"vote_sum": 5,15"vote_count": 10,16"section_id": 789012,17"created_at": "2023-05-15T10:30:00Z",18"updated_at": "2023-05-16T14:45:00Z",19"locale": "en-us"20},21{22"id": 234567,23"url": "https://example.zendesk.com/api/v2/help_center/en-us/articles/234567.json",24"html_url": "https://example.zendesk.com/hc/en-us/articles/234567-Another-Article-Example",25"title": "Another Article Example",26"body": "This is the content of another sample article.",27"author_id": 876543,28"comments_disabled": true,29"draft": true,30"promoted": false,31"position": 1,32"vote_sum": 2,33"vote_count": 3,34"section_id": 890123,35"created_at": "2023-05-14T09:15:00Z",36"updated_at": "2023-05-15T11:20:00Z",37"locale": "en-us"38}39],40"next_page": "https://example.zendesk.com/api/v2/help_center/articles.json?page=2",41"previous_page": null,42"count": 243}
List audits for a ticket (DDL)Copy
Note that DDL operations can only be called directly by Connectors API, or when using CustomJS in the Embedded solution editor for e.g. DDL-dependent data mapping
Sample Input
1{}
Sample Output
1{2"audits": [3{4"id": 123456789,5"ticket_id": 987654,6"created_at": "2023-05-15T10:30:00Z",7"author_id": 12345,8"events": [9{10"id": 987654321,11"type": "Comment",12"author_id": 12345,13"body": "This is a comment added to the ticket.",14"public": true,15"created_at": "2023-05-15T10:30:00Z"16},17{18"id": 987654322,19"type": "Change",20"field_name": "status",21"value": "open",22"previous_value": "new"23}24]25},26{27"id": 123456790,28"ticket_id": 987654,29"created_at": "2023-05-15T11:45:00Z",30"author_id": 67890,31"events": [32{33"id": 987654323,34"type": "Change",35"field_name": "priority",36"value": "high",37"previous_value": "normal"38}39]40}41],42"next_page": "https://your-subdomain.zendesk.com/api/v2/tickets/987654/audits.json?page=2",43"previous_page": null,44"count": 245}
List categories (DDL)Copy
Note that DDL operations can only be called directly by Connectors API, or when using CustomJS in the Embedded solution editor for e.g. DDL-dependent data mapping
Sample Input
1{}
Sample Output
1[2{3"id": 123456,4"name": "General Support",5"description": "General customer support inquiries",6"position": 1,7"created_at": "2023-05-01T10:00:00Z",8"updated_at": "2023-05-01T10:00:00Z"9},10{11"id": 234567,12"name": "Technical Issues",13"description": "Technical problems and troubleshooting",14"position": 2,15"created_at": "2023-05-01T10:15:00Z",16"updated_at": "2023-05-01T10:15:00Z"17},18{19"id": 345678,20"name": "Billing",21"description": "Billing and payment related queries",22"position": 3,23"created_at": "2023-05-01T10:30:00Z",24"updated_at": "2023-05-01T10:30:00Z"25}26]
List custom user roles (DDL)Copy
Note that DDL operations can only be called directly by Connectors API, or when using CustomJS in the Embedded solution editor for e.g. DDL-dependent data mapping
Sample Input
1{}
Sample Output
1{2"custom_roles": [3{4"id": 1234567,5"name": "Support Specialist",6"description": "Handles customer support tickets",7"created_at": "2023-05-15T10:30:00Z",8"updated_at": "2023-05-15T10:30:00Z",9"role_type": "custom"10},11{12"id": 2345678,13"name": "Billing Manager",14"description": "Manages billing and invoicing",15"created_at": "2023-05-16T09:15:00Z",16"updated_at": "2023-05-16T09:15:00Z",17"role_type": "custom"18},19{20"id": 3456789,21"name": "Product Specialist",22"description": "Handles product-related inquiries",23"created_at": "2023-05-17T14:45:00Z",24"updated_at": "2023-05-17T14:45:00Z",25"role_type": "custom"26}27]28}
List groups (DDL)Copy
Note that DDL operations can only be called directly by Connectors API, or when using CustomJS in the Embedded solution editor for e.g. DDL-dependent data mapping
Sample Input
1{}
Sample Output
1[2{3"id": 123456,4"name": "Support Team",5"url": "https://example.zendesk.com/api/v2/groups/123456.json",6"deleted": false,7"created_at": "2023-05-15T10:30:00Z",8"updated_at": "2023-05-15T10:30:00Z"9},10{11"id": 234567,12"name": "Sales Team",13"url": "https://example.zendesk.com/api/v2/groups/234567.json",14"deleted": false,15"created_at": "2023-05-15T11:00:00Z",16"updated_at": "2023-05-15T11:00:00Z"17},18{19"id": 345678,20"name": "Product Team",21"url": "https://example.zendesk.com/api/v2/groups/345678.json",22"deleted": false,23"created_at": "2023-05-15T11:30:00Z",24"updated_at": "2023-05-15T11:30:00Z"25}26]
List labels (DDL)Copy
Note that DDL operations can only be called directly by Connectors API, or when using CustomJS in the Embedded solution editor for e.g. DDL-dependent data mapping
Sample Input
1{}
Sample Output
1{2"labels": [3{4"id": 123456,5"name": "billing",6"created_at": "2023-05-15T10:30:00Z",7"updated_at": "2023-05-15T10:30:00Z"8},9{10"id": 234567,11"name": "technical_support",12"created_at": "2023-05-14T09:15:00Z",13"updated_at": "2023-05-14T09:15:00Z"14},15{16"id": 345678,17"name": "feature_request",18"created_at": "2023-05-13T14:45:00Z",19"updated_at": "2023-05-13T14:45:00Z"20}21]22}
List locales (DDL)Copy
Note that DDL operations can only be called directly by Connectors API, or when using CustomJS in the Embedded solution editor for e.g. DDL-dependent data mapping
Sample Input
1{}
Sample Output
1{2"locales": [3{4"id": 1,5"locale": "en-US",6"name": "English (United States)",7"native_name": "English (United States)",8"presentation_name": "English (United States)",9"rtl": false,10"default": true11},12{13"id": 2,14"locale": "es",15"name": "Spanish",16"native_name": "Español",17"presentation_name": "Español",18"rtl": false,19"default": false20},21{22"id": 3,23"locale": "fr",24"name": "French",25"native_name": "Français",26"presentation_name": "Français",27"rtl": false,28"default": false29}30]31}
List organization fields ID (DDL)Copy
Note that DDL operations can only be called directly by Connectors API, or when using CustomJS in the Embedded solution editor for e.g. DDL-dependent data mapping
Sample Input
1{}
Sample Output
1[2{3"id": 360000246234,4"title": "Industry"5},6{7"id": 360000246254,8"title": "Company Size"9},10{11"id": 360000246274,12"title": "Annual Revenue"13},14{15"id": 360000246294,16"title": "Region"17}18]
List organization fields key (DDL)Copy
Note that DDL operations can only be called directly by Connectors API, or when using CustomJS in the Embedded solution editor for e.g. DDL-dependent data mapping
Sample Input
1{}
Sample Output
1[2{3"id": 360000001234,4"key": "account_type",5"title": "Account Type",6"description": "The type of account this organization has",7"type": "dropdown",8"raw_title": "Account Type",9"raw_description": "The type of account this organization has",10"position": 1,11"active": true,12"system": false,13"regexp_for_validation": null,14"created_at": "2023-05-15T10:30:00Z",15"updated_at": "2023-05-15T10:30:00Z"16},17{18"id": 360000005678,19"key": "industry",20"title": "Industry",21"description": "The industry this organization belongs to",22"type": "text",23"raw_title": "Industry",24"raw_description": "The industry this organization belongs to",25"position": 2,26"active": true,27"system": false,28"regexp_for_validation": null,29"created_at": "2023-05-15T10:35:00Z",30"updated_at": "2023-05-15T10:35:00Z"31}32]
List organizations (DDL)Copy
Note that DDL operations can only be called directly by Connectors API, or when using CustomJS in the Embedded solution editor for e.g. DDL-dependent data mapping
Sample Input
1{}
Sample Output
1{2"organizations": [3{4"id": 361215832,5"url": "https://example.zendesk.com/api/v2/organizations/361215832.json",6"name": "Acme Corporation",7"shared_tickets": false,8"shared_comments": false,9"external_id": "acme_123",10"created_at": "2023-05-15T09:30:47Z",11"updated_at": "2023-05-15T09:30:47Z",12"domain_names": [13"acme.com",14"acmecorp.com"15],16"details": "Global technology company",17"notes": "VIP customer",18"group_id": null,19"tags": [20"enterprise",21"technology"22],23"organization_fields": {24"account_manager": "John Doe",25"support_level": "Premium"26}27},28{29"id": 361215833,30"url": "https://example.zendesk.com/api/v2/organizations/361215833.json",31"name": "TechStart Inc.",32"shared_tickets": true,33"shared_comments": true,34"external_id": "techstart_456",35"created_at": "2023-05-16T14:22:33Z",36"updated_at": "2023-05-16T14:22:33Z",37"domain_names": [38"techstart.io"39],40"details": "Startup in AI and machine learning",41"notes": "Rapidly growing customer",42"group_id": 12345,43"tags": [44"startup",45"ai"46],47"organization_fields": {48"account_manager": "Jane Smith",49"support_level": "Standard"50}51}52],53"next_page": "https://example.zendesk.com/api/v2/organizations.json?page=2",54"previous_page": null,55"count": 256}
List sections (DDL)Copy
Note that DDL operations can only be called directly by Connectors API, or when using CustomJS in the Embedded solution editor for e.g. DDL-dependent data mapping
Sample Input
1{}
Sample Output
1[2{3"id": 360000123456,4"name": "General Information",5"description": "General information about our products and services",6"locale": "en-us",7"source_locale": "en-us",8"url": "https://example.zendesk.com/hc/en-us/categories/360000123456-General-Information",9"position": 0,10"access_policy": "viewable_by_all",11"outdated": false,12"created_at": "2023-05-15T10:30:00Z",13"updated_at": "2023-05-15T10:30:00Z"14},15{16"id": 360000123457,17"name": "Troubleshooting",18"description": "Common issues and their solutions",19"locale": "en-us",20"source_locale": "en-us",21"url": "https://example.zendesk.com/hc/en-us/categories/360000123457-Troubleshooting",22"position": 1,23"access_policy": "viewable_by_all",24"outdated": false,25"created_at": "2023-05-15T10:35:00Z",26"updated_at": "2023-05-15T10:35:00Z"27}28]
List ticket active custom fields (DDL)Copy
Note that DDL operations can only be called directly by Connectors API, or when using CustomJS in the Embedded solution editor for e.g. DDL-dependent data mapping
Sample Input
1{}
Sample Output
1[2{3"id": 360001234567,4"title": "Priority",5"type": "dropdown",6"options": [7{8"id": 360001111111,9"name": "Low",10"value": "low"11},12{13"id": 360002222222,14"name": "Medium",15"value": "medium"16},17{18"id": 360003333333,19"name": "High",20"value": "high"21}22]23},24{25"id": 360009876543,26"title": "Product",27"type": "text",28"options": []29},30{31"id": 360005555555,32"title": "Due Date",33"type": "date",34"options": []35}36]
List ticket active fields (DDL)Copy
Note that DDL operations can only be called directly by Connectors API, or when using CustomJS in the Embedded solution editor for e.g. DDL-dependent data mapping
Sample Input
1{}
Sample Output
1[2{3"id": 360001234567,4"title": "Subject",5"type": "subject",6"description": "Ticket subject",7"position": 1,8"active": true,9"required": true,10"collapsed_for_agents": false,11"regexp_for_validation": null,12"title_in_portal": "Subject",13"visible_in_portal": true,14"editable_in_portal": true,15"required_in_portal": true,16"tag": null,17"created_at": "2023-05-01T10:00:00Z",18"updated_at": "2023-05-01T10:00:00Z"19},20{21"id": 360001234568,22"title": "Description",23"type": "description",24"description": "Ticket description",25"position": 2,26"active": true,27"required": true,28"collapsed_for_agents": false,29"regexp_for_validation": null,30"title_in_portal": "Description",31"visible_in_portal": true,32"editable_in_portal": true,33"required_in_portal": true,34"tag": null,35"created_at": "2023-05-01T10:00:00Z",36"updated_at": "2023-05-01T10:00:00Z"37},38{39"id": 360001234569,40"title": "Status",41"type": "status",42"description": "Ticket status",43"position": 3,44"active": true,45"required": true,46"collapsed_for_agents": false,47"regexp_for_validation": null,48"title_in_portal": "Status",49"visible_in_portal": true,50"editable_in_portal": false,51"required_in_portal": false,52"tag": null,53"created_at": "2023-05-01T10:00:00Z",54"updated_at": "2023-05-01T10:00:00Z"55}56]
List ticket forms (DDL)Copy
Note that DDL operations can only be called directly by Connectors API, or when using CustomJS in the Embedded solution editor for e.g. DDL-dependent data mapping
Sample Input
1{}
Sample Output
1[2{3"id": 360000246813,4"name": "General Support Request",5"raw_name": "General Support Request",6"display_name": "General Support Request",7"end_user_visible": true,8"position": 1,9"active": true,10"default": true,11"created_at": "2023-05-15T10:30:00Z",12"updated_at": "2023-05-15T10:30:00Z"13},14{15"id": 360000246814,16"name": "Bug Report",17"raw_name": "Bug Report",18"display_name": "Bug Report",19"end_user_visible": true,20"position": 2,21"active": true,22"default": false,23"created_at": "2023-05-15T10:35:00Z",24"updated_at": "2023-05-15T10:35:00Z"25},26{27"id": 360000246815,28"name": "Feature Request",29"raw_name": "Feature Request",30"display_name": "Feature Request",31"end_user_visible": true,32"position": 3,33"active": true,34"default": false,35"created_at": "2023-05-15T10:40:00Z",36"updated_at": "2023-05-15T10:40:00Z"37}38]
List ticket tags (DDL)Copy
Note that DDL operations can only be called directly by Connectors API, or when using CustomJS in the Embedded solution editor for e.g. DDL-dependent data mapping
Sample Input
1{}
Sample Output
1{2"tags": [3"support",4"urgent",5"billing",6"feature_request",7"bug",8"customer_service",9"high_priority",10"new_user",11"technical_issue",12"feedback"13]14}
List user fields (DDL)Copy
Note that DDL operations can only be called directly by Connectors API, or when using CustomJS in the Embedded solution editor for e.g. DDL-dependent data mapping
Sample Input
1{}
Sample Output
1[2{3"id": 360001234567,4"url": "https://your-domain.zendesk.com/api/v2/user_fields/360001234567.json",5"key": "customer_type",6"type": "dropdown",7"title": "Customer Type",8"description": "Type of customer",9"raw_title": "Customer Type",10"raw_description": "Type of customer",11"position": 1,12"active": true,13"system": false,14"regexp_for_validation": null,15"created_at": "2023-05-15T10:30:00Z",16"updated_at": "2023-05-15T10:30:00Z",17"tag": null,18"custom_field_options": [19{20"id": 360002345678,21"name": "Enterprise",22"raw_name": "Enterprise",23"value": "enterprise"24},25{26"id": 360002345679,27"name": "Small Business",28"raw_name": "Small Business",29"value": "small_business"30},31{32"id": 360002345680,33"name": "Individual",34"raw_name": "Individual",35"value": "individual"36}37]38},39{40"id": 360001234568,41"url": "https://your-domain.zendesk.com/api/v2/user_fields/360001234568.json",42"key": "account_manager",43"type": "text",44"title": "Account Manager",45"description": "Name of the assigned account manager",46"raw_title": "Account Manager",47"raw_description": "Name of the assigned account manager",48"position": 2,49"active": true,50"system": false,51"regexp_for_validation": null,52"created_at": "2023-05-15T11:00:00Z",53"updated_at": "2023-05-15T11:00:00Z",54"tag": null,55"custom_field_options": []56}57]
List user fields keys (DDL)Copy
Note that DDL operations can only be called directly by Connectors API, or when using CustomJS in the Embedded solution editor for e.g. DDL-dependent data mapping
Sample Input
1{}
Sample Output
1[2{3"key": "user_field_1",4"label": "Custom Field 1"5},6{7"key": "user_field_2",8"label": "Custom Field 2"9},10{11"key": "user_field_3",12"label": "Custom Field 3"13},14{15"key": "department",16"label": "Department"17},18{19"key": "employee_id",20"label": "Employee ID"21}22]
List user identities (DDL)Copy
Note that DDL operations can only be called directly by Connectors API, or when using CustomJS in the Embedded solution editor for e.g. DDL-dependent data mapping
Sample Input
1{}
Sample Output
1{2"identities": [3{4"id": 123456,5"user_id": 987654,6"type": "email",7"value": "john.doe@example.com",8"verified": true,9"primary": true,10"created_at": "2023-05-15T10:30:00Z",11"updated_at": "2023-05-15T10:30:00Z"12},13{14"id": 234567,15"user_id": 987654,16"type": "phone_number",17"value": "+1-555-123-4567",18"verified": false,19"primary": false,20"created_at": "2023-05-15T10:31:00Z",21"updated_at": "2023-05-15T10:31:00Z"22}23],24"next_page": null,25"previous_page": null,26"count": 227}
List users (DDL)Copy
Note that DDL operations can only be called directly by Connectors API, or when using CustomJS in the Embedded solution editor for e.g. DDL-dependent data mapping
Sample Input
1{}
Sample Output
1[2{3"id": 1234567890,4"name": "John Doe",5"email": "johndoe@example.com",6"created_at": "2023-05-15T10:30:00Z",7"updated_at": "2023-05-15T10:30:00Z",8"time_zone": "America/New_York",9"phone": "+1 555-123-4567",10"role": "agent",11"verified": true,12"active": true,13"last_login_at": "2023-05-15T09:45:00Z",14"locale": "en-US",15"organization_id": 9876543210,16"tags": [17"support",18"tier1"19]20},21{22"id": 2345678901,23"name": "Jane Smith",24"email": "janesmith@example.com",25"created_at": "2023-05-14T14:20:00Z",26"updated_at": "2023-05-14T14:20:00Z",27"time_zone": "Europe/London",28"phone": "+44 20 1234 5678",29"role": "admin",30"verified": true,31"active": true,32"last_login_at": "2023-05-15T08:30:00Z",33"locale": "en-GB",34"organization_id": 9876543210,35"tags": [36"management",37"billing"38]39}40]