Appearance
Support tickets API
SaaS edition only. Customers open tickets (after the matching help articles) and talk with the team; administrators answer on the support desk with departments, tags, saved replies, internal notes and response-time targets.
All paths are relative to https://your-site.com/api/v1. Send Authorization: Bearer <token> and Accept: application/json; see authentication and errors.
GET /tickets/options
What a new ticket can say
Whether tickets are open, the active departments, the priorities and the file limits.
Responses
- 200 — data:
bash
curl -X GET "https://your-site.com/api/v1/tickets/options" \
-H "Authorization: Bearer $REPLORA_TOKEN" \
-H "Accept: application/json"GET /tickets
Your tickets
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
status | query | string | One of: active, closed, all. Default "active". | |
page | query | integer | Minimum 1. |
Responses
- 200 — data: tickets (id, reference, subject, status, priority, department, last_activity_at…); meta: page, total, open.
bash
curl -X GET "https://your-site.com/api/v1/tickets" \
-H "Authorization: Bearer $REPLORA_TOKEN" \
-H "Accept: application/json"POST /tickets
Open a ticket
Multipart. The team is told by email; you get a receipt.
Request body
multipart/form-data, required
| Field | Type | Required | Description |
|---|---|---|---|
subject | string | yes | At least 4 characters. At most 200 characters. |
body | string | yes | At least 10 characters. |
priority | string | One of: low, normal, high, urgent. | |
department_id | integer | ||
site_id | integer | One of your sites. | |
site_url | string (uri) | ||
session_url | string (uri) | ||
cc | string | Up to 5 addresses, separated by commas. | |
private_details | string | Encrypted; erased on close. At most 3000 characters. | |
files[] | string (binary)[] |
Responses
- 201 — data: the ticket.
- 403 — Tickets are closed.
- 422 —
bash
curl -X POST "https://your-site.com/api/v1/tickets" \
-H "Authorization: Bearer $REPLORA_TOKEN" \
-H "Accept: application/json" \
-F "subject=…" \
-F "body=…" \
-F "priority=…" \
-F "department_id=…"GET /tickets/{ticket}
One of your tickets with its messages
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
ticket | path | string (uuid) | yes |
Responses
- 200 — data: the ticket with messages and files (never the team’s internal notes).
- 404 — Missing, or another account's.
bash
curl -X GET "https://your-site.com/api/v1/tickets/{ticket}" \
-H "Authorization: Bearer $REPLORA_TOKEN" \
-H "Accept: application/json"PATCH /tickets/{ticket}
Close your ticket, or change its details
An empty private_details erases them.
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
ticket | path | string (uuid) | yes |
Request body
application/json, required
| Field | Type | Required | Description |
|---|---|---|---|
status | string | One of: closed. | |
site_url | string (uri) | ||
session_url | string (uri) | ||
cc | string | Up to 5 addresses, separated by commas. | |
private_details | string | Encrypted; erased on close. At most 3000 characters. |
Responses
- 200 — data: the ticket.
- 404 — Missing, or another account's.
- 422 —
bash
curl -X PATCH "https://your-site.com/api/v1/tickets/{ticket}" \
-H "Authorization: Bearer $REPLORA_TOKEN" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-d '{"status":"closed","site_url":"https://example.com","session_url":"https://example.com","cc":"text","private_details":"text"}'POST /tickets/{ticket}/messages
Reply to your ticket
Multipart. A closed ticket opens again.
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
ticket | path | string (uuid) | yes |
Request body
multipart/form-data, required
| Field | Type | Required | Description |
|---|---|---|---|
body | string | yes | |
files[] | string (binary)[] |
Responses
- 201 — data: the ticket.
- 404 — Missing, or another account's.
- 422 —
bash
curl -X POST "https://your-site.com/api/v1/tickets/{ticket}/messages" \
-H "Authorization: Bearer $REPLORA_TOKEN" \
-H "Accept: application/json" \
-F "body=…" \
-F "files[]=…"POST /tickets/{ticket}/rating
Rate the answer (1–5 stars)
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
ticket | path | string (uuid) | yes |
Request body
application/json, required
| Field | Type | Required | Description |
|---|---|---|---|
rating | integer | yes | Minimum 1. Maximum 5. |
comment | string | At most 1000 characters. |
Responses
- 200 — data: the ticket.
- 422 — Not answered yet, or an invalid rating.
bash
curl -X POST "https://your-site.com/api/v1/tickets/{ticket}/rating" \
-H "Authorization: Bearer $REPLORA_TOKEN" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-d '{"rating":1,"comment":"text"}'GET /ticket-files/{attachment}
A ticket’s file
For the ticket’s customer and the team (files of internal notes: the team only).
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
attachment | path | string (uuid) | yes |
Responses
- 200 — The file.
- 404 — Missing, or another account's.
bash
curl -X GET "https://your-site.com/api/v1/ticket-files/{attachment}" \
-H "Authorization: Bearer $REPLORA_TOKEN" \
-H "Accept: application/json"GET /desk/tickets
The support desk queue (administrators)
Overdue and urgent first. meta: page, counts per view, team, departments, tags, sla.
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
view | query | string | One of: active, mine, unassigned, overdue, open, answered, on_hold, closed, all. | |
priority | query | string | One of: low, normal, high, urgent. | |
department | query | integer | ||
tag | query | integer | ||
q | query | string | Subject, #reference, customer or message text. At most 200 characters. | |
page | query | integer | Minimum 1. |
Responses
- 200 — data: tickets with customer, assignee, due_at, overdue, tags.
- 403 — Not allowed (not an administrator, or outside the token's abilities).
- 422 —
bash
curl -X GET "https://your-site.com/api/v1/desk/tickets" \
-H "Authorization: Bearer $REPLORA_TOKEN" \
-H "Accept: application/json"GET /desk/tickets/{ticket}
A ticket on the desk (administrators)
With internal notes, activity and the customer’s other tickets; meta: team, departments, tags, saved replies, file limits.
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
ticket | path | string (uuid) | yes |
Responses
- 200 — data: the ticket; meta: the desk lists.
- 403 — Not allowed (not an administrator, or outside the token's abilities).
- 404 — Missing, or another account's.
bash
curl -X GET "https://your-site.com/api/v1/desk/tickets/{ticket}" \
-H "Authorization: Bearer $REPLORA_TOKEN" \
-H "Accept: application/json"PATCH /desk/tickets/{ticket}
Change status, priority, assignee or department (administrators)
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
ticket | path | string (uuid) | yes |
Request body
application/json, required
| Field | Type | Required | Description |
|---|---|---|---|
status | string | One of: open, answered, on_hold, closed. | |
priority | string | One of: low, normal, high, urgent. | |
assignee_id | integer, nullable | ||
department_id | integer, nullable |
Responses
- 200 — data: the ticket.
- 403 — Not allowed (not an administrator, or outside the token's abilities).
- 422 —
bash
curl -X PATCH "https://your-site.com/api/v1/desk/tickets/{ticket}" \
-H "Authorization: Bearer $REPLORA_TOKEN" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-d '{"status":"open","priority":"low","assignee_id":1,"department_id":1}'DELETE /desk/tickets/{ticket}
Delete a ticket with its files (administrators)
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
ticket | path | string (uuid) | yes |
Responses
- 204 — Deleted.
- 403 — Not allowed (not an administrator, or outside the token's abilities).
bash
curl -X DELETE "https://your-site.com/api/v1/desk/tickets/{ticket}" \
-H "Authorization: Bearer $REPLORA_TOKEN" \
-H "Accept: application/json"POST /desk/tickets/{ticket}/messages
Answer, or add an internal note (administrators)
Multipart. An answer sets the status (default answered) and assigns an unassigned ticket to you.
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
ticket | path | string (uuid) | yes |
Request body
multipart/form-data, required
| Field | Type | Required | Description |
|---|---|---|---|
body | string | yes | |
internal | boolean | ||
status | string | One of: open, answered, on_hold, closed. | |
files[] | string (binary)[] |
Responses
- 201 — data: the ticket.
- 403 — Not allowed (not an administrator, or outside the token's abilities).
- 422 —
bash
curl -X POST "https://your-site.com/api/v1/desk/tickets/{ticket}/messages" \
-H "Authorization: Bearer $REPLORA_TOKEN" \
-H "Accept: application/json" \
-F "body=…" \
-F "internal=…" \
-F "status=…" \
-F "files[]=…"PUT /desk/tickets/{ticket}/tags
Set a ticket’s tags (administrators)
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
ticket | path | string (uuid) | yes |
Request body
application/json, required
| Field | Type | Required | Description |
|---|---|---|---|
tags | integer[] | yes |
Responses
- 200 — data: the ticket.
- 403 — Not allowed (not an administrator, or outside the token's abilities).
- 422 —
bash
curl -X PUT "https://your-site.com/api/v1/desk/tickets/{ticket}/tags" \
-H "Authorization: Bearer $REPLORA_TOKEN" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-d '{"tags":[1]}'POST /desk/tickets/{ticket}/private
Reveal the private access details (administrators)
Each reading is logged in the activity.
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
ticket | path | string (uuid) | yes |
Responses
- 200 — data:
- 403 — Not allowed (not an administrator, or outside the token's abilities).
- 404 — None stored.
bash
curl -X POST "https://your-site.com/api/v1/desk/tickets/{ticket}/private" \
-H "Authorization: Bearer $REPLORA_TOKEN" \
-H "Accept: application/json"POST /desk/tickets-bulk
Change or delete several tickets (administrators)
No emails are sent for bulk changes.
Request body
application/json, required
| Field | Type | Required | Description |
|---|---|---|---|
ids | string (uuid)[] | yes | At most 100 items. |
action | string | yes | One of: status, priority, assignee_id, delete. |
value | string | integer, nullable |
Responses
- 200 — data:
- 403 — Not allowed (not an administrator, or outside the token's abilities).
- 422 —
bash
curl -X POST "https://your-site.com/api/v1/desk/tickets-bulk" \
-H "Authorization: Bearer $REPLORA_TOKEN" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-d '{"ids":["text"],"action":"status","value":"text"}'GET /desk/staff
The support team with roles (administrators)
Administrators (role admin), managers and agents, with their open tickets.
Responses
- 200 — data: [{id, name, email, role, open_tickets}]
- 403 — Not allowed (not an administrator, or outside the token's abilities).
bash
curl -X GET "https://your-site.com/api/v1/desk/staff" \
-H "Authorization: Bearer $REPLORA_TOKEN" \
-H "Accept: application/json"PUT /desk/staff/{user}
Give someone a support role, or take it away (administrators)
Agents see and answer the tickets assigned to them; managers see every ticket and assign them.
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
user | path | integer | yes |
Request body
application/json, required
| Field | Type | Required | Description |
|---|---|---|---|
role | string, nullable | yes | One of: agent, manager, null. |
Responses
- 200 — data:
- 403 — Not allowed (not an administrator, or outside the token's abilities).
- 422 — An administrator, or an invalid role.
bash
curl -X PUT "https://your-site.com/api/v1/desk/staff/{user}" \
-H "Authorization: Bearer $REPLORA_TOKEN" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-d '{"role":"agent"}'GET /desk/catalog
Departments, tags and saved replies (administrators)
Responses
- 200 — data:
- 403 — Not allowed (not an administrator, or outside the token's abilities).
bash
curl -X GET "https://your-site.com/api/v1/desk/catalog" \
-H "Authorization: Bearer $REPLORA_TOKEN" \
-H "Accept: application/json"POST /desk/departments
Add a department (administrators)
Request body
application/json, required
| Field | Type | Required | Description |
|---|---|---|---|
name | string | At most 80 characters. | |
description | string, nullable | At most 200 characters. | |
sort | integer | ||
is_active | boolean |
Responses
- 201 — data: the new item.
- 403 — Not allowed (not an administrator, or outside the token's abilities).
- 422 —
bash
curl -X POST "https://your-site.com/api/v1/desk/departments" \
-H "Authorization: Bearer $REPLORA_TOKEN" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-d '{"name":"text","description":"text","sort":1,"is_active":true}'PATCH /desk/departments/{department}
Change a department (administrators)
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
department | path | integer | yes |
Request body
application/json, required
| Field | Type | Required | Description |
|---|---|---|---|
name | string | At most 80 characters. | |
description | string, nullable | At most 200 characters. | |
sort | integer | ||
is_active | boolean |
Responses
- 200 — data: the item.
- 403 — Not allowed (not an administrator, or outside the token's abilities).
- 422 —
bash
curl -X PATCH "https://your-site.com/api/v1/desk/departments/{department}" \
-H "Authorization: Bearer $REPLORA_TOKEN" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-d '{"name":"text","description":"text","sort":1,"is_active":true}'DELETE /desk/departments/{department}
Delete a department (administrators)
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
department | path | integer | yes |
Responses
- 204 — Deleted.
- 403 — Not allowed (not an administrator, or outside the token's abilities).
bash
curl -X DELETE "https://your-site.com/api/v1/desk/departments/{department}" \
-H "Authorization: Bearer $REPLORA_TOKEN" \
-H "Accept: application/json"POST /desk/tags
Add a tag (administrators)
Request body
application/json, required
| Field | Type | Required | Description |
|---|---|---|---|
name | string | At most 40 characters. | |
color | string | One of: accent, up, warn, down, gray. |
Responses
- 201 — data: the new item.
- 403 — Not allowed (not an administrator, or outside the token's abilities).
- 422 —
bash
curl -X POST "https://your-site.com/api/v1/desk/tags" \
-H "Authorization: Bearer $REPLORA_TOKEN" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-d '{"name":"text","color":"accent"}'PATCH /desk/tags/{tag}
Change a tag (administrators)
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
tag | path | integer | yes |
Request body
application/json, required
| Field | Type | Required | Description |
|---|---|---|---|
name | string | At most 40 characters. | |
color | string | One of: accent, up, warn, down, gray. |
Responses
- 200 — data: the item.
- 403 — Not allowed (not an administrator, or outside the token's abilities).
- 422 —
bash
curl -X PATCH "https://your-site.com/api/v1/desk/tags/{tag}" \
-H "Authorization: Bearer $REPLORA_TOKEN" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-d '{"name":"text","color":"accent"}'DELETE /desk/tags/{tag}
Delete a tag (administrators)
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
tag | path | integer | yes |
Responses
- 204 — Deleted.
- 403 — Not allowed (not an administrator, or outside the token's abilities).
bash
curl -X DELETE "https://your-site.com/api/v1/desk/tags/{tag}" \
-H "Authorization: Bearer $REPLORA_TOKEN" \
-H "Accept: application/json"POST /desk/saved-replies
Add a saved reply (administrators)
Request body
application/json, required
| Field | Type | Required | Description |
|---|---|---|---|
title | string | At most 120 characters. | |
body | string |
Responses
- 201 — data: the new item.
- 403 — Not allowed (not an administrator, or outside the token's abilities).
- 422 —
bash
curl -X POST "https://your-site.com/api/v1/desk/saved-replies" \
-H "Authorization: Bearer $REPLORA_TOKEN" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-d '{"title":"text","body":"text"}'PATCH /desk/saved-replies/{reply}
Change a saved reply (administrators)
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
reply | path | integer | yes |
Request body
application/json, required
| Field | Type | Required | Description |
|---|---|---|---|
title | string | At most 120 characters. | |
body | string |
Responses
- 200 — data: the item.
- 403 — Not allowed (not an administrator, or outside the token's abilities).
- 422 —
bash
curl -X PATCH "https://your-site.com/api/v1/desk/saved-replies/{reply}" \
-H "Authorization: Bearer $REPLORA_TOKEN" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-d '{"title":"text","body":"text"}'DELETE /desk/saved-replies/{reply}
Delete a saved reply (administrators)
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
reply | path | integer | yes |
Responses
- 204 — Deleted.
- 403 — Not allowed (not an administrator, or outside the token's abilities).
bash
curl -X DELETE "https://your-site.com/api/v1/desk/saved-replies/{reply}" \
-H "Authorization: Bearer $REPLORA_TOKEN" \
-H "Accept: application/json"