API Reference

Dashboard

Returns a summary of actionable items across your account, grouped by module. Uses the secret key or a personal access token for authentication.

Get Dashboard

GET /api/v1/dashboard Secret Key / PAT

Returns sections of actionable items for each enabled module. Sections are omitted when their module is disabled.

Sections

Key	Module	Description
conversations	Helpdesk	Open conversations, up to 20, most recent first
deals	CRM	Open deals, up to 20, ordered by close date
monitors	Monitor	Monitors with status "down" (omitted if all are up)
errors	Monitor	Unresolved errors, up to 20, most recent first
stories	Projects	Non-backlog stories, up to 20, ordered by status and position

Success Response (200)

{
  "sections": [
    {
      "key": "conversations",
      "name": "Conversations",
      "items": [
        {
          "name": "Billing question",
          "url": "https://squirrelstack.app/helpdesk/conversations/42",
          "updated_at": "2026-03-08T14:30:00Z",
          "priority": "high",
          "status": "Assigned"
        }
      ]
    },
    {
      "key": "deals",
      "name": "Deals",
      "items": [
        {
          "name": "Acme Corp CRM Upgrade",
          "url": "https://squirrelstack.app/crm/deals/7",
          "updated_at": "2026-03-07T10:00:00Z",
          "priority": null,
          "status": "Qualification"
        }
      ]
    }
  ]
}

Item Fields

Field	Type	Description
name	string	Display name of the item
url	string	Absolute URL to the item in the web app
updated_at	string	ISO 8601 datetime of last update
priority	string or null	One of "critical", "high", "medium", "low", or null. Items with critical or high priority are counted as urgent.
status	string	Free-text description of the item's current state (e.g. pipeline stage, ticket status). Displayed as a subtitle when priority is critical or high.