Skip to content

API reference / RivetMSP

Dashboard

GET /dashboard Bearer token or API key

Agent dashboard counters and personal ticket queue

Example request

curl "https://YOUR-HOST/api/v1/dashboard" \
  -H "Authorization: Bearer $TOKEN"
import requests

response = requests.get(
    "https://YOUR-HOST/api/v1/dashboard",
    headers={"Authorization": f"Bearer {TOKEN}"},
)
print(response.json())
const response = await fetch("https://YOUR-HOST/api/v1/dashboard", {
  method: "GET",
  headers: { "Authorization": `Bearer ${TOKEN}` },
});
const data = await response.json();
$ch = curl_init("https://YOUR-HOST/api/v1/dashboard");
curl_setopt_array($ch, [
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_CUSTOMREQUEST => "GET",
    CURLOPT_HTTPHEADER => ["Authorization: Bearer $token"],
]);
$data = json_decode(curl_exec($ch), true);

Responses

200Dashboard summary

FieldTypeDescription
my_open integer
all_open integer
unread integer
overdue integer
due_today integer
onsite_open integer
queue array of object
queue[].id integer
queue[].number integer
queue[].subject string
queue[].priority string
queue[].status string
queue[].status_color string
queue[].client string
queue[].assigned_to string
queue[].created_at string
queue[].due_at string
queue[].resolved_at string
queue[].updated_at string
Example response
json
{
    "my_open": 1,
    "all_open": 1,
    "unread": 1,
    "overdue": 1,
    "due_today": 1,
    "onsite_open": 1,
    "queue": [
        {
            "id": 1,
            "number": 1,
            "subject": "string",
            "priority": "string",
            "status": "string",
            "status_color": "string",
            "client": "string",
            "assigned_to": "string",
            "created_at": "string",
            "due_at": "string",
            "resolved_at": "string",
            "updated_at": "string"
        }
    ]
}

401Missing or invalid credentials

FieldTypeDescription
error string