Dashboard

The dashboard is the agenda shown on Carom’s home screen: the open tasks visible to your key that are overdue or due by the end of this week, grouped into overdue, today, tomorrow, and later. It is a read-only view over tasks; change a task through the Tasks endpoints.

Days are counted in the time zone of your key’s user, so “today” is that person’s today. Weeks run Monday through Sunday.

get/dashboard Read key

#Retrieve the dashboard

Returns every incomplete task visible to your key, not only tasks assigned to your key’s user, that is due on or before Sunday of the current week. The tasks are sorted into four groups by due date. Tasks without a due date are not included.

Returns

dashboardobject
Show 1 child attributeHide child attributes
- agendaobject
  
  Four groups, each an object with a tasks array of task objects.
  Show 4 child attributesHide child attributes
  - overdueobject
    Due before today.
  - todayobject
    Due today.
  - tomorrowobject
    Due tomorrow. Empty on Sundays, because tomorrow is in the next week.
  - laterobject
    Due after tomorrow and by Sunday. Empty on Saturdays and Sundays.

get/dashboard

curl https://api.carom.io/dashboard \
  -H "Authorization: Bearer $CAROM_API_KEY"

Response200

{
  "dashboard": {
    "agenda": {
      "overdue": {
        "tasks": [
          {
            "id": "e7f8a9b0-c1d2-4e3f-8a4b-5c6d7e8f9a01",
            "assignment": "Send the Q4 renewal proposal",
            "description": null,
            "due": "2026-09-12",
            "completed_at": null,
            "contact_id": "1f3c9a52-7b0e-4d4a-9c1e-2a6f0d8b3e41",
            "deal_id": "8f2b6d4a-1c9e-4a7b-b3d5-0e6f8a2c4d17",
            …
          }
        ]
      },
      "today": {
        "tasks": [
          {
            "id": "1a3c5e7a-9c1e-4a3c-8e5a-7c9e1a3c5e28",
            "assignment": "Confirm walkthrough times with Marcus",
            "description": "He offered Tuesday or Thursday morning.",
            "due": "2026-09-18",
            "completed_at": null,
            "contact_id": "b7e1d4c9-2a6f-4e8b-9c3d-5f0a7b2e1d84",
            "deal_id": null,
            …
          }
        ]
      },
      "tomorrow": {
        "tasks": []
      },
      "later": {
        "tasks": []
      }
    }
  }
}