HTTP API

Reference

Support API

Endpoints for the support tickets of the desks the caller works on, and their links to project requests and tasks.

This group covers the support tickets of the desks the caller works on: their fields, messages, status and assignees, and the links between tickets and project requests and tasks. Every call acts as a person: send a personal access token, or an OAuth access token from a person's sign-in (scope Volobox). An integration app's own client secret is refused with 403 (Volobox:Integrations:MemberConnectionRequired). Paths, tokens and conventions are in API overview.

Tickets

GET/api/v1/ticket
Lists the support tickets of the desks the caller works on, filtered and paged.
support.ticket.getList
GET/api/v1/ticket/{id}
Gets a support ticket with its thread, as the caller's desk role lets them see it.
support.ticket.get
PUT/api/v1/ticket/{id}
Updates a ticket's subject, priority, category, routed project or custom fields.
support.ticket.updateFields
POST/api/v1/ticket/{id}/assignee
Assigns a person or agent to a ticket.
support.ticket.addAssignee
DELETE/api/v1/ticket/{id}/assignee/{principalType}/{principalId}
Removes an assignee from a ticket.
support.ticket.removeAssignee
POST/api/v1/ticket/{id}/merge
Merges a ticket into another ticket of the same desk.
support.ticket.merge
POST/api/v1/ticket/{id}/message
Adds a message to a ticket: an internal note for the team, or a reply the customer sees.
support.ticket.postMessage
PUT/api/v1/ticket/{id}/message/{messageId}
Edits a message the caller wrote on a ticket.
support.ticket.editMessage
DELETE/api/v1/ticket/{id}/message/{messageId}
Deletes a message from a ticket, the caller's own or one the desk lets them moderate.
support.ticket.deleteMessage
POST/api/v1/ticket/{id}/status
Changes the status of a ticket.
support.ticket.changeStatus

Request bodies:

  • UpdateTicketFieldsDto (updateFields): no field is required.
GET/api/v1/ticket-link/request/{projectRequestId}
Lists the support tickets linked to a project request the caller can read.
support.ticketLink.getForRequest
GET/api/v1/ticket-link/search-requests
Searches the project requests a ticket can be linked to.
support.ticketLink.searchRequests
GET/api/v1/ticket-link/search-tasks
Searches the project tasks a ticket can be linked to.
support.ticketLink.searchTasks
GET/api/v1/ticket-link/task/{projectTaskId}
Lists the support tickets linked to a project task the caller can read.
support.ticketLink.getForTask
GET/api/v1/ticket-link/ticket/{ticketId}
Lists the project requests and tasks a ticket is linked to.
support.ticketLink.getForTicket
GET/api/v1/ticket-link/ticket/{ticketId}/linkable-projects
Lists the projects of a ticket's desk the caller can work in, where its requests and tasks can be linked or created.
support.ticketLink.getLinkableProjects
POST/api/v1/ticket-link/ticket/{ticketId}/requests
Links a ticket to a project request that answers it.
support.ticketLink.linkRequest
DELETE/api/v1/ticket-link/ticket/{ticketId}/requests/{projectRequestId}
Removes the link between a ticket and a project request.
support.ticketLink.unlinkRequest
POST/api/v1/ticket-link/ticket/{ticketId}/tasks
Links a ticket to a project task that answers it.
support.ticketLink.linkTask
DELETE/api/v1/ticket-link/ticket/{ticketId}/tasks/{projectTaskId}
Removes the link between a ticket and a project task.
support.ticketLink.unlinkTask

Example

support.ticket.getList: lists the support tickets of the desks the caller works on, filtered and paged.

curl
curl -s "https://volobox.example.com/api/v1/ticket?SkipCount=0&MaxResultCount=20" \
  -H "Authorization: Bearer $VOLOBOX_TOKEN"

SkipCount is how many items to skip and MaxResultCount how many to return. The answer carries totalCount and the page of items.