Integration · Customer support
Connect Claude & ChatGPT to Deskpro
Ask your AI what is sitting in your Deskpro views, what a customer has asked before, or to answer a ticket. It can search tickets, people, organizations and articles, read ticket messages, reply or add internal notes, and change status, agent, department and urgency. It can also keep people, organizations, knowledge base articles and agent tasks up to date.
Connect Deskpro free
Free plan, no credit card. Takes about a minute.
Try asking
“What is in the Unassigned view?”
The AI lists your saved ticket filters and shows the tickets in Unassigned.
“Summarize ticket 4821 and what has been said so far.”
It reads the ticket and its replies and notes and sums up the case.
“Reply to ticket 4821 that the fix is live.”
It adds the reply, which Deskpro emails to the requester. A reply cannot be unsent, so you can have it post an internal note instead.
What your AI can do
Tickets
Search and read tickets, list saved filters, create tickets, reply or add notes, and change status, agent, department and urgency.
People and organizations
Find people and organizations, read and update them, add notes and see their tickets.
Knowledge base and tasks
List, read, create and update knowledge base articles, and create and update agent tasks.
“Assign ticket 4821 to Maria in Billing and raise the urgency.”
It looks up agents and departments and updates the ticket's agent, department and urgency.
“Show the tickets from Acme Corp.”
It finds the organization and lists the tickets that belong to it.
“Write a help center article on resetting passwords, but keep it hidden.”
It creates the article with title, content and category and leaves it unpublished.
740 tools for Deskpro
These tools are switched on when you connect. You can switch any of them off, or require your approval before it runs.
add_person_noteChanges dataAdd an internal note to a person's profile: person ID as `parent_id` and the text in `note`.approve_ticket_approvalVisible to othersApprove a ticket approval (ticket approval id). Has effects visible outside this system. API summary: Approve an approval (ticketapprovals/{…}/approve).archive_blobVisible to othersArchive a blob (auth id). Has effects visible outside this system. API summary: See archive info (blobs/{…}/archive).cancel_ticket_approvalDeletesCancel a ticket approval (ticket approval id). Destructive action; may require approval. API summary: Cancel an approval (ticketapprovals/{…}/cancel).create_a_new_resource_article_commentsChanges dataCreate a new message. Search messages first to avoid duplicates. API summary: Create a new resource (articlecomments).create_a_new_resource_download_categoriesChanges dataDownload the document for a category. API summary: Create a new resource (downloadcategories).create_a_new_resource_guides_commentsChanges dataCreate a new message. Search messages first to avoid duplicates. API summary: Create a new resource (guidescomments).create_a_new_resource_news_categoriesChanges dataCreate a new category. API summary: Create a new resource (newscategories).create_a_new_resource_news_commentsChanges dataCreate a new message. Search messages first to avoid duplicates. API summary: Create a new resource (newscomments).create_a_new_resource_snippet_categoriesChanges dataCreate a new category. API summary: Create a new resource ({…}snippetcategories).create_a_new_resource_snippetsChanges dataCreate a new snippet. Search snippets first to avoid duplicates. API summary: Create a new resource ({…}snippets).create_agent_chatChanges dataCreate a new agent chat. API summary: create an agents chat (agentchats).create_agent_chat_messageChanges dataCreate a new message for a agent chat. Search messages first to avoid duplicates. API summary: Create a new resource (agentchats/{…}/messages).create_agent_reset_passwordDeletesCreate a new reset password for a agent. Destructive action; may require approval. API summary: reset agent password (agents/{…}/reset-password).create_agent_teamChanges dataCreate a new agent team. API summary: Create a new resource (agentteams).create_allChanges dataCreate a new all. API summary: dismiss all alerts for the current user (me/notifications/dismiss/all).create_approval_templateChanges dataCreate a new approval template. Search approval templates first to avoid duplicates. API summary: Create a new resource (approvaltemplates).create_approval_typeChanges dataCreate a new approval type. Search approval types first to avoid duplicates. API summary: Create a new resource (approvaltypes).create_articleChanges dataCreate a knowledge base article with `title`, `content`, `categories` and `status` (published publishes it to the help center).create_article_custom_fieldChanges dataCreate a new article custom field. API summary: Create a new resource (articlecustomfields).create_article_pending_createChanges dataCreate a new article pending create. API summary: Create a new resource (articlependingcreates).create_blobChanges dataCreate a new blob. API summary: Create a new resource (blobs).create_brandChanges dataCreate a new brand. API summary: create a brand (brands).create_categoryChanges dataCreate a new category. API summary: Create a new resource (articlecategories).create_chat_departmentChanges dataCreate a new chat department. API summary: Create a new resource (chatdepartments).create_clearChanges dataCreate a new clear. API summary: Clear all session data (people/{…}/sessions/clear).create_communityChanges dataCreate a new community. API summary: Save portal general settings (settings/brands/{…}/portal/community).create_community_custom_fieldChanges dataCreate a new community custom field. API summary: Create a new resource (communitycustomfields).create_community_forum_iconChanges dataCreate a new icon for a community forum. API summary: set Icon (communityforums/{…}/icon).create_community_forum_splash_imageChanges dataCreate a new splash image for a community forum. API summary: set Splash Image (communityforums/{…}/splashimage).create_community_topicChanges dataCreate a new community topic. API summary: Create a new resource (communitytopics).create_community_topic_post_mass_actions_community_topicsChanges dataCreate a new community topic. API summary: create new mass action for real-time apply (massactions/communitytopics).create_companyChanges dataCreate a new company. Search companies first to avoid duplicates. API summary: create new mass action for real-time apply (massactions/organizations).create_company_messageChanges dataCreate a new message for a company. Search messages first to avoid duplicates. API summary: Create a new resource (organizations/{…}/notes).create_company_userChanges dataCreate a new user for a company. API summary: Create a new resource (organizations/{…}/members).create_contactChanges dataCreate a new contact. Search contacts first to avoid duplicates. API summary: create new mass action for real-time apply (massactions/people).create_contact_documentChanges dataCreate a new document for a contact. API summary: Create a new resource (people/{…}/notesfiles).create_content_templateChanges dataCreate a new content template. API summary: Create a new resource (contenttemplates).create_custom_phraseChanges dataCreate a new custom phrase. API summary: Create new custom phrase in several languages (languages/customphrase).create_customerChanges dataCreate a new customer. API summary: Create a new resource (oauthclients).create_downloadChanges dataCreate a new download. API summary: Create a new resource (downloads).create_download_documentChanges dataCreate a new document for a download. API summary: Upload Splash Image For Download (downloads/{…}/splashimageupload).create_download_iconChanges dataCreate a new icon for a download. API summary: set Icon (downloads/{…}/icon).create_download_post_settings_brands_brand_portal_downloadsChanges dataCreate a new download. API summary: Save portal general settings (settings/brands/{…}/portal/downloads).create_download_splash_imageChanges dataCreate a new splash image for a download. API summary: set Splash Image (downloads/{…}/splashimage).create_email_account_encryptionVisible to othersCreate a new encryption for a email account. Has effects visible outside this system. API summary: Upload a certificate and a key (emailaccounts/{…}/encryption).create_generalChanges dataCreate a new general. API summary: Save portal general settings (settings/brands/{…}/portal/general).create_glossaryChanges dataCreate a new glossary. API summary: Create a new resource (glossary).create_guideChanges dataCreate a new guide. API summary: Create a new resource (guides).create_guide_documentChanges dataCreate a new document for a guide. API summary: Upload Guide Splash Image (guides/{…}/splashimageupload).create_guide_iconChanges dataCreate a new icon for a guide. API summary: set Icon (guides/{…}/icon).create_guide_post_settings_brands_brand_portal_guidesChanges dataCreate a new guide. API summary: Save portal general settings (settings/brands/{…}/portal/guides).create_guide_splash_imageChanges dataCreate a new splash image for a guide. API summary: set Splash Image (guides/{…}/splashimage).create_hookChanges dataCreate a new hook. API summary: Create a new resource (apps/zapier/hooks).create_kbChanges dataCreate a new kb. API summary: Save portal general settings (settings/brands/{…}/portal/kb).create_keypairChanges dataCreate a new keypair. API summary: Creates a new RSA keypair (crypto/keypairs).create_mass_actionChanges dataCreate a new mass action. API summary: Apply mass actions function (snippets/massactions).create_messageChanges dataCreate a new message. Search messages first to avoid duplicates. API summary: Create a new resource (communitytopiccomments).create_message_post_mass_actions_article_commentsChanges dataCreate a new message. Search messages first to avoid duplicates. API summary: create new mass action for real-time apply (massactions/articlecomments).create_message_post_mass_actions_community_topic_commentsChanges dataCreate a new message. Search messages first to avoid duplicates. API summary: create new mass action for real-time apply (massactions/communitytopiccomments).create_message_post_mass_actions_guide_topic_commentsChanges dataCreate a new message. Search messages first to avoid duplicates. API summary: create new mass action for real-time apply (massactions/guidetopiccomments).create_message_post_mass_actions_news_commentsChanges dataCreate a new message. Search messages first to avoid duplicates. API summary: create new mass action for real-time apply (massactions/newscomments).create_message_rateChanges dataCreate a new rate for a message. API summary: rate article content (articlecomments/{…}/rate).create_message_rate_post_community_topic_comments_comment_rateChanges dataCreate a new rate for a message. API summary: rate topic comment (communitytopiccomments/{…}/rate).create_message_rate_post_download_comments_download_rateChanges dataCreate a new rate for a message. API summary: rate download comment (downloadcomments/{…}/rate).create_message_rate_post_guides_comments_comment_rateChanges dataCreate a new rate for a message. API summary: rate guide comment (guidescomments/{…}/rate).create_message_rate_post_news_comments_comment_rateChanges dataCreate a new rate for a message. API summary: rate news comment (newscomments/{…}/rate).create_newsChanges dataCreate a new news. API summary: Create a new resource (news).create_news_documentChanges dataCreate a new document for a news. API summary: Create Splash Image For News (news/{…}/splashimageupload).create_news_iconChanges dataCreate a new icon for a news. API summary: set Icon (news/{…}/icon).create_news_post_settings_brands_brand_portal_newsChanges dataCreate a new news. API summary: Save portal general settings (settings/brands/{…}/portal/news).create_news_splash_imageChanges dataCreate a new splash image for a news. API summary: set Splash Image (news/{…}/splashimage).create_onboardingChanges dataCreate a new onboarding. API summary: Create a new resource (people/onboarding).create_organizationChanges dataCreate an organization with `name` and optional `email_domains`, `phone_numbers`, `labels` and `summary`. Search first to avoid duplicates.create_organization_custom_fieldChanges dataCreate a new organization custom field. API summary: Create a new resource (organizationcustomfields).create_organization_custom_field_optionChanges dataCreate a new option for a organization custom field. API summary: Create a new resource (organizationcustomfields/{…}/options).create_person_contextual_fieldChanges dataCreate a new person contextual field. API summary: Create a new resource (personcontextualfields).create_person_custom_fieldChanges dataCreate a new person custom field. API summary: Create a new resource (personcustomfields).create_person_custom_field_optionChanges dataCreate a new option for a person custom field. API summary: Create a new resource (personcustomfields/{…}/options).create_plivoChanges dataCreate a new plivo. API summary: Create a new resource (voiceaccounts/plivo).create_plivo_buy_numberChanges dataCreate a new buy number for a plivo. API summary: Buy number (voiceaccounts/plivo/{…}/buynumber).create_product_documentChanges dataCreate a new document for a product. API summary: Create Splash Image For Article (articles/{…}/splashimageupload).create_product_iconChanges dataCreate a new icon for a product. API summary: set Icon (articles/{…}/icon).create_product_post_mass_actions_articlesChanges dataCreate a new product. API summary: create new mass action for real-time apply (massactions/articles).create_product_post_mass_actions_pending_articlesChanges dataCreate a new product. API summary: create new mass action for real-time apply (massactions/pendingarticles).create_product_splash_imageChanges dataCreate a new splash image for a product. API summary: set Splash Image (articles/{…}/splashimage).create_raiseChanges dataCreate a new raise. API summary: Raise a popup with given parameters. (externalevents/popup/raise).create_setupChanges dataCreate a new setup. API summary: create widget (settings/brands/{…}/widget/setup).create_snippetChanges dataCreate a new snippet. Search snippets first to avoid duplicates. API summary: Create a new resource (snippets).create_start_importChanges dataCreate a new start import. API summary: Start a new import process from an external data source. (importer/startimport).create_stop_importChanges dataCreate a new stop import. API summary: Stop current importer process. (importer/stopimport).create_taskChanges dataCreate an agent task with `title`, optional `date_due`, `assigned_agent` and linked `ticket`.create_task_messageChanges dataCreate a new message for a task. Search messages first to avoid duplicates. API summary: Create a new resource (tasks/{…}/comments).create_test_credentialChanges dataCreate a new test credential. API summary: Check if account credentials are correct (voiceaccounts/plivo/testcredentials).create_test_credential_post_voice_accounts_twilio_test_credentiaChanges dataCreate a new test credential. API summary: Check if account credentials are correct (voiceaccounts/twilio/testcredentials).create_test_settingChanges dataCreate a new test setting. API summary: Check if an external data source connect options are valid. (importer/testsettings).create_ticketChanges dataCreate a ticket with `subject`, the requester in `person` (id or email) and the first message in `message.message`; optionally set `department`, `agent`, `status`, `urgency` and `labels`. Deskpro may email the requester.create_ticket_2Changes dataCreate a new ticket. Search tickets first to avoid duplicates. API summary: create new mass action for real-time apply (massactions/tickets).create_ticket_ccChanges dataCreate a new cc for a ticket. API summary: Create a new resource (tickets/{…}/cc).create_ticket_community_topic_linkChanges dataCreate a new community topic link for a ticket. API summary: Create a new resource (tickets/{…}/communitytopiclinks).create_ticket_custom_fieldChanges dataCreate a new ticket custom field. API summary: Create a new resource (ticketcustomfields).create_ticket_custom_field_optionChanges dataCreate a new option for a ticket custom field. API summary: Create a new resource (ticketcustomfields/{…}/options).create_ticket_departmentChanges dataCreate a new ticket department. API summary: Create a new resource (ticketdepartments).create_ticket_filterChanges dataCreate a new ticket filter. Search ticket filters first to avoid duplicates. API summary: Create a new resource (ticketfilters).create_ticket_filters2Changes dataCreate a new ticket filters2. Search ticket filters2s first to avoid duplicates. API summary: Create a new resource (ticketfilters2).create_ticket_filters2_setChanges dataCreate a new ticket filters2 set. Search ticket filters2 sets first to avoid duplicates. API summary: Create a new resource (ticketfilters2sets).create_ticket_follow_upChanges dataCreate a new follow up for a ticket. API summary: Create a new resource (tickets/{…}/follow-ups).create_ticket_linkChanges dataCreate a new link for a ticket. API summary: link two tickets (tickets/{…}/links).create_ticket_logChanges dataCreate a new log for a ticket. API summary: Create a new resource (tickets/{…}/logs).create_ticket_paymentChanges dataCreate a new payment for a ticket. API summary: Create a new resource (tickets/{…}/charges).create_ticket_problemChanges dataCreate a new ticket problem. API summary: Create a new resource (ticketproblems).create_ticket_statusChanges dataCreate a new ticket status. API summary: Create a new resource (ticketstatuses).create_ticket_ticket_approvalChanges dataCreate a new ticket approval for a ticket. API summary: Create a new ticket approval (tickets/{…}/ticketapprovals).create_ticket_ticket_slaChanges dataCreate a new ticket sla for a ticket. API summary: Create Ticket SLA. (tickets/{…}/ticketslas).create_topicChanges dataCreate a new topic. API summary: Create a new resource (topics).create_topic_documentChanges dataCreate a new document for a topic. API summary: Create Splash Image For Topic (topics/{…}/splashimageupload).create_topic_iconChanges dataCreate a new icon for a topic. API summary: set Icon (topics/{…}/icon).create_topic_splash_imageChanges dataCreate a new splash image for a topic. API summary: set Splash Image (topics/{…}/splashimage).create_twilioChanges dataCreate a new twilio. API summary: Create a new resource (voiceaccounts/twilio).create_twilio_addressChanges dataCreate a new address for a twilio. API summary: Create an address (voiceaccounts/twilio/{…}/addresses).create_twilio_buy_numberChanges dataCreate a new buy number for a twilio. API summary: Buy number (voiceaccounts/twilio/{…}/buynumber).create_user_chatChanges dataCreate a new user chat. API summary: Create a new resource (userchats).create_user_chat_custom_fieldChanges dataCreate a new user chat custom field. API summary: Create a new resource (userchatcustomfields).create_user_chat_custom_field_optionChanges dataCreate a new option for a user chat custom field. API summary: Create a new resource (userchatcustomfields/{…}/options).create_user_chat_queueChanges dataCreate a new user chat queue. API summary: Create a new resource (userchatqueues).create_user_chat_typingChanges dataCreate a new typing for a user chat. API summary: Send agent typing action (userchats/{…}/typing).create_voice_assetChanges dataCreate a new voice asset. API summary: Create a new resource (voiceassets).create_voice_auto_attendantChanges dataCreate a new voice auto attendant. API summary: Create a new resource (voiceautoattendants).create_voice_missed_agent_call_ticketChanges dataCreate a new voice missed agent call. API summary: Create voicemail ticket (voicemissedagentcalls/{…}/createticket).create_voice_numberChanges dataCreate a new voice number. API summary: Create a new resource (voicenumbers).create_voice_queueChanges dataCreate a new voice queue. API summary: Create a new resource (voicequeues).create_webhookDeletesCreate a new webhook. Destructive action; may require approval. API summary: Just a callback action for webhook in popup. (externalevents/popup/webhook).create_webhook_triggerDeletesCreate a new trigger for a webhook. Destructive action; may require approval. API summary: Create a new resource (webhooks/{…}/triggers).create_wordChanges dataCreate a new word. API summary: Create a new resource (glossary/words).delete_a_resource_download_categoriesDeletesPermanently delete a category by category id. Destructive action; may require approval. API summary: Delete a resource (downloadcategories/{…}).delete_a_resource_news_categoriesDeletesPermanently delete a category by category id. Destructive action; may require approval. API summary: Delete a resource (newscategories/{…}).delete_a_resource_snippet_categoriesDeletesPermanently delete a category by category id. Destructive action; may require approval. API summary: Delete a resource ({…}snippetcategories/{…}).delete_a_resource_snippetsDeletesPermanently delete a snippet by snippet id. Destructive action; may require approval. API summary: Delete a resource ({…}snippets/{…}).delete_a_resource_webhooks_ticketsDeletesPermanently delete a ticket by ticket id. Destructive action; may require approval. API summary: Delete a resource (webhooks/tickets/{…}).delete_accountDeletesPermanently delete a account by account id. Destructive action; may require approval. API summary: Delete a resource (voiceaccounts/{…}).delete_agentDeletesPermanently delete a agent by agent id. Destructive action; may require approval. API summary: Delete a resource (agents/{…}).delete_agent_agent_permissionsMoves moneyPermanently delete a agent permission by agent id. Financial or irreversible action; may require approval. API summary: remove agents permission (converts agent to user, unassigns tickets) (agents/{…}/agentpermissions).delete_agent_chatDeletesPermanently delete a agent chat by agent chat id. Destructive action; may require approval. API summary: Delete a resource (agentchats/{…}).delete_agent_chat_deletesMoves moneyPermanently delete a delete by agent chat id. Financial or irreversible action; may require approval. API summary: delete group (agentchats/{…}/delete).delete_agent_chat_leavesMoves moneyPermanently delete a leave by agent chat id. Financial or irreversible action; may require approval. API summary: leave group (agentchats/{…}/leave).delete_agent_chat_messageDeletesPermanently delete a message by message id. Destructive action; may require approval. API summary: Delete a resource (agentchats/{…}/messages/{…}).delete_agent_teamDeletesPermanently delete a agent team by agent team id. Destructive action; may require approval. API summary: Delete a resource (agentteams/{…}).delete_approval_templateDeletesPermanently delete a approval template by approval template id. Destructive action; may require approval. API summary: Delete a resource (approvaltemplates/{…}).delete_approval_typeDeletesPermanently delete a approval type by approval type id. Destructive action; may require approval. API summary: Delete a resource (approvaltypes/{…}).delete_article_custom_fieldDeletesPermanently delete a article custom field by article custom field id. Destructive action; may require approval. API summary: Delete a resource (articlecustomfields/{…}).delete_article_pending_createDeletesPermanently delete a article pending create by article pending create id. Destructive action; may require approval. API summary: Delete a resource (articlependingcreates/{…}).delete_blobDeletesPermanently delete a blob by blob id. Destructive action; may require approval. API summary: Delete a blob (blobs/{…}).delete_brandDeletesPermanently delete a brand by brand id. Destructive action; may require approval. API summary: Delete a resource (brands/{…}).delete_by_slaDeletesPermanently delete a by sla by sla id. Destructive action; may require approval. API summary: Delete single Ticket SLA. (tickets/{…}/ticketslas/bysla/{…}).delete_categoryDeletesPermanently delete a category by category id. Destructive action; may require approval. API summary: Delete a resource (articlecategories/{…}).delete_chat_departmentDeletesPermanently delete a chat department by chat department id. Destructive action; may require approval. API summary: Delete a resource (chatdepartments/{…}).delete_client_deviceDeletesPermanently delete a client device by client device id. Destructive action; may require approval. API summary: Delete a resource (clientdevices/{…}/{…}).delete_community_custom_fieldDeletesPermanently delete a community custom field by community custom field id. Destructive action; may require approval. API summary: Delete a resource (communitycustomfields/{…}).delete_community_topicDeletesPermanently delete a community topic by community topic id. Destructive action; may require approval. API summary: Delete a resource (communitytopics/{…}).delete_companyDeletesPermanently delete a company by company id. Destructive action; may require approval. API summary: Delete a resource (organizations/{…}).delete_company_messageDeletesPermanently delete a message by message id. Destructive action; may require approval. API summary: Delete a resource (organizations/{…}/notes/{…}).delete_company_userDeletesPermanently delete a user by user id. Destructive action; may require approval. API summary: Delete a resource (organizations/{…}/members/{…}).delete_contact_documentDeletesPermanently delete a document by document id. Destructive action; may require approval. API summary: Delete a resource (people/{…}/notesfiles/{…}).delete_contact_messageDeletesPermanently delete a message by message id. Destructive action; may require approval. API summary: Delete a resource (people/{…}/notes/{…}).delete_contact_usersource_assocDeletesPermanently delete a usersource assoc by usersource assoc id. Destructive action; may require approval. API summary: Delete a resource (people/{…}/usersourceassocs/{…}).delete_content_templateDeletesPermanently delete a content template by content template id. Destructive action; may require approval. API summary: Delete a resource (contenttemplates/{…}).delete_customerDeletesPermanently delete a customer by customer id. Destructive action; may require approval. API summary: Delete a resource (oauthclients/{…}).delete_dismissDeletesPermanently delete a dismiss by dismiss uuid. Destructive action; may require approval. API summary: An endpoint to dismiss previously raised popup. (externalevents/popup/dismiss/{…}).delete_downloadDeletesPermanently delete a download by download id. Destructive action; may require approval. API summary: Delete a resource (downloads/{…}).delete_email_account_certificatesMoves moneyPermanently delete a certificate by email account id. Financial or irreversible action; may require approval. API summary: Delete a certificate (emailaccounts/{…}/certificate).delete_email_account_keysMoves moneyPermanently delete a key by email account id. Financial or irreversible action; may require approval. API summary: Delete a key (emailaccounts/{…}/key).delete_email_assetDeletesPermanently delete a email asset by email asset id. Destructive action; may require approval. API summary: Delete an email asset (emailtemplates/emailassets/{…}).delete_glossaryDeletesPermanently delete a glossary by glossary id. Destructive action; may require approval. API summary: Delete a resource (glossary/{…}).delete_guideDeletesPermanently delete a guide by guide id. Destructive action; may require approval. API summary: Delete a resource (guides/{…}).delete_hookDeletesPermanently delete a hook by hook id. Destructive action; may require approval. API summary: Delete a resource (apps/zapier/hooks/{…}).delete_incidentDeletesPermanently delete a incident by incident id. Destructive action; may require approval. API summary: Delete a resource (system/incidents/{…}).delete_incidentsMoves moneyPermanently delete a incident. Financial or irreversible action; may require approval. API summary: delete all incidents (system/incidents).delete_legacy_templateDeletesPermanently delete a legacy template by legacy template id. Destructive action; may require approval. API summary: Delete legacy template (emailtemplates/legacytemplate/{…}).delete_legacy_template_portal_templates_legacy_templateDeletesPermanently delete a legacy template by legacy template id. Destructive action; may require approval. API summary: Delete legacy template (portaltemplates/legacytemplate/{…}).delete_messageDeletesPermanently delete a message by message id. Destructive action; may require approval. API summary: Delete a resource (communitytopiccomments/{…}).delete_newsDeletesPermanently delete a news by news id. Destructive action; may require approval. API summary: Delete a resource (news/{…}).delete_notificationDeletesPermanently delete a notification by notification id. Destructive action; may require approval. API summary: Delete a resource (me/notifications/{…}).delete_organization_custom_fieldDeletesPermanently delete a organization custom field by organization custom field id. Destructive action; may require approval. API summary: Delete a resource (organizationcustomfields/{…}).delete_organization_custom_field_optionDeletesPermanently delete a option by option id. Destructive action; may require approval. API summary: Delete a resource (organizationcustomfields/{…}/options/{…}).delete_person_contextual_fieldDeletesPermanently delete a person contextual field by person contextual field id. Destructive action; may require approval. API summary: Delete a resource (personcontextualfields/{…}).delete_person_custom_fieldDeletesPermanently delete a person custom field by person custom field id. Destructive action; may require approval. API summary: Delete a resource (personcustomfields/{…}).delete_person_custom_field_optionDeletesPermanently delete a option by option id. Destructive action; may require approval. API summary: Delete a resource (personcustomfields/{…}/options/{…}).delete_plivoDeletesPermanently delete a plivo by plivo id. Destructive action; may require approval. API summary: Delete a resource (voiceaccounts/plivo/{…}).delete_productDeletesPermanently delete a product by product id. Destructive action; may require approval. API summary: Delete a resource (articles/{…}).delete_purgesMoves moneyPermanently delete a purge. Financial or irreversible action; may require approval. API summary: Purge deleted tickets manually (ticketstatuses/deleted/purge).delete_purges_delete_ticket_statuses_spam_purgeMoves moneyPermanently delete a purge. Financial or irreversible action; may require approval. API summary: Purge spam tickets manually (ticketstatuses/spam/purge).delete_setupsMoves moneyPermanently delete a setup by brand. Financial or irreversible action; may require approval. API summary: reset widget settings (settings/brands/{…}/widget/setup).delete_snippetDeletesPermanently delete a snippet by snippet id. Destructive action; may require approval. API summary: Delete a resource (snippets/{…}).delete_taskDeletesPermanently delete a task by task id. Destructive action; may require approval. API summary: Delete a resource (tasks/{…}).delete_task_messageDeletesPermanently delete a message by message id. Destructive action; may require approval. API summary: Delete a resource (tasks/{…}/comments/{…}).delete_templateDeletesPermanently delete a template by name. Destructive action; may require approval. API summary: Delete a custom template and retrieve the original one (emailtemplates/template/{…}).delete_template_delete_portal_templates_template_brand_id_nameDeletesPermanently delete a template by name. Destructive action; may require approval. API summary: Delete a custom template and retrieve the original one (portaltemplates/template/{…}/{…}).delete_template_delete_portal_templates_template_nameDeletesPermanently delete a template by name. Destructive action; may require approval. API summary: Delete a custom template and retrieve the original one (portaltemplates/template/{…}).delete_ticketDeletesPermanently delete a ticket by ticket id. Destructive action; may require approval. API summary: Delete a resource (tickets/{…}).delete_ticket_ccDeletesPermanently delete a cc by cc id. Destructive action; may require approval. API summary: Delete a resource (tickets/{…}/cc/{…}).delete_ticket_community_topic_linkDeletesPermanently delete a community topic link by community topic link id. Destructive action; may require approval. API summary: Delete a resource (tickets/{…}/communitytopiclinks/{…}).delete_ticket_custom_fieldDeletesPermanently delete a ticket custom field by ticket custom field id. Destructive action; may require approval. API summary: Delete a resource (ticketcustomfields/{…}).delete_ticket_custom_field_optionDeletesPermanently delete a option by option id. Destructive action; may require approval. API summary: Delete a resource (ticketcustomfields/{…}/options/{…}).delete_ticket_departmentDeletesPermanently delete a ticket department by ticket department id. Destructive action; may require approval. API summary: Delete a resource (ticketdepartments/{…}).delete_ticket_filterDeletesPermanently delete a ticket filter by ticket filter id. Destructive action; may require approval. API summary: Delete a resource (ticketfilters/{…}).delete_ticket_filters2DeletesPermanently delete a ticket filters2 by ticket filters2 id. Destructive action; may require approval. API summary: Delete a resource (ticketfilters2/{…}).delete_ticket_filters2_setDeletesPermanently delete a ticket filters2 set by ticket filters2 set id. Destructive action; may require approval. API summary: Delete a resource (ticketfilters2sets/{…}).delete_ticket_follow_upDeletesPermanently delete a follow up by follow up id. Destructive action; may require approval. API summary: Delete a resource (tickets/{…}/follow-ups/{…}).delete_ticket_linksMoves moneyPermanently delete a link by ticket. Financial or irreversible action; may require approval. API summary: delete relation between two tickets (tickets/{…}/links).delete_ticket_messageDeletesPermanently delete a message by message id. Destructive action; may require approval. API summary: Delete a resource (tickets/{…}/messages/{…}).delete_ticket_paymentDeletesPermanently delete a payment by payment id. Destructive action; may require approval. API summary: Delete a resource (tickets/{…}/charges/{…}).delete_ticket_problemDeletesPermanently delete a ticket problem by ticket problem id. Destructive action; may require approval. API summary: Delete a resource (ticketproblems/{…}).delete_ticket_statusDeletesPermanently delete a ticket status by ticket status id. Destructive action; may require approval. API summary: Delete a resource (ticketstatuses/{…}).delete_ticket_ticket_slaDeletesPermanently delete a ticket sla by ticket sla id. Destructive action; may require approval. API summary: Delete a resource (tickets/{…}/ticketslas/{…}).delete_topicDeletesPermanently delete a topic by topic id. Destructive action; may require approval. API summary: Delete a resource (topics/{…}).delete_triggerDeletesPermanently delete a trigger by trigger id. Destructive action; may require approval. API summary: Delete a resource (webhooks/triggers/{…}).delete_twilioDeletesPermanently delete a twilio by twilio id. Destructive action; may require approval. API summary: Delete a resource (voiceaccounts/twilio/{…}).delete_twilio_addressDeletesPermanently delete a address by address sid. Destructive action; may require approval. API summary: Delete an address (voiceaccounts/twilio/{…}/addresses/{…}).delete_user_chatDeletesPermanently delete a user chat by user chat id. Destructive action; may require approval. API summary: Delete a resource (userchats/{…}).delete_user_chat_custom_fieldDeletesPermanently delete a user chat custom field by user chat custom field id. Destructive action; may require approval. API summary: Delete a resource (userchatcustomfields/{…}).delete_user_chat_custom_field_optionDeletesPermanently delete a option by option id. Destructive action; may require approval. API summary: Delete a resource (userchatcustomfields/{…}/options/{…}).delete_user_chat_queueDeletesPermanently delete a user chat queue by user chat queue id. Destructive action; may require approval. API summary: Delete a resource (userchatqueues/{…}).delete_user_sourceDeletesPermanently delete a user source by user source id. Destructive action; may require approval. API summary: Delete a resource (usersources/{…}/{…}).delete_voice_assetDeletesPermanently delete a voice asset by voice asset id. Destructive action; may require approval. API summary: Delete a resource (voiceassets/{…}).delete_voice_auto_attendantDeletesPermanently delete a voice auto attendant by voice auto attendant id. Destructive action; may require approval. API summary: Delete a resource (voiceautoattendants/{…}).delete_voice_missed_agent_callDeletesPermanently delete a voice missed agent call by voice missed agent call id. Destructive action; may require approval. API summary: Delete a resource (voicemissedagentcalls/{…}).delete_voice_numberDeletesPermanently delete a voice number by voice number id. Destructive action; may require approval. API summary: Delete a resource (voicenumbers/{…}).delete_voice_phone_call_recordsMoves moneyPermanently delete a record by phone call. Financial or irreversible action; may require approval. API summary: Delete phone call record (voicephonecalls/{…}/record).delete_voice_queueDeletesPermanently delete a voice queue by voice queue id. Destructive action; may require approval. API summary: Delete a resource (voicequeues/{…}).delete_webhook_triggerDeletesPermanently delete a trigger by trigger id. Destructive action; may require approval. API summary: Delete a resource (webhooks/{…}/triggers/{…}).delete_wordDeletesPermanently delete a word by word id. Destructive action; may require approval. API summary: Delete a resource (glossary/words/{…}).download_categoryDownload the document for a category. Results are paginated. API summary: Get collection of resources (downloadcategories).download_mass_action_commentsChanges dataDownload the document for a mass action. API summary: create new mass action for real-time apply (massactions/downloadcomments).download_messageChanges dataDownload the document for a message. API summary: Create a new resource (downloadcomments).download_message_attachmentsDownload the document for a message. API summary: Download message attachments as zip file (tickets/{…}/messages/{…}/download-attachments).download_message_emailDownload the document for a message. API summary: Download message email file (tickets/{…}/messages/{…}/download-email).download_product_pdfDownload the pdf document for a product. API summary: Article download as pdf (articles/{…}/pdf).download_ticket_debug_reportDownload the document for a ticket. API summary: Download debug report file (tickets/{…}/download-debug-report).export_guidesExport guides. API summary: export a full json of the guide (guides/{…}/export).get_a_definition_of_the_word_glossary_wordsGet one word by word. API summary: Get a definition of the word (glossary/words/{…}).get_a_resource_client_devicesGet one client device by client device id. API summary: Get a resource (clientdevices/{…}/{…}).get_a_resource_download_categoriesGet one category by category id. API summary: Get a resource (downloadcategories/{…}).get_a_resource_news_categoriesGet one category by category id. API summary: Get a resource (newscategories/{…}).get_a_resource_snippet_categoriesGet one category by category id. API summary: Get a resource ({…}snippetcategories/{…}).get_a_resource_snippetsGet one snippet by snippet id. API summary: Get a resource ({…}snippets/{…}).get_a_resource_ticket_filtersGet one ticket filter by ticket filter id. API summary: Get a resource (ticketfilters/{…}).get_a_resource_user_sourcesGet one user source by user source id. API summary: Get a resource (usersources/{…}/{…}).get_a_resource_webhooks_ticketsGet one ticket by ticket id. API summary: Get a resource (webhooks/tickets/{…}).get_accountGet one account by account id. API summary: Get a resource (voiceaccounts/{…}).get_agentGet one agent by agent id. API summary: Get a resource (agents/{…}).get_agent_chatGet one agent chat by agent chat id. API summary: Get a resource (agentchats/{…}).get_agent_chat_messageGet one message for a agent chat by message id. API summary: Get a resource (agentchats/{…}/messages/{…}).get_agent_groupGet one agent group by agent group id. API summary: Get a resource (agentgroups/{…}).get_agent_teamGet one agent team by agent team id. API summary: Get a resource (agentteams/{…}).get_api_logGet one api log by api log id. API summary: get api log (apilogs/{…}).get_api_tagGet one api tag by api tag id. API summary: get api tags collection (apitags/{…}).get_approval_responseGet one approval response by approval id. Results are paginated. API summary: Get collection of resources (approvalresponses/{…}).get_approval_templateGet one approval template by approval template id. API summary: Get a resource (approvaltemplates/{…}).get_approval_typeGet one approval type by approval type id. API summary: get approval type (approvaltypes/{…}).get_articleGet one knowledge base article by `product_id` (the article ID), with its title and content.get_article_custom_fieldGet one article custom field by article custom field id. API summary: Get a resource (articlecustomfields/{…}).get_article_pending_createGet one article pending create by article pending create id. API summary: Get a resource (articlependingcreates/{…}).get_blobGet one blob by blob id. API summary: Get a resource (blobs/{…}).get_blob_downloadGet one download for a blob by path. API summary: Serve archived content (blobs/{…}/download/{…}).get_brandGet one brand by brand id. API summary: Get a brand (brands/{…}).get_by_slaGet one by sla by sla id. API summary: Retrieve single SLA for ticket by parent SLA's ID. (tickets/{…}/ticketslas/bysla/{…}).get_categoryGet one category by category id. API summary: Get a resource (articlecategories/{…}).get_chat_departmentGet one chat department by chat department id. API summary: Get a resource (chatdepartments/{…}).get_client_deviceGet one client device by app type. Results are paginated. API summary: Get collection of resources (clientdevices/{…}).get_collection_of_resources_article_categoriesList categories. Optional filters: count or ids. Results are paginated. API summary: Get collection of resources (articlecategories).get_collection_of_resources_news_categoriesList categories. Optional filters: count or ids. Results are paginated. API summary: Get collection of resources (newscategories).get_collection_of_resources_snippet_categoriesList categories. Optional filters: count or ids. Results are paginated. API summary: Get collection of resources ({…}snippetcategories).get_collection_of_resources_tickets_logsList logs for a ticket. Optional filters: count or ids. Results are paginated. API summary: Get collection of resources (tickets/{…}/logs).get_community_custom_fieldGet one community custom field by community custom field id. API summary: Get a resource (communitycustomfields/{…}).get_community_forumGet one community forum by community forum id. API summary: Get a resource (communityforums/{…}).get_community_topicGet one community topic by community topic id. API summary: Get a resource (communitytopics/{…}).get_company_contact_dataGet one contact data for a company by contact data id. API summary: Get a resource (organizations/{…}/contactdata/{…}).get_company_messageGet one message for a company by message id. API summary: Get a resource (organizations/{…}/notes/{…}).get_company_userGet one user for a company by user id. API summary: Get a resource (organizations/{…}/members/{…}).get_contact_contact_dataGet one contact data for a contact by contact data id. API summary: Get a resource (people/{…}/contactdata/{…}).get_contact_documentGet one document for a contact by document id. API summary: Get a resource (people/{…}/notes-files/{…}).get_contact_messageGet one message for a contact by message id. API summary: Get a resource (people/{…}/notes/{…}).get_contact_usersource_assocGet one usersource assoc for a contact by usersource assoc id. API summary: Get a resource (people/{…}/usersourceassocs/{…}).get_content_templateGet one content template by content template id. API summary: Get a resource (contenttemplates/{…}).get_currencyGet one currency by currency id. API summary: Get a resource (currencies/{…}).get_current_user_available_onboardings_people_onboarding_newList news. API summary: Get current user available onboardings (people/onboarding/new).get_customerGet one customer by customer id. API summary: Get a resource (oauthclients/{…}).get_departmentGet one department by language id. API summary: provide Agent departments phrases for UI (languages/departments/{…}).get_downloadGet one download by download id. API summary: Get a resource (downloads/{…}).get_email_assetGet one email asset by type. API summary: Add a new asset (emailtemplates/emailassets/{…}).get_email_phraseGet one email phrase by language id. API summary: provide agent phrases for frontend (languages/emailphrases/{…}/{…}).get_eventGet one event by event id. API summary: Get a resource (system/events/{…}).get_exampleGet one example by action. API summary: Provide examples for Zapier webhooks (apps/zapier/example/{…}).get_filter_s_count_ticket_filters2_countGet one ticket filters2 by ticket filter. API summary: Get filter's count (ticketfilters2/{…}/count).get_filter_s_count_ticket_filters_countGet one ticket filter by ticket filter. API summary: Get filter's count (ticketfilters/{…}/count).get_glossaryGet one glossary by glossary id. API summary: Get a resource (glossary/{…}).get_guideGet one guide by guide id. API summary: Get a resource (guides/{…}).get_helpcenter_phraseGet one helpcenter phrase by language id. API summary: provide helpcenter phrases for template editor (languages/helpcenterphrases/{…}).get_importer_logGet one importer log by importer log id. API summary: Get a resource (importerlogs/{…}).get_importer_statusGet the current status of a importer. API summary: Get progress of current importer process. (importer/status).get_incidentGet one incident by incident id. API summary: Get a resource (system/incidents/{…}).get_languageGet one language by language id. API summary: Get a resource (languages/{…}).get_mark_as_convertedGet one mark as converted by name. API summary: Mark a legacy template as converted (emailtemplates/markasconverted/{…}).get_meGet the agent the API key acts as. Use to confirm which helpdesk user you are working as.get_messageGet one message by message id. API summary: Get a resource (communitytopiccomments/{…}).get_message_download_sendmailGet one download sendmail for a message by sendmail id. API summary: Download outgoing message email file (tickets/{…}/messages/{…}/download-sendmail/{…}).get_newsGet one news by news id. API summary: Get a resource (news/{…}).get_notificationGet one notification by notification id. API summary: Get a resource (me/notifications/{…}).get_organizationGet one organization by `company_id`, with its contact data, members and labels.get_organization_custom_fieldGet one organization custom field by organization custom field id. API summary: Get a resource (organizationcustomfields/{…}).get_organization_custom_field_optionGet one option for a organization custom field by option id. API summary: Get a resource (organizationcustomfields/{…}/options/{…}).get_personGet one person (end user) by `contact_id`, with emails, phone numbers, organization and labels.get_person_contextual_fieldGet one person contextual field by person contextual field id. API summary: Get a resource (personcontextualfields/{…}).get_person_custom_fieldGet one person custom field by person custom field id. API summary: Get a resource (personcustomfields/{…}).get_person_custom_field_optionGet one option for a person custom field by option id. API summary: Get a resource (personcustomfields/{…}/options/{…}).get_person_settingGet one person setting by name. API summary: get a person setting (personsetting/{…}).get_plivoGet one plivo by plivo id. API summary: Get a resource (voiceaccounts/plivo/{…}).get_portal_general_settings_settings_brands_portal_downloadsList downloads. API summary: Get portal general settings (settings/brands/{…}/portal/downloads).get_portal_general_settings_settings_brands_portal_generalList generals. API summary: Get portal general settings (settings/brands/{…}/portal/general).get_portal_general_settings_settings_brands_portal_guidesList guides. API summary: Get portal general settings (settings/brands/{…}/portal/guides).get_portal_general_settings_settings_brands_portal_newsList news. API summary: Get portal general settings (settings/brands/{…}/portal/news).get_projectGet one project by project id. API summary: Get a resource (jobs/{…}).get_renderGet one render by object id. API summary: Render a snippet for an object (snippets/render/{…}/{…}/{…}).get_revert_legacy_templateGet one revert legacy template by revert legacy template id. API summary: Revert legacy template to hardcoded template (emailtemplates/revertlegacytemplate/{…}).get_revert_legacy_template_get_portal_templates_revert_legacy_teGet one revert legacy template by revert legacy template id. API summary: Revert legacy template to hardcoded template (portaltemplates/revertlegacytemplate/{…}).get_slaGet one sla by sla id. API summary: get SLA (slas/{…}).get_snippetGet one snippet by snippet id. API summary: Get a resource (snippets/{…}).get_statusGet one status by job. API summary: Get progress of current importer process. (importer/status/{…}).get_supplierGet one supplier by tmp string. API summary: Check if a particular token exists for a given vendor (oauth/vendor/{…}/{…}/{…}).get_supplier_get_oauth_vendor_vendor_client_id_tmp_string_token_Get one supplier by person id. API summary: Check that token has been created and allow it to be retrieved (oauth/vendor/{…}/{…}/{…}/{…}/{…}).get_taskGet one task by task id. API summary: Get a resource (tasks/{…}).get_task_messageGet one message for a task by message id. API summary: Get a resource (tasks/{…}/comments/{…}).get_templateGet one template by name. API summary: Retrieve a template (emailtemplates/template/{…}).get_the_updater_settings_helpdesk_updater_settingsList settings. API summary: Get the updater settings (helpdesk/updater/settings).get_ticketGet one ticket by `ticket_id` (numeric ID or ref:<ticket ref>), with subject, status, person, agent, department and labels.get_ticket_ccGet one cc for a ticket by cc id. API summary: Get a resource (tickets/{…}/cc/{…}).get_ticket_community_topic_linkGet one community topic link for a ticket by community topic link id. API summary: Get a resource (tickets/{…}/communitytopiclinks/{…}).get_ticket_custom_fieldGet one ticket custom field by ticket custom field id. API summary: Get a resource (ticketcustomfields/{…}).get_ticket_custom_field_optionGet one option for a ticket custom field by option id. API summary: Get a resource (ticketcustomfields/{…}/options/{…}).get_ticket_departmentGet one ticket department by ticket department id. API summary: Get a resource (ticketdepartments/{…}).get_ticket_filterGet one ticket filter by ticket filter id. API summary: Get a filter's count (ticketfilters/{…}/count).get_ticket_filter_setGet one ticket filter set by ticket filter set id. API summary: get a filter set (ticketfiltersets/{…}).get_ticket_filter_set_countGet one ticket filter set by ticket filter set id. API summary: Get a filter set count (ticketfiltersets/{…}/count).get_ticket_filters2Get one ticket filters2 by ticket filters2 id. API summary: Get a resource (ticketfilters2/{…}).get_ticket_filters2_setGet one ticket filters2 set by ticket filters2 set id. API summary: Get a resource (ticketfilters2sets/{…}).get_ticket_follow_upGet one follow up for a ticket by follow up id. API summary: Get a resource (tickets/{…}/follow-ups/{…}).get_ticket_layoutGet one ticket layout by context. API summary: Get ticket layouts (20170401/ticketlayouts/{…}).get_ticket_layout_get_20170401_ticket_layouts_context_departmentGet one ticket layout by department. API summary: Get ticket department layout for given context (20170401/ticketlayouts/{…}/{…}).get_ticket_layout_get_ticket_layouts_context_departmentGet one ticket layout by department. API summary: Get ticket department layout for given context (ticketlayouts/{…}/{…}).get_ticket_layouts_ticket_layoutsGet one ticket layout by context. API summary: Get ticket layouts (ticketlayouts/{…}).get_ticket_listGet one ticket list by ticket list id. API summary: Get a resource (ticketlists/{…}).get_ticket_logGet one log for a ticket by log id. API summary: Get a resource (tickets/{…}/logs/{…}).get_ticket_macroGet one ticket macro by ticket macro id. API summary: Get a resource (ticketmacros/{…}).get_ticket_messageGet one message for a ticket by message id. API summary: Get a resource (tickets/{…}/messages/{…}).get_ticket_paymentGet one payment for a ticket by payment id. API summary: Get a resource (tickets/{…}/charges/{…}).get_ticket_problemGet one ticket problem by ticket problem id. API summary: Get a resource (ticketproblems/{…}).get_ticket_statusGet one ticket status by ticket status id. API summary: Get a resource (ticketstatuses/{…}).get_ticket_ticket_slaGet one ticket sla for a ticket by ticket sla id. API summary: Get a resource (tickets/{…}/ticketslas/{…}).get_topicGet one topic by topic id. API summary: Get a resource (topics/{…}).get_translationGet one translation by phrase name. API summary: provide translation of a phrase (languages/translations/{…}).get_triggerGet one trigger by trigger id. API summary: Get a resource (webhooks/triggers/{…}).get_twilioGet one twilio by twilio id. API summary: Get a resource (voiceaccounts/twilio/{…}).get_twilio_addressGet one address for a twilio by address sid. API summary: Get a voice address (voiceaccounts/twilio/{…}/addresses/{…}).get_twilio_available_number_typeGet one available number type for a twilio by country code. API summary: Returns a list of available number types for specific country (voiceaccounts/twilio/{…}/availablenumbertypes/{…}).get_updater_statusGet the current status of a updater. API summary: Get the updater status (helpdesk/updater/status).get_user_chatGet one user chat by user chat id. API summary: Get a resource (userchats/{…}).get_user_chat_custom_fieldGet one user chat custom field by user chat custom field id. API summary: Get a resource (userchatcustomfields/{…}).get_user_chat_custom_field_optionGet one option for a user chat custom field by option id. API summary: Get a resource (userchatcustomfields/{…}/options/{…}).get_user_chat_queueGet one user chat queue by user chat queue id. API summary: Get a resource (userchatqueues/{…}).get_user_groupGet one user group by user group id. API summary: Get a resource (usergroups/{…}).get_user_sourceGet one user source by context. Results are paginated. API summary: Get collection of resources (usersources/{…}).get_variableGet one variable by class name. API summary: list of a variables available for a view model (emailtemplates/viewmodel/variables/{…}).get_voice_assetGet one voice asset by voice asset id. API summary: Get a resource (voiceassets/{…}).get_voice_auto_attendantGet one voice auto attendant by voice auto attendant id. API summary: Get a resource (voiceautoattendants/{…}).get_voice_missed_agent_callGet one voice missed agent call by voice missed agent call id. API summary: Get a resource (voicemissedagentcalls/{…}).get_voice_numberGet one voice number by voice number id. API summary: Get a resource (voicenumbers/{…}).get_voice_phone_callGet one voice phone call by voice phone call id. API summary: Get a resource (voicephonecalls/{…}).get_voice_queueGet one voice queue by voice queue id. API summary: Get a resource (voicequeues/{…}).get_webhook_triggerGet one trigger for a webhook by trigger id. API summary: Get a resource (webhooks/{…}/triggers/{…}).get_wordGet one word by word id. API summary: Get a resource (glossary/words/{…}).list_accountsList accounts. Optional filters: count or ids. Results are paginated. API summary: Get collection of resources (voiceaccounts).list_action_alertsList action alerts. API summary: You can use this endpoint to gather information about clients you need to obtain notifications and alerts. (notify/setup/action-alerts).list_admin_phrasesList admin phrases. API summary: provide admin phrases for frontend (languages/adminphrases).list_agent_chatsList agent chats. Optional filters: count or ids. Results are paginated. API summary: Get collection of resources (agentchats).list_agent_groupsList agent groups. Optional filters: count or ids. Results are paginated. API summary: Get collection of resources (agentgroups).list_agent_phrasesList agent phrases. API summary: provide agent phrases for frontend (languages/agentphrases).list_agent_team_agentsList agents for a agent team. API summary: Return agents from team given team (agentteams/{…}/agents).list_agent_teamsList agent teams. Optional filters: count, ids or my. Results are paginated. API summary: get list of teams (agentteams).list_agentsList helpdesk agents with their IDs; filter with `online` to see who is online.list_api_logsList api logs. API summary: get api logs collection (apilogs).list_api_logs_optionsList api logs options. API summary: get logging options (apilogsoptions).list_api_tag_flattensList flattens for a api tag. API summary: get api tags faltten collection (apitags/{…}/flatten).list_approval_response_countsList counts for a approval response. Optional filters: message. API summary: Count list (approvalresponses/{…}/counts).list_article_custom_fieldsList article custom fields. Optional filters: count or ids. Results are paginated. API summary: Get collection of resources (articlecustomfields).list_article_pending_createsList article pending creates. Optional filters: count, ids, assigned person, order by or order dir. Results are paginated. API summary: Get collection of resources (articlependingcreates).list_articlesList knowledge base articles, filtered by `status` (published, archived, hidden), `category` or `author`. Paged with `page` and `count`.list_assigned_to_chatsList assigned to chats. API summary: get a list of agents, assigned to chats (agents/assignedtochat).list_average_waiting_timesList average waiting times. API summary: Get average waiting time for each voice queue (voicequeues/averagewaitingtime).list_blob_documentsList documents for a blob. API summary: See archive content (blobs/{…}/files).list_blobsList blobs. Optional filters: count or ids. Results are paginated. API summary: Get collection of resources (blobs).list_brandsList brands. Optional filters: count or ids. Results are paginated. API summary: Get collection of resources (brands).list_captchasList captchas. API summary: Get anti-abuse settings (settings/antiabuse/captcha).list_categoriesList categories. API summary: get list of custom community forums (communitycategories).list_categories_get_content_categoriesList categories. API summary: Get categories for articles, news and downloads (contentcategories).list_category_snippetsList snippets for a category. API summary: get the snippets within a category ({…}snippetcategories/{…}/snippets).list_chat_department_agentsList agents for a chat department. API summary: Get agents belongs to department (chatdepartments/{…}/agents).list_chat_departmentsList chat departments. Optional filters: count or ids. Results are paginated. API summary: Get collection of resources (chatdepartments).list_client_device_countsList counts for a client device. API summary: Count list (clientdevices/{…}/counts).list_codesList codes. API summary: Get ticket form widget JS code (ticket-form-widget/code).list_codes_get_settings_brands_brand_widget_codeList codes. API summary: Get the HTML code for the widget (settings/brands/{…}/widget/code).list_communitiesList communities. API summary: Get portal general settings (settings/brands/{…}/portal/community).list_community_custom_fieldsList community custom fields. Optional filters: count or ids. Results are paginated. API summary: Get collection of resources (communitycustomfields).list_community_forumsList community forums. Optional filters: count or ids. Results are paginated. API summary: Get collection of resources (communityforums).list_company_contact_dataList contact data for a company. Optional filters: count or ids. Results are paginated. API summary: Get collection of resources (organizations/{…}/contactdata).list_company_messagesList messages for a company. Optional filters: count or ids. Results are paginated. API summary: Get collection of resources (organizations/{…}/notes).list_company_usersList users for a company. Optional filters: count or ids. Results are paginated. API summary: Get collection of resources (organizations/{…}/members).list_contact_approval_responsesList approval responses for a contact. Optional filters: count or ids. Results are paginated. API summary: Get collection of resources (person/{…}/approvalresponses).list_contact_contact_dataList contact data for a contact. Optional filters: count or ids. Results are paginated. API summary: Get collection of resources (people/{…}/contactdata).list_contact_documentsList documents for a contact. Optional filters: count or ids. Results are paginated. API summary: Get collection of resources (people/{…}/notesfiles).list_contact_messagesList messages for a contact. Optional filters: count or ids. Results are paginated. API summary: Get collection of resources (people/{…}/notes).list_contact_usersource_assocsList usersource assocs for a contact. Optional filters: count or ids. Results are paginated. API summary: Get collection of resources (people/{…}/usersourceassocs).list_contact_vcardsList vcards for a contact. API summary: Get tickets of the given person (people/{…}/vcard).list_content_templatesList content templates. Optional filters: count or ids. Results are paginated. API summary: Get collection of resources (contenttemplates).list_countsList counts. API summary: Count list (agentgroups/counts).list_counts_get_agent_chats_countsList counts. API summary: Count list (agentchats/counts).list_counts_get_agent_chats_messages_countsList counts. API summary: Count list (agentchats/messages/counts).list_counts_get_agent_chats_parent_id_messages_countsList counts. API summary: Count list (agentchats/{…}/messages/counts).list_counts_get_agent_teams_countsList counts. API summary: Count list (agentteams/counts).list_counts_get_agents_countsList counts. API summary: Count list (agents/counts).list_counts_get_article_categories_countsList counts. API summary: Count list (articlecategories/counts).list_counts_get_article_pending_creates_countsList counts. Optional filters: assigned person. API summary: Count list (articlependingcreates/counts).list_counts_get_articles_countsList counts. Optional filters: author, category, group by, status, hidden status or period created. API summary: Count list (articles/counts).list_counts_get_chat_departments_countsList counts. API summary: Count list (chatdepartments/counts).list_counts_get_community_forums_countsList counts. API summary: Count list (communityforums/counts).list_counts_get_community_topic_comments_countsList counts. API summary: Count list (communitytopiccomments/counts).list_counts_get_content_templates_countsList counts. API summary: Count list (contenttemplates/counts).list_counts_get_context_snippet_categories_countsList counts. API summary: Count list ({…}snippetcategories/counts).list_counts_get_context_snippets_countsList counts. API summary: Count list ({…}snippets/counts).list_counts_get_currencies_countsList counts. API summary: Count list (currencies/counts).list_counts_get_download_categories_countsList counts. API summary: Count list (downloadcategories/counts).list_counts_get_downloads_countsList counts. Optional filters: author, category, group by, status, hidden status or period created. API summary: Count list (downloads/counts).list_counts_get_glossary_countsList counts. API summary: Count list (glossary/counts).list_counts_get_glossary_words_countsList counts. API summary: Count list (glossary/words/counts).list_counts_get_guides_countsList counts. API summary: Count list (guides/counts).list_counts_get_importer_logs_countsList counts. API summary: Count list (importerlogs/counts).list_counts_get_languages_countsList counts. API summary: Count list (languages/counts).list_counts_get_me_notifications_countsList counts. API summary: Count list (me/notifications/counts).list_counts_get_news_categories_countsList counts. API summary: Count list (newscategories/counts).list_counts_get_news_countsList counts. Optional filters: author, category, group by, status, hidden status or period created. API summary: Count list (news/counts).list_counts_get_oauth_clients_countsList counts. API summary: Count list (oauthclients/counts).list_counts_get_organization_custom_fields_parent_id_options_couList counts. API summary: Count list (organizationcustomfields/{…}/options/counts).list_counts_get_organizations_parent_id_contact_data_countsList counts. API summary: Count list (organizations/{…}/contactdata/counts).list_counts_get_organizations_parent_id_members_countsList counts. API summary: Count list (organizations/{…}/members/counts).list_counts_get_organizations_parent_id_notes_countsList counts. API summary: Count list (organizations/{…}/notes/counts).list_counts_get_people_parent_id_contact_data_countsList counts. API summary: Count list (people/{…}/contactdata/counts).list_counts_get_people_parent_id_notes_countsList counts. API summary: Count list (people/{…}/notes/counts).list_counts_get_people_parent_id_notes_files_countsList counts. API summary: Count list (people/{…}/notesfiles/counts).list_counts_get_people_parent_id_usersource_assocs_countsList counts. API summary: Count list (people/{…}/usersourceassocs/counts).list_counts_get_person_contextual_fields_countsList counts. API summary: Count list (personcontextualfields/counts).list_counts_get_person_custom_fields_parent_id_options_countsList counts. API summary: Count list (personcustomfields/{…}/options/counts).list_counts_get_person_person_id_approval_responses_countsList counts. API summary: Count list (person/{…}/approvalresponses/counts).list_counts_get_system_incidents_countsList counts. API summary: Count list (system/incidents/counts).list_counts_get_tasks_countsList counts. Optional filters: title, person, date due, visibility, assigned agent or assigned agent team. API summary: Count list (tasks/counts).list_counts_get_tasks_parent_id_comments_countsList counts. API summary: Count list (tasks/{…}/comments/counts).list_counts_get_ticket_custom_fields_parent_id_options_countsList counts. API summary: Count list (ticketcustomfields/{…}/options/counts).list_counts_get_ticket_departments_countsList counts. API summary: Count list (ticketdepartments/counts).list_counts_get_ticket_problems_countsList counts. API summary: Count list (ticketproblems/counts).list_counts_get_ticket_stars_countsList counts. API summary: Get the counts of tickets marked with each star (ticketstars/counts).list_counts_get_ticket_statuses_countsList counts. API summary: Count list (ticketstatuses/counts).list_counts_get_tickets_countsList counts. API summary: Count list (tickets/counts).list_counts_get_tickets_parent_id_charges_countsList counts. API summary: Count list (tickets/{…}/charges/counts).list_counts_get_tickets_parent_id_community_topic_links_countsList counts. API summary: Count list (tickets/{…}/communitytopiclinks/counts).list_counts_get_tickets_parent_id_follow_ups_countsList counts. API summary: Count list (tickets/{…}/follow-ups/counts).list_counts_get_tickets_parent_id_logs_countsList counts. API summary: Count list (tickets/{…}/logs/counts).list_counts_get_tickets_parent_id_messages_countsList counts. API summary: Count list (tickets/{…}/messages/counts).list_counts_get_tickets_parent_id_ticket_slas_countsList counts. API summary: Count list (tickets/{…}/ticketslas/counts).list_counts_get_tickets_ticket_id_ticket_approvals_countsList counts. API summary: Count list (tickets/{…}/ticketapprovals/counts).list_counts_get_topics_countsList counts. Optional filters: author, guide, group by, status, hidden status or period created. API summary: Count list (topics/counts).list_counts_get_user_chat_custom_fields_parent_id_options_countsList counts. API summary: Count list (userchatcustomfields/{…}/options/counts).list_counts_get_user_chat_queues_countsList counts. API summary: Count list (userchatqueues/counts).list_counts_get_user_chats_conversation_id_messages_countsList counts. Optional filters: last message id or agent only. API summary: Count list (userchats/{…}/messages/counts).list_counts_get_user_groups_countsList counts. API summary: Count list (usergroups/counts).list_counts_get_voice_accounts_countsList counts. API summary: Count list (voiceaccounts/counts).list_counts_get_voice_accounts_plivo_countsList counts. API summary: Count list (voiceaccounts/plivo/counts).list_counts_get_voice_accounts_twilio_countsList counts. API summary: Count list (voiceaccounts/twilio/counts).list_counts_get_voice_assets_countsList counts. API summary: Count list (voiceassets/counts).list_counts_get_voice_auto_attendants_countsList counts. API summary: Count list (voiceautoattendants/counts).list_counts_get_voice_missed_agent_calls_countsList counts. API summary: Count list (voicemissedagentcalls/counts).list_counts_get_voice_numbers_countsList counts. API summary: Count list (voicenumbers/counts).list_counts_get_voice_phone_calls_countsList counts. API summary: Count list (voicephonecalls/counts).list_counts_get_voice_queues_countsList counts. API summary: Count list (voicequeues/counts).list_counts_get_webhooks_parent_id_triggers_countsList counts. API summary: Count list (webhooks/{…}/triggers/counts).list_csvsList csvs. Optional filters: count or ids. Results are paginated. API summary: Get an export of snippets (snippets/csv).list_currenciesList currencies. Optional filters: count or ids. Results are paginated. API summary: Get collection of resources (currencies).list_custom_iconsList custom icons. API summary: List custom icons of the current theme (customicons).list_customersList customers. Optional filters: count or ids. Results are paginated. API summary: Get collection of resources (oauthclients).list_customers_get_notify_setup_action_alerts_clientsList customers. API summary: This endpoint provide you an ability to get pusher credentials you are using (admin only). (notify/setup/action-alerts/clients).list_defaultsList defaults. API summary: list if default departments grouped by brand (settings/departments/default).list_device_setup_tokensList device setup tokens. API summary: get my profile action (me/device-setup-token).list_discoversList discovers. API summary: Used by apps to detect that this is a real helpdesk (helpdesk/discover).list_downloadsList downloads. Optional filters: count, ids, author, category, group by or status. Results are paginated. API summary: Get collection of resources (downloads).list_extendedsList extendeds. API summary: extended agents models (agents/extended).list_filter_ticketsList the tickets in a saved ticket filter by `ticket_filter` ID (from list_ticket_filters).list_generalsList generals. API summary: Get portal general settings (settings/brands/new/portal/general).list_glossariesList glossaries. Optional filters: count or ids. Results are paginated. API summary: Get collection of resources (glossary).list_groupsList groups. API summary: get agent chat groups (agentchats/groups).list_guide_treesList trees for a guide. API summary: give a topics tree list of a guide (guides/{…}/tree).list_guidesList guides. Optional filters: count or ids. Results are paginated. API summary: Get collection of resources (guides).list_importer_logsList importer logs. Optional filters: count or ids. Results are paginated. API summary: Get collection of resources (importerlogs).list_incidentsList incidents. Optional filters: count or ids. Results are paginated. API summary: Get collection of resources (system/incidents).list_infosList infos. API summary: get templates (emailtemplates/info).list_infos_get_helpdesk_agent_client_infoList infos. API summary: Used by apps when they need to know general information about a helpdesk such as which features are enabled (helpdesk/agent-client/info).list_jsList js. API summary: Get ticket layouts JS with compiled fields criteria (20170401/ticketlayouts/{…}.js).list_js_get_ticket_layouts_context_jsList js. API summary: Get ticket layouts JS with compiled fields criteria (ticketlayouts/{…}.js).list_kbsList kbs. API summary: Get portal general settings (settings/brands/{…}/portal/kb).list_keypairsList keypairs. API summary: Creates a new RSA keypair (crypto/keypairs).list_labelsList labels. Optional filters: count or ids. Results are paginated. API summary: Get collection of snippet labels (snippets/labels).list_languagesList languages. Optional filters: count or ids. Results are paginated. API summary: Get collection of resources (languages).list_legacy_templatesList legacy templates. API summary: Get legacy templates to upgrade (emailtemplates/legacytemplates).list_legacy_templates_get_portal_templates_legacy_templatesList legacy templates. API summary: Get legacy templates to upgrade (portaltemplates/legacytemplates).list_live_demo_codesList live demo codes. API summary: Get the HTML code for the widget (settings/brands/{…}/widget/livedemocode).list_message_documentsList documents for a message. Optional filters: count or ids. Results are paginated. API summary: Get collection of resources (tickets/{…}/messages/{…}/attachments).list_message_pagesList pages for a message. API summary: get page where this message is (agentchats/{…}/messages/{…}/page).list_newsList news. Optional filters: count, ids, author, category, group by or status. Results are paginated. API summary: Get collection of resources (news).list_notificationsList notifications. Optional filters: count or ids. Results are paginated. API summary: Get collection of resources (me/notifications).list_onlinesList onlines. API summary: get a list of online agents (agents/online).list_organization_custom_field_optionsList options for a organization custom field. Optional filters: count or ids. Results are paginated. API summary: Get collection of resources (organizationcustomfields/{…}/options).list_organization_custom_fieldsList organization custom fields. Optional filters: count or ids. Results are paginated. API summary: Get collection of resources (organizationcustomfields).list_organization_ticketsList the tickets belonging to an organization, by `organization_id`.list_pendingsList pendings. API summary: Get current user pending onboardings (people/onboarding/pending).list_person_contextual_fieldsList person contextual fields. Optional filters: count or ids. Results are paginated. API summary: Get collection of resources (personcontextualfields).list_person_custom_field_optionsList options for a person custom field. Optional filters: count or ids. Results are paginated. API summary: Get collection of resources (personcustomfields/{…}/options).list_person_custom_fieldsList person custom fields. Optional filters: count or ids. Results are paginated. API summary: Get collection of resources (personcustomfields).list_person_settingsList person settings. API summary: get person settings (personsetting).list_person_ticketsList the tickets opened by a person, by `person_id`.list_pingsList pings. API summary: ping and if it not the case install Zapier app (apps/zapier/ping).list_plivo_available_numbersList available numbers for a plivo. API summary: Returns a list of available numbers to buy (voiceaccounts/plivo/{…}/availablenumbers).list_plivo_existing_numbersList existing numbers for a plivo. Results are paginated. API summary: Returns a list of existing (bought) numbers (voiceaccounts/plivo/{…}/existingnumbers).list_plivosList plivos. Optional filters: count or ids. Results are paginated. API summary: Get collection of resources (voiceaccounts/plivo).list_portalsList portals. API summary: Get anti-abuse settings (settings/antiabuse/portal).list_profilesList profiles. API summary: get my profile action (me/profile).list_projectsList projects. API summary: Get collection of resources (jobs).list_randomsList randoms. Results are paginated. API summary: Get random images from unsplash (apps/unsplash/random).list_sample_statesList sample states. API summary: get widget sample online agent (widget/livedemo/samplestate).list_settingsList settings. API summary: Get current user personal settings (helpdesk/agent-client/settings).list_setupsList setups. API summary: get widget setup (settings/brands/{…}/widget/setup).list_slasList slas. API summary: get SLAs collection (slas).list_snippet_contentsList contents for a snippet. API summary: get the snippets content ({…}snippets/{…}/content).list_snippetsList snippets. Optional filters: count or ids. Results are paginated. API summary: Get collection of resources ({…}snippets).list_snippets_change_logsList snippets change logs. Optional filters: count, ids, inline sideloads, snippet id, language id or type. Results are paginated. API summary: Get collection of resources (snippetschangelogs).list_snippets_usesList snippets uses. Optional filters: count, ids, inline sideloads or snippet id. Results are paginated. API summary: Get collection of resources (snippetsuse).list_supplier_client_idsList client ids for a supplier. API summary: Get the Oauth client ID for a particular vendor (oauth/vendor/{…}/client-id).list_task_messagesList messages for a task. Optional filters: count or ids. Results are paginated. API summary: Get collection of resources (tasks/{…}/comments).list_tasksList agent tasks, filtered by `assigned_agent`, `ticket`, `labels` or `date_due`.list_ticket_attachmentsList the files attached to a ticket, given the ticket ID as `parent_id`.list_ticket_ccsList ccs for a ticket. Optional filters: count or ids. Results are paginated. API summary: Get collection of resources (tickets/{…}/cc).list_ticket_community_topic_linksList community topic links for a ticket. Optional filters: count or ids. Results are paginated. API summary: Get collection of resources (tickets/{…}/communitytopiclinks).list_ticket_custom_field_optionsList options for a ticket custom field. Optional filters: count or ids. Results are paginated. API summary: Get collection of resources (ticketcustomfields/{…}/options).list_ticket_custom_fieldsList ticket custom fields. Optional filters: count or ids. Results are paginated. API summary: Get collection of resources (ticketcustomfields).list_ticket_department_agentsList agents for a ticket department. API summary: Get agents belongs to department (ticketdepartments/{…}/agents).list_ticket_departmentsList the ticket departments with their IDs, for routing tickets.list_ticket_filtersList the saved ticket filters (views such as 'My tickets' or 'Unassigned') with their IDs.list_ticket_follow_upsList follow ups for a ticket. Optional filters: count or ids. Results are paginated. API summary: Get collection of resources (tickets/{…}/follow-ups).list_ticket_label_ticketsList tickets for a ticket label. API summary: Get tickets with the given label (ticketlabels/{…}/tickets).list_ticket_layout_jsList js for a ticket layout. API summary: Get ticket department layout JS with compiled fields criteria for given context (20170401/ticketlayouts/{…}/{…}.js).list_ticket_layout_js_get_ticket_layouts_context_department_jsList js for a ticket layout. API summary: Get ticket department layout JS with compiled fields criteria for given context (ticketlayouts/{…}/{…}.js).list_ticket_linksList links for a ticket. API summary: get tickets linked with ticket under provided id (tickets/{…}/links).list_ticket_list_ticketsList tickets for a ticket list. API summary: get tickets for specific ticket list (ticketlists/{…}/tickets).list_ticket_listsList ticket lists. Optional filters: count or ids. Results are paginated. API summary: Get collection of resources (ticketlists).list_ticket_logsList ticket logs. Optional filters: count, ids, action type or date created. Results are paginated. API summary: Get collection of resources (ticketlogs).list_ticket_macrosList ticket macros. Optional filters: count or ids. Results are paginated. API summary: Get collection of resources (ticketmacros).list_ticket_messagesList the messages (replies and notes) on a ticket, given the ticket ID as `parent_id`. Paged with `page` and `count`.list_ticket_paymentsList payments for a ticket. Optional filters: count or ids. Results are paginated. API summary: Get collection of resources (tickets/{…}/charges).list_ticket_problem_ticketsList tickets for a ticket problem. API summary: Get tickets associated with the given problem (ticketproblems/{…}/tickets).list_ticket_problemsList ticket problems. Optional filters: count or ids. Results are paginated. API summary: Get collection of resources (ticketproblems).list_ticket_star_ticketsList tickets for a ticket star. API summary: Get the tickets for a star (ticketstars/{…}/tickets).list_ticket_starsList ticket stars. API summary: get a list of ticket stars (ticketstars).list_ticket_status_ticketsList tickets for a ticket status. API summary: Get tickets with the given status (20190110/ticketstatuses/{…}/tickets).list_ticket_statusesList the ticket statuses (awaiting agent, awaiting user, resolved and custom sub-statuses) with their IDs.list_ticket_statuses_2List ticket statuses. API summary: Get all available statuses for tickets, sorted alphabetically (20190110/ticketstatuses).list_ticket_ticket_approvalsList ticket approvals for a ticket. Optional filters: count or ids. Results are paginated. API summary: Get collection of ticket approvals (tickets/{…}/ticketapprovals).list_ticket_ticket_slasList ticket slas for a ticket. Optional filters: count or ids. Results are paginated. API summary: Get collection of resources (tickets/{…}/ticketslas).list_ticket_viewsList views for a ticket. API summary: Ticket viewprint and pdf (tickets/{…}/view).list_ticketsList tickets. Optional filters: count or ids. Results are paginated. API summary: Get collection of resources (webhooks/tickets).list_timezonesList timezones. API summary: get timezones (timezones).list_topicsList topics. Optional filters: count, ids, author, guide, group by or status. Results are paginated. API summary: Get collection of resources (topics).list_totalsList totals. API summary: Get ticket charges total amounts (tickets/{…}/charges/total).list_triggersList triggers. Optional filters: count or ids. Results are paginated. API summary: Get collection of resources (webhooks/triggers).list_twilio_addressesList addresses for a twilio. API summary: Get a list of existing voice addresses (voiceaccounts/twilio/{…}/addresses).list_twilio_available_countriesList available countries for a twilio. API summary: Returns a list of available countries with voice service (voiceaccounts/twilio/{…}/availablecountries).list_twilio_available_numbersList available numbers for a twilio. API summary: Returns a list of available numbers to buy (voiceaccounts/twilio/{…}/availablenumbers).list_twilio_existing_numbersList existing numbers for a twilio. API summary: Returns a list of existing (bought) numbers (voiceaccounts/twilio/{…}/existingnumbers).list_twiliosList twilios. Optional filters: count or ids. Results are paginated. API summary: Get collection of resources (voiceaccounts/twilio).list_user_chat_custom_field_optionsList options for a user chat custom field. Optional filters: count or ids. Results are paginated. API summary: Get collection of resources (userchatcustomfields/{…}/options).list_user_chat_custom_fieldsList user chat custom fields. Optional filters: count or ids. Results are paginated. API summary: Get collection of resources (userchatcustomfields).list_user_chat_messagesList messages for a user chat. Optional filters: count, ids, last message id or agent only. Results are paginated. API summary: Get collection of resources (userchats/{…}/messages).list_user_chat_queuesList user chat queues. Optional filters: count or ids. Results are paginated. API summary: Get collection of resources (userchatqueues).list_user_groupsList user groups. Optional filters: count or ids. Results are paginated. API summary: Get collection of resources (usergroups).list_user_source_countsList counts for a user source. API summary: Count list (usersources/{…}/counts).list_user_sourcesList user sources. API summary: Get usersource settings (settings/usersource).list_voice_assetsList voice assets. Optional filters: count or ids. Results are paginated. API summary: Get collection of resources (voiceassets).list_voice_auto_attendantsList voice auto attendants. Optional filters: count or ids. Results are paginated. API summary: Get collection of resources (voiceautoattendants).list_voice_missed_agent_callsList voice missed agent calls. Optional filters: count or ids. Results are paginated. API summary: Get collection of resources (voicemissedagentcalls).list_voice_numbersList voice numbers. Optional filters: count or ids. Results are paginated. API summary: Get collection of resources (voicenumbers).list_voice_phone_callsList voice phone calls. Optional filters: count or ids. Results are paginated. API summary: Get collection of resources (voicephonecalls).list_voice_queuesList voice queues. Optional filters: count or ids. Results are paginated. API summary: Get collection of resources (voicequeues).list_voice_settingsList voice settings. API summary: Global voice settings (voicesettings).list_webhook_triggersList triggers for a webhook. Optional filters: count or ids. Results are paginated. API summary: Get collection of resources (webhooks/{…}/triggers).list_wordsList words. Optional filters: count or ids. Results are paginated. API summary: Get collection of resources (glossary/words).reject_ticket_approvalVisible to othersReject a ticket approval (ticket approval id). Has effects visible outside this system. API summary: Reject an approval (ticketapprovals/{…}/reject).reject_user_chatVisible to othersDecline a user chat (user chat id). Has effects visible outside this system. API summary: Join chat conversation (userchats/{…}/decline).reply_to_ticketChanges dataAdd a reply to a ticket (`parent_id`) with the text in `message`; set `is_note` to true for an internal note. A reply is emailed to the requester and cannot be unsent.retrieve_a_template_portal_templates_templateGet one template by name. API summary: Retrieve a template (portaltemplates/template/{…}).searchSearch one kind of record by `type` (ticket, person, organization, article, agent, news, download, chatconversation) with a search term `q`. Use this to find tickets and other records by keyword.search_agent_chat_messagesSearch messages for a agent chat by count, ids, search or order. Use this to find existing messages before creating a new message. Results are paginated. API summary: Get collection of resources (agentchats/{…}/messages).search_approval_templatesSearch approval templates by count, ids, type, name, description or required approvals. Use this to find existing approval templates before creating a new approval template. Results are paginated. API summary: Get collection of resources (approvaltemplates).search_approval_typesSearch approval types by count, ids, is deleted, name or description. Use this to find existing approval types before creating a new approval type. Results are paginated. API summary: get list of approval types (approvaltypes).search_countsSearch counts by type, name, description, required approvals, required rejections or can approvers view subject. Use this to find existing counts before creating a new count. API summary: Count list (approvaltemplates/counts).search_counts_get_approval_types_countsSearch counts by name, description or is deleted. Use this to find existing counts before creating a new count. API summary: Count list (approvaltypes/counts).search_counts_get_snippets_countsSearch counts by inline sideloads, type, count, ids, label or language. Use this to find existing counts before creating a new count. Results are paginated. API summary: Count list (snippets/counts).search_counts_get_ticket_filter_sets_all_countsSearch counts. Use this to find existing counts before creating a new count. API summary: Get all filter set counts (ticketfiltersets/all/counts).search_labelsSearch labels by term. Use this to find existing labels before creating a new label. API summary: Get all labels by types ({…}labels).search_people_and_organizationsSearch people and organizations together by name or email in `q`. Use this to find a person's or organization's ID.search_searchesSearch searches by q, sort or types. Use this to find existing searches before creating a new search. API summary: Search through articles, downloads, community topics, news, tickets, chatconversations, people and (search).search_snippetsSearch snippets by count, ids, inline sideloads, type, label or language. Use this to find existing snippets before creating a new snippet. Results are paginated. API summary: Get collection of resources (snippets).search_ticket_approversSearch approvers for a ticket by type, name, description, required approvals, required rejections or can approvers view subject. Use this to find existing approvers before creating a new approver. API summary: Get a list of approvers (approvaltemplates/{…}/ticket/{…}/approvers).search_ticket_filter_set_filtersSearch filters for a ticket filter set. Use this to find existing filters before creating a new filter. API summary: get filters belong to filter set (ticketfiltersets/{…}/filters).search_ticket_filter_setsSearch ticket filter sets. Use this to find existing ticket filter sets before creating a new ticket filter set. API summary: get filter sets (ticketfiltersets).search_ticket_filters2_setsSearch ticket filters2 sets by mine or ids. Use this to find existing ticket filters2 sets before creating a new ticket filters2 set. API summary: Get collection of resources (ticketfilters2sets).search_ticket_filters2_ticketsSearch tickets for a ticket filters2. Use this to find existing tickets before creating a new ticket. API summary: Get filter's tickets. See /tickets endpoint docs for the parameter details. (ticketfilters2/{…}/tickets).search_ticket_filters2sSearch ticket filters2s by count or ids. Use this to find existing ticket filters2s before creating a new ticket filters2. Results are paginated. API summary: Get collection of resources (ticketfilters2).search_ticket_filters_countsSearch ticket filters counts. Use this to find existing ticket filters counts before creating a new ticket filters count. API summary: Get all filters counts (ticketfilterscounts).search_unsplashesSearch unsplashes by query. Use this to find existing unsplashes before creating a new unsplash. Results are paginated. API summary: Search for specific unsplash image (apps/unsplash/search).send_accountVisible to othersEmail a account. Has effects visible outside this system. Results are paginated. API summary: Get collection of resources (emailaccounts).send_email_template_previewVisible to othersSend a email template. Has effects visible outside this system. API summary: Send preview of a template (emailtemplates/sendpreview).send_portal_template_previewVisible to othersSend a portal template. Has effects visible outside this system. API summary: Send preview of a template (portaltemplates/sendpreview).submit_email_template_templateVisible to othersRender a email template. Has effects visible outside this system. API summary: Render a template to preview (emailtemplates/rendertemplate).submit_messageDeletesMark all a message (parent id). Destructive action; may require approval. API summary: mark message as sent/read (agentchats/{…}/messages/markall).submit_plivo_endpointVisible to othersRefresh a plivo (account). Has effects visible outside this system. API summary: Regenerate a plivo endpoint for agent (voiceaccounts/plivo/{…}/refreshendpoint).submit_portal_template_templateVisible to othersRender a portal template. Has effects visible outside this system. API summary: Render a template to preview (portaltemplates/rendertemplate).submit_voice_missed_agent_callVisible to othersMark listened a voice missed agent call (record). Has effects visible outside this system. API summary: Mark voicemail record as listened to (voicemissedagentcalls/{…}/marklistened).update_agent_chatChanges dataUpdate an existing agent chat identified by agent chat id. API summary: update an agent chat (agentchats/{…}).update_agent_chat_messageChanges dataUpdate an existing message identified by message id. API summary: Update an existing resource (agentchats/{…}/messages/{…}).update_agent_passwordDeletesUpdate an existing agent identified by agent id. Destructive action; may require approval. API summary: set agent password (agents/{…}/set-password).update_agent_teamChanges dataUpdate an existing agent team identified by agent team id. API summary: Update an existing resource (agentteams/{…}).update_an_existing_resource_article_commentsChanges dataUpdate an existing message identified by message id. API summary: Update an existing resource (articlecomments/{…}).update_an_existing_resource_download_categoriesChanges dataUpdate an existing category identified by category id. API summary: Update an existing resource (downloadcategories/{…}).update_an_existing_resource_download_commentsChanges dataUpdate an existing message identified by message id. API summary: Update an existing resource (downloadcomments/{…}).update_an_existing_resource_guides_commentsChanges dataUpdate an existing message identified by message id. API summary: Update an existing resource (guidescomments/{…}).update_an_existing_resource_news_categoriesChanges dataUpdate an existing category identified by category id. API summary: Update an existing resource (newscategories/{…}).update_an_existing_resource_news_commentsChanges dataUpdate an existing message identified by message id. API summary: Update an existing resource (newscomments/{…}).update_an_existing_resource_snippet_categoriesChanges dataUpdate an existing category identified by category id. API summary: Update an existing resource ({…}snippetcategories/{…}).update_api_logs_optionsVisible to othersUpdate an existing api logs option. Has effects visible outside this system. API summary: update logging options (apilogsoptions).update_api_tagChanges dataUpdate an existing api tag identified by api tag id. API summary: update tags for key (apitags/{…}).update_approval_templateChanges dataUpdate an existing approval template identified by approval template id. API summary: Update an existing resource (approvaltemplates/{…}).update_approval_typeChanges dataUpdate an existing approval type identified by approval type id. API summary: Update an existing resource (approvaltypes/{…}).update_articleChanges dataUpdate a knowledge base article by `product_id` (the article ID): title, content, categories or status.update_article_custom_fieldChanges dataUpdate an existing article custom field identified by article custom field id. API summary: Update an existing resource (articlecustomfields/{…}).update_article_pending_createChanges dataUpdate an existing article pending create identified by article pending create id. API summary: Update an existing resource (articlependingcreates/{…}).update_captchasVisible to othersUpdate an existing captcha. Has effects visible outside this system. API summary: Update anti-abuse settings (settings/antiabuse/captcha).update_categoryChanges dataUpdate an existing category identified by category id. API summary: Update an existing resource (articlecategories/{…}).update_chat_departmentChanges dataUpdate an existing chat department identified by chat department id. API summary: Update an existing resource (chatdepartments/{…}).update_client_deviceChanges dataUpdate an existing client device identified by app type. API summary: Create a new resource (clientdevices/{…}).update_client_device_registerChanges dataUpdate an existing register identified by register id. API summary: Updates a given device or create it if it does not exist yet. (clientdevices/{…}/register/{…}).update_community_custom_fieldChanges dataUpdate an existing community custom field identified by community custom field id. API summary: Update an existing resource (communitycustomfields/{…}).update_community_topicChanges dataUpdate an existing community topic identified by community topic id. API summary: Update an existing resource (communitytopics/{…}).update_company_messageChanges dataUpdate an existing message identified by message id. API summary: Update an existing resource (organizations/{…}/notes/{…}).update_company_userChanges dataUpdate an existing user identified by user id. API summary: Update an existing resource (organizations/{…}/members/{…}).update_contact_documentChanges dataUpdate an existing document identified by document id. API summary: Update an existing resource (people/{…}/notesfiles/{…}).update_contact_messageChanges dataUpdate an existing message identified by message id. API summary: Update an existing resource (people/{…}/notes/{…}).update_content_templateChanges dataUpdate an existing content template identified by content template id. API summary: Update an existing resource (contenttemplates/{…}).update_customerChanges dataUpdate an existing customer identified by customer id. API summary: Update an existing resource (oauthclients/{…}).update_defaultsVisible to othersUpdate an existing default. Has effects visible outside this system. API summary: list if default departments grouped by brand (settings/departments/default).update_downloadChanges dataUpdate an existing download identified by download id. API summary: Update an existing resource (downloads/{…}).update_email_assetVisible to othersUpdate an existing email asset identified by type. Has effects visible outside this system. API summary: Add a new asset (emailtemplates/emailassets/{…}).update_glossaryChanges dataUpdate an existing glossary identified by glossary id. API summary: Update an existing resource (glossary/{…}).update_guideChanges dataUpdate an existing guide identified by guide id. API summary: Update an existing resource (guides/{…}).update_incidentChanges dataUpdate an existing incident identified by incident id. API summary: Update an existing resource (system/incidents/{…}).update_incidentsVisible to othersUpdate an existing incident. Has effects visible outside this system. API summary: change dismissed status for all incidents (system/incidents).update_marksVisible to othersUpdate an existing mark identified by parent id. Has effects visible outside this system. API summary: mark message as sent/read (agentchats/{…}/messages/mark).update_messageChanges dataUpdate an existing message identified by message id. API summary: Update an existing resource (communitytopiccomments/{…}).update_newsChanges dataUpdate an existing news identified by news id. API summary: Update an existing resource (news/{…}).update_onboardingChanges dataUpdate an existing onboarding identified by onboarding id. API summary: Update an existing resource (people/onboarding/{…}).update_organizationChanges dataUpdate an organization by `company_id`: name, email domains, phone numbers, labels, summary or custom fields.update_organization_custom_fieldChanges dataUpdate an existing organization custom field identified by organization custom field id. API summary: Update an existing resource (organizationcustomfields/{…}).update_organization_custom_field_optionChanges dataUpdate an existing option identified by option id. API summary: Update an existing resource (organizationcustomfields/{…}/options/{…}).update_personChanges dataUpdate a person by `contact_id`: name, organization, position, phone numbers, labels, summary or custom fields. Only the fields you pass change.update_person_contextual_fieldChanges dataUpdate an existing person contextual field identified by person contextual field id. API summary: Update an existing resource (personcontextualfields/{…}).update_person_custom_fieldChanges dataUpdate an existing person custom field identified by person custom field id. API summary: Update an existing resource (personcustomfields/{…}).update_person_custom_field_optionChanges dataUpdate an existing option identified by option id. API summary: Update an existing resource (personcustomfields/{…}/options/{…}).update_plivoChanges dataUpdate an existing plivo identified by plivo id. API summary: Update an existing resource (voiceaccounts/plivo/{…}).update_portalsVisible to othersUpdate an existing portal. Has effects visible outside this system. API summary: Update anti-abuse settings (settings/antiabuse/portal).update_profilesVisible to othersUpdate an existing profile. Has effects visible outside this system. API summary: edit agent profile (agents/profile).update_settingsVisible to othersUpdate an existing setting. Has effects visible outside this system. API summary: Set updater settings (helpdesk/updater/settings).update_snippetChanges dataUpdate an existing snippet identified by snippet id. API summary: Update an existing resource (snippets/{…}).update_taskChanges dataUpdate a task by `task_id`: title, due date, assignee, or mark it done with `is_completed`.update_task_messageChanges dataUpdate an existing message identified by message id. API summary: Update an existing resource (tasks/{…}/comments/{…}).update_templateVisible to othersUpdate an existing template identified by name. Has effects visible outside this system. API summary: Save a template (emailtemplates/template/{…}).update_template_post_portal_templates_template_nameChanges dataUpdate an existing template identified by name. API summary: Save a template (portaltemplates/template/{…}).update_ticketChanges dataUpdate a ticket by `ticket_id`: change `status`, `agent`, `department`, `urgency`, `subject`, `labels` or custom fields. Only the fields you pass change.update_ticket_custom_fieldChanges dataUpdate an existing ticket custom field identified by ticket custom field id. API summary: Update an existing resource (ticketcustomfields/{…}).update_ticket_custom_field_optionChanges dataUpdate an existing option identified by option id. API summary: Update an existing resource (ticketcustomfields/{…}/options/{…}).update_ticket_departmentChanges dataUpdate an existing ticket department identified by ticket department id. API summary: Update an existing resource (ticketdepartments/{…}).update_ticket_filterChanges dataUpdate an existing ticket filter identified by ticket filter id. API summary: Update an existing resource (ticketfilters/{…}).update_ticket_filters2Changes dataUpdate an existing ticket filters2 identified by ticket filters2 id. API summary: Update an existing resource (ticketfilters2/{…}).update_ticket_filters2_setChanges dataUpdate an existing ticket filters2 set identified by ticket filters2 set id. API summary: Update an existing resource (ticketfilters2sets/{…}).update_ticket_follow_upChanges dataUpdate an existing follow up identified by follow up id. API summary: Update an existing resource (tickets/{…}/follow-ups/{…}).update_ticket_formChanges dataUpdate an existing ticket form identified by context. API summary: Create a new resource (ticketforms/{…}).update_ticket_macro_applyChanges dataUpdate an existing apply identified by ticket. API summary: apply macro to ticket (ticketmacros/{…}/apply/{…}).update_ticket_mergeChanges dataUpdate an existing merge identified by merge id. API summary: Merge tickets (tickets/{…}/merge/{…}).update_ticket_messageChanges dataUpdate an existing message identified by message id. API summary: Update an existing resource (tickets/{…}/messages/{…}).update_ticket_paymentChanges dataUpdate an existing payment identified by payment id. API summary: Update an existing resource (tickets/{…}/charges/{…}).update_ticket_problemChanges dataUpdate an existing ticket problem identified by ticket problem id. API summary: Update an existing resource (ticketproblems/{…}).update_ticket_starChanges dataUpdate an existing ticket star identified by ticket star id. API summary: Update ticket star name (ticketstars/{…}).update_ticket_statusChanges dataUpdate an existing ticket status identified by ticket status id. API summary: Update an existing resource (ticketstatuses/{…}).update_ticket_ticket_slaChanges dataUpdate an existing ticket sla identified by ticket sla id. API summary: Update an existing resource (tickets/{…}/ticketslas/{…}).update_ticket_ticket_slasVisible to othersUpdate an existing ticket sla identified by parent id. Has effects visible outside this system. API summary: Update Ticket SLA. (tickets/{…}/ticketslas).update_translationChanges dataUpdate an existing translation identified by phrase name. API summary: provide translation of a phrase (languages/translations/{…}).update_twilioChanges dataUpdate an existing twilio identified by twilio id. API summary: Update an existing resource (voiceaccounts/twilio/{…}).update_twilio_addressChanges dataUpdate an existing address identified by address sid. API summary: Update an address (voiceaccounts/twilio/{…}/addresses/{…}).update_user_chatChanges dataUpdate an existing user chat identified by user chat id. API summary: Update an existing resource (userchats/{…}).update_user_chat_assignChanges dataUpdate an existing assign identified by agent id. API summary: Assign chat to agent (userchats/{…}/assign/{…}).update_user_chat_custom_fieldChanges dataUpdate an existing user chat custom field identified by user chat custom field id. API summary: Update an existing resource (userchatcustomfields/{…}).update_user_chat_custom_field_optionChanges dataUpdate an existing option identified by option id. API summary: Update an existing resource (userchatcustomfields/{…}/options/{…}).update_user_chat_endsVisible to othersUpdate an existing end identified by user chat id. Has effects visible outside this system. API summary: End a chat conversation (userchats/{…}/end).update_user_chat_invitesDeletesUpdate an existing invite identified by user chat id. Destructive action; may require approval. API summary: End a chat conversation (userchats/{…}/invite).update_user_chat_joinsVisible to othersUpdate an existing join identified by user chat id. Has effects visible outside this system. API summary: Join chat conversation (userchats/{…}/join).update_user_chat_leavesVisible to othersUpdate an existing leave identified by user chat id. Has effects visible outside this system. API summary: End a chat conversation (userchats/{…}/leave).update_user_chat_queueChanges dataUpdate an existing user chat queue identified by user chat queue id. API summary: Update an existing resource (userchatqueues/{…}).update_user_chat_startsVisible to othersUpdate an existing start identified by user chat id. Has effects visible outside this system. API summary: Start chat by joining chat conversion in no other agent has joined (userchats/{…}/start).update_user_chat_usersVisible to othersUpdate an existing user identified by user chat id. Has effects visible outside this system. API summary: End a chat conversation (userchats/{…}/blockuser).update_user_sourceChanges dataUpdate an existing user source identified by context. API summary: Create a new resource (usersources/{…}).update_voice_assetChanges dataUpdate an existing voice asset identified by voice asset id. API summary: Update an existing resource (voiceassets/{…}).update_voice_auto_attendantChanges dataUpdate an existing voice auto attendant identified by voice auto attendant id. API summary: Update an existing resource (voiceautoattendants/{…}).update_voice_numberChanges dataUpdate an existing voice number identified by voice number id. API summary: Update an existing resource (voicenumbers/{…}).update_voice_queueChanges dataUpdate an existing voice queue identified by voice queue id. API summary: Update an existing resource (voicequeues/{…}).update_voice_settingsVisible to othersUpdate an existing voice setting. Has effects visible outside this system. API summary: Global voice settings (voicesettings).update_webhook_triggerDeletesUpdate an existing trigger identified by trigger id. Destructive action; may require approval. API summary: Update an existing resource (webhooks/{…}/triggers/{…}).update_wordChanges dataUpdate an existing word identified by word id. API summary: Update an existing resource (glossary/words/{…}).upload_custom_iconChanges dataUpload a custom icon. API summary: Add a new custom icon (customicons/upload).
Set up in three steps
- 1
Pick the app
Create a free HeyMyApps account and choose Deskpro from the app list.
- 2
Paste your key
Enter your Deskpro helpdesk address without https:// (for example acme.deskpro.com) and an API key. In Deskpro go to the Admin interface > Apps & Integrations > API Keys and create an API key (you can bind it to an agent). Paste the full key including the leading number and colon, for example 5:ABC123.
- 3
Add the link to your AI
You get a personal MCP link. Add it to Claude, ChatGPT or Cursor:
- Click your name, then Settings › Connectors › Add custom connector.
- Paste your link as the Remote MCP server URL.
- Switch it on from the + menu in a chat.
Questions
What can the AI do in Deskpro?
The AI can search tickets, people, organizations, articles and more, read tickets with their messages and attachments, and list saved filters, statuses, departments and agents. It can create and update tickets, reply or add internal notes, update people and organizations, create organizations, manage knowledge base articles and create and update agent tasks.
Does the AI see my Deskpro credentials?
No. Your Deskpro API key is encrypted at rest and never shown to the AI. After you save it, it is not shown again, not even to you. The AI only sees the results of the tools it calls.
Can I control what the AI is allowed to do?
Yes. You choose which tools are switched on, so you can start read-only. A ticket reply is emailed to the requester and cannot be unsent, a new ticket may email the requester, and publishing an article puts it in your help center. These can require your approval before they run. Every tool call is logged.
Does it work with ChatGPT?
Yes. In ChatGPT go to Settings › Apps & Connectors › Advanced and turn on Developer mode, then add your HeyMyApps link. Developer mode needs a paid ChatGPT plan: Plus, Pro, Business or Enterprise. The same link also works in Claude (Settings › Connectors › Add custom connector), Cursor and other MCP clients.
What does it cost?
HeyMyApps has a free plan with no credit card required. Paid plans bill per completed task. You also need your own Deskpro helpdesk.
Which agent does the AI act as?
The AI acts as the agent the API key belongs to. When you create the key in Deskpro under Admin > Apps & Integrations > API Keys, you can bind it to an agent, so replies and changes show up under that agent. Ask the AI who it is working as, and it will check.
Let your AI work in Deskpro today.
Start free. Your key stays encrypted, and you decide what the AI may do.
Connect Deskpro freeHeyMyApps is not affiliated with Deskpro. Product names are trademarks of their owners.