Retrieve a ticket
/support/tickets/{ticket_id}Retrieves a support ticket by its public ID.
The response includes an ETag representing the current revision. Send this value in the If-Match header when updating the ticket to avoid overwriting a newer version.
If the credentials are restricted to specific users or products, tickets outside that scope return 404 Not Found, the same response as a ticket that does not exist.
Autonomous mode: the API credential secret, sent as a bearer token. Credential secrets are identified by a fixed prefix.
In: header
Path Parameters
Public ID of the ticket, prefixed with tkt_.
Header Parameters
Optional client-generated identifier of the request, up to 64 characters from [A-Za-z0-9._-]. Echoed back in the response and recorded in the request log; it never replaces the server-generated X-Request-Id.
length <= 64Response Body
application/json
application/json
application/json
application/json
application/json
application/json
curl -X GET "https://example.com/support/tickets/string"{ "data": { "anonymous": { "document": "string", "email": "string", "name": "string", "whatsapp": "string" }, "created_at": "2019-08-24T14:15:22Z", "department_id": "string", "id": "string", "last_reply_at": "2019-08-24T14:15:22Z", "object": "ticket", "product_id": "string", "replies_count": 0, "revision": "string", "status": "open", "subject": "string", "updated_at": "2019-08-24T14:15:22Z", "user": { "email": "user@example.com", "id": "string", "name": "string" } }}Create a ticket POST
Opens a support ticket on behalf of the specified user. The ticket is owned by that user, but its first message is attributed to the credential that made the request, not to the user. If `user_id`, `department_id`, or `product_id` does not reference a resource accessible with the current credentials, the request is rejected with a validation error for that field.
Update a ticket PATCH
Updates the subject or support department of a ticket, or closes and reopens it through `status`. Changing `status` requires the `tickets.close` permission in addition to `tickets.update`. Send the `ETag` returned by the retrieve operation in the `If-Match` header to avoid overwriting a newer version.