The household's calendars

calendar.calendar.list

GET/api/v1/households/{household_id}/queries/calendar.calendar.list

Query
Rigel runs it

Every calendar in the order shown, with its color, owner, whether it's the default, visible or busy-only, how many events it has (a repeating event counts once), and, if it's linked to a Google calendar, the link in words.

Parameters#

The household's calendars: parameters
Field	Description
`household_id`pathstringrequired	The household's ID.

Response#

200 The answer.

The household's calendars: response fields
Field	Description
`items`array of objectsrequired
`items[].id`stringrequired	A calendar ID, such as cal_01JC0000000000000000000000.
`items[].name`stringrequired	No description.
`items[].color`one of: calendar-1, calendar-2, calendar-3, calendar-4, calendar-5, calendar-6, calendar-7, calendar-8required	No description.
`items[].owner`object or nullrequired	Whose calendar it is, or null for a shared one.
`items[].owner.id`stringrequired	A person ID, such as per_01JC0000000000000000000000.
`items[].owner.name`stringrequired	No description.
`items[].is_default`booleanrequired	No description.
`items[].is_visible`booleanrequired	No description.
`items[].is_busy_only`booleanrequired	No description.
`items[].event_count`integerrequired	Events on it, counting a repeating event once.
`items[].google`object or nullrequired	The Google calendar it's linked to, or null.
`items[].google.direction`one of: both, import, exportrequired	No description.
`items[].google.summary`stringrequired	In words, such as "Synced both ways with Work on ben@example.com".
`items[].google.google_calendar`string or nullrequired	Google's name for the calendar.
`items[].google.account`string or nullrequired	The Google account's address.
`items[].google.problem`string or nullrequired	What's wrong with syncing it, in words, or null.

Errors#

Every error has the same envelope: error.code, error.message, error.details, error.recovery and error.request_id.

The household's calendars: errors
Status	Code	When
`400`	`validation_failed`	A field is missing, misspelled or out of range. details.fields lists each problem.
`401`	`unauthenticated`	The request has no valid session.
`404`	`not_found`	The household doesn't exist, or you aren't a member of it.

Examples#

These are real. Each was recorded from a sample household, the Okafors, running through the whole API when this site was built.

List the calendars

Request, curl

curl 'https://rigel.house/api/v1/households/hh_01M6V9CS6GGVFCY7NAS8ZTQV95/queries/calendar.calendar.list' \
  -H "Cookie: rigel_session=$RIGEL_SESSION"

Request, TypeScript

const response = await fetch("https://rigel.house/api/v1/households/hh_01M6V9CS6GGVFCY7NAS8ZTQV95/queries/calendar.calendar.list", {
  headers: {
    Cookie: `rigel_session=${process.env.RIGEL_SESSION}`,
  },
});
const data = await response.json();

Request, HTTP

GET /api/v1/households/hh_01M6V9CS6GGVFCY7NAS8ZTQV95/queries/calendar.calendar.list HTTP/1.1
Host: rigel.house
Cookie: rigel_session=<your session>

Response, 200

HTTP/1.1 200 OK
Content-Type: application/json
X-Request-Id: req_01M6V9CSHGZWN1RRZ16W5ZWYMF

{
  "items": [
    {
      "id": "cal_01M6V9CS6RESEHY2KVBGF3JX5Q",
      "name": "Family",
      "color": "calendar-1",
      "owner": null,
      "is_default": true,
      "is_visible": true,
      "is_busy_only": false,
      "event_count": 0,
      "google": null
    },
    {
      "id": "cal_01M6V9CS6R7BJ7D0KVCQQH1DCS",
      "name": "Ada Okafor",
      "color": "calendar-2",
      "owner": {
        "id": "per_01M6V9CS6RX26JK5KVYGRN22D2",
        "name": "Ada Okafor"
      },
      "is_default": false,
      "is_visible": true,
      "is_busy_only": false,
      "event_count": 0,
      "google": null
    }
  ]
}

For Rigel#

Rigel's tool for this query is calendar_calendar_list. Rigel runs this on its own, then says what it did. The agent guide has the rest.