Ticket Meta
List active ticket statuses (bare array)
Example request
curl "https://YOUR-HOST/api/v1/statuses" \
-H "Authorization: Bearer $TOKEN"
import requests
response = requests.get(
"https://YOUR-HOST/api/v1/statuses",
headers={"Authorization": f"Bearer {TOKEN}"},
)
print(response.json())
const response = await fetch("https://YOUR-HOST/api/v1/statuses", {
method: "GET",
headers: { "Authorization": `Bearer ${TOKEN}` },
});
const data = await response.json();
$ch = curl_init("https://YOUR-HOST/api/v1/statuses");
curl_setopt_array($ch, [
CURLOPT_RETURNTRANSFER => true,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => ["Authorization: Bearer $token"],
]);
$data = json_decode(curl_exec($ch), true);
Responses
200Ticket statuses
| Field | Type | Description |
|---|---|---|
| []id | integer | |
| []name | string | |
| []color | string |
Example response
json
[
{
"id": 1,
"name": "string",
"color": "string"
}
]
List ticket categories (bare array)
Example request
curl "https://YOUR-HOST/api/v1/ticket-categories" \
-H "Authorization: Bearer $TOKEN"
import requests
response = requests.get(
"https://YOUR-HOST/api/v1/ticket-categories",
headers={"Authorization": f"Bearer {TOKEN}"},
)
print(response.json())
const response = await fetch("https://YOUR-HOST/api/v1/ticket-categories", {
method: "GET",
headers: { "Authorization": `Bearer ${TOKEN}` },
});
const data = await response.json();
$ch = curl_init("https://YOUR-HOST/api/v1/ticket-categories");
curl_setopt_array($ch, [
CURLOPT_RETURNTRANSFER => true,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => ["Authorization: Bearer $token"],
]);
$data = json_decode(curl_exec($ch), true);
Responses
200Ticket categories
| Field | Type | Description |
|---|---|---|
| []id | integer | |
| []name | string | |
| []color | string |
Example response
json
[
{
"id": 1,
"name": "string",
"color": "string"
}
]
List saved ticket views translated to list query params (bare array)
Example request
curl "https://YOUR-HOST/api/v1/ticket-views" \
-H "Authorization: Bearer $TOKEN"
import requests
response = requests.get(
"https://YOUR-HOST/api/v1/ticket-views",
headers={"Authorization": f"Bearer {TOKEN}"},
)
print(response.json())
const response = await fetch("https://YOUR-HOST/api/v1/ticket-views", {
method: "GET",
headers: { "Authorization": `Bearer ${TOKEN}` },
});
const data = await response.json();
$ch = curl_init("https://YOUR-HOST/api/v1/ticket-views");
curl_setopt_array($ch, [
CURLOPT_RETURNTRANSFER => true,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => ["Authorization: Bearer $token"],
]);
$data = json_decode(curl_exec($ch), true);
Responses
200Saved views
| Field | Type | Description |
|---|---|---|
| []id | integer | |
| []name | string | |
| []icon | string | |
| []params | object | Query parameters for /tickets. Multi-value filters are comma-separated (priority "high,medium", assigned "me,unassigned,7", board/category_id "3,4"). |
| []shared | boolean | True when the view is shared with all agents |
| []is_default | boolean | True when this is the view that opens by default for the calling user |
| []default_scope | string (personal | shared) | Whose default it is (the caller's own, or the one for everyone), null when not the default |
Example response
json
[
{
"id": 1,
"name": "string",
"icon": "string",
"params": {},
"shared": true,
"is_default": true,
"default_scope": "personal"
}
]