ConnectCloud Desk API
Tickets, issues and tasks with configurable spaces, types, workflows and fields; comments, mail, attachments, SLAs, automation rules, projects and their payment plans.
The interactive reference needs JavaScript. Every operation also has its own page:
Configuration
Items
GET /items List items (desk:read)POST /items Create an item (desk:write)POST /items/check Check a new item without creating it (desk:write)POST /items/bulk Change status, fields and labels of many items, or check first with dryRun (desk:write)POST /items/merge Merge several items into one, all or none (desk:write)GET /search Full-text search over items and comments (desk:read)GET /items/{ref} Get an item (desk:read)PATCH /items/{ref} Partially update an item (desk:write)POST /items/{ref}/transition Change the status along the workflow (desk:write)GET /items/{ref}/move-preview Preview moving an item to another space and/or type (desk:read)POST /items/{ref}/move Move an item to another space and/or type (service desk ↔ development) (desk:write)POST /items/{ref}/merge Merge this item into another one (desk:write)POST /items/{ref}/split Create a new item from this one and move selected entries to it (desk:write)GET /items/{ref}/handoffs List the handoffs and conversions of a ticket (desk:read; who sees the ticket)POST /items/{ref}/handoffs Hand a ticket over to a desk space or a forge project as a new linked item (desk:write; agent in the ticket's space)POST /items/{ref}/handoffs/{handoffId}/return Hand a received ticket back (desk:write; agent in the ticket's space)POST /items/{ref}/convert Convert a ticket to another desk space or to a forge project (desk:write; agent in the ticket's space)POST /items/{ref}/assign Put a person and/or a team on a ticket (desk:write, agent role)POST /items/{ref}/unassign Take people off a ticket (desk:write, agent role)POST /items/{ref}/labels/add Add a label to a ticket by its name (desk:write, agent role)POST /items/{ref}/labels/remove Remove a label from a ticket by its name (desk:write, agent role)POST /items/{ref}/due Set the due date of a ticket relative to now (desk:write, agent role)POST /items/{ref}/follow-up Set the follow-up of a ticket relative to now (desk:write, agent role)POST /items/{ref}/linked-comments Comment on the tickets linked to a ticket (desk:write, agent role)GET /items/{ref}/children Direct children (desk:read)
Activity
Time
GET /contracts Active contracts of a customer for tickets (desk:write)
Callbacks
Mail
GET /mail-sources Mailboxes that feed desk: the comms mailbox, default space and type, routes (desk:admin)POST /mail-sources Let a comms mailbox (consumer desk) feed a space; one source per mailbox (desk:admin)PUT /mail-sources/{id} Change a mail source; needs the current version, the mailbox cannot change (desk:admin)DELETE /mail-sources/{id} Stop a mailbox from feeding desk; its mail is logged as unrouted (desk:admin)GET /mail-log What desk made of received mail: created, appended, held, dropped, unrouted, failed (desk:admin)POST /mail-log/{id}/release Turn a held, dropped, unrouted or failed mail into a ticket, or append it to itemId (desk:admin)GET /me/mail-signature The caller's mail signature (Markdown) (desk:read)PUT /me/mail-signature Save the caller's mail signature (desk:write)GET /items/{ref}/entries/{entryId}/mail Mail of an email entry: headers, recipients, delivery, attachments and the HTML body sanitised for display (desk:read)DELETE /items/{ref}/entries/{entryId}/mail Delete a draft (desk:write, agent role)PATCH /items/{ref}/entries/{entryId}/mail Change a draft; send it with send=true (desk:write, agent role)POST /items/{ref}/entries/{entryId}/mail/resend Send a failed mail again as a new entry, optionally to corrected recipients (to, cc, bcc; agent role) (desk:write)GET /items/{ref}/mail/defaults Composer defaults: requester (to) and people in copy, reply subject with [#N], mailbox and signature (desk:read, agent role)POST /items/{ref}/mail Write a mail: saved as draft, sent with send=true (desk:write, agent role)POST /items/{ref}/mail/preview Render a mail exactly as it would be sent (desk:write, agent role)GET /items/{ref}/participants Requester and people in copy (receive replies, see the ticket in the customer portal) (desk:read)POST /items/{ref}/participants Add a person in copy, or make them the requester (the previous requester stays in copy; agent role) (desk:write)DELETE /items/{ref}/participants/{requesterId} Take a person off the ticket (desk:write, agent role)GET /items/{ref}/attachments Files of the ticket: every file, mail attachments, inline images, originals (.eml) and generated files (desk:read)POST /items/{ref}/attachments Upload a file to the ticket, within the tenant's mail limits (desk:write, agent role)GET /items/{ref}/attachments/{documentId}/content A file of the ticket: viewable types inline, everything else and download=true as attachment (desk:read)GET /items/{ref}/attachments/{documentId}/mail A stored mail (.eml, message/rfc822) of the ticket for display: headers, text, sanitised HTML and part manifest (desk:read)
Projects
Portal
GET /portal-config Desk's app settings of the customer portal (tickets, help); without them the defaults at version 0 (desk:admin, ADR 0023)PUT /portal-config Create (version 0) or change desk's app settings of the customer portal at their version (desk:admin)GET /help-stats Help area numbers of the customer portal per day (UTC) of the last days, today included: articles suggested while writing a ticket, opened from a suggestion, marked as helpful. Days without events are missing (desk:admin)GET /requesters Search people who wrote to desk or use the portal by address or name (desk:write)GET /requesters/{id} A requester with the number of its tickets (desk:write)PATCH /requesters/{id} Change name, contact and company, or block a requester (desk:write); a blocked requester cannot use desk's portal apps from the next request on
AI
GET /ai/calls Log of AI calls: feature, model, tokens, latency, outcome – never prompts or answers (desk:admin, KI-016)GET /ai/stats Suggestions, decisions, ratings and tokens per feature (desk:admin, KI-014)GET /ai/customers Per-customer AI switches (desk:admin, KI-009)PUT /ai/customers/{customerId} Turn a feature (or * for all) on or off for a customer; enabled null removes the switch (desk:admin)POST /items/{ref}/ai/{feature} Ask for an AI suggestion (desk:write, agent role)GET /items/{ref}/suggestions AI suggestions of an item, newest first (desk:read)POST /items/{ref}/suggestions/{sid}/{decision} Accept (optionally edited), reject or undo a suggestion (desk:write, agent role)POST /items/{ref}/suggestions/{sid}/feedback Rate a suggestion (KI-015) (desk:write)
SLA
Automation