Skip to main content
The Tickets endpoints power the internal support and task queue. Tickets can be associated with client records, carry document attachments, and support collaborative workflows via activity feeds, watchers, and external user access.

Subsections

Activities

Manage the activity feed on a support ticket.

Watchers

Manage notification subscribers on a support ticket.

External Users

Grant and manage external user access to a support ticket.

Client Associations

Link and manage client records associated with a ticket.

Documents

Manage documents attached to a support ticket.

SAM Action Logs

Retrieve audit log entries for platform entities.

What’s included

Core

EndpointDescription
List ticketsRetrieve a paginated list of support tickets
Create ticketCreate a new support ticket
Get ticketRetrieve a single ticket by ID
Update ticketUpdate an existing support ticket
Merge ticketsConsolidate a duplicate ticket into another
Split ticketBreak a ticket into two separate issues
List categoriesRetrieve the full ticket category taxonomy

Activities

EndpointDescription
List activitiesRetrieve all activity entries for a ticket
Create activityAppend a comment or work log entry to the activity feed
Update activityEdit an existing activity entry
Delete activityRemove an activity entry from a ticket

Watchers

EndpointDescription
List watchersRetrieve all watchers on a ticket
Add watcherSubscribe a user to ticket notifications
Remove watcherUnsubscribe a user from ticket notifications

External users

EndpointDescription
List external usersRetrieve all external users on a ticket
Add external userAdd a non-platform user to a ticket
Remove external userRemove an external user from a ticket

Client associations

EndpointDescription
List clientsRetrieve all clients linked to a ticket
Add clientAssociate a client with a ticket
Remove clientRemove a client association from a ticket

Documents

EndpointDescription
List documentsRetrieve all documents attached to a ticket
Add documentAttach a document to a ticket
Get documentRetrieve a single ticket document
Update documentUpdate document metadata
Delete documentRemove a document from a ticket

Audit

EndpointDescription
List SAM action logsRetrieve SAM (status/action/message) audit log entries for any platform entity