---
title: "List calendar connections"
method: GET
path: "/calendar_connections"
tags: ["Calendar connections"]
---

# List calendar connections

`GET /calendar_connections`

## Request

- Base URL: `https://www.happyscribe.com/api/v1`
- URL: `https://www.happyscribe.com/api/v1/calendar_connections`
- Auth: API key in header `Authorization`

A workspace's calendar connections, oldest first, including disconnected ones.

## Query parameters

- `workspace_id` string, required
- `member_id` string
- `limit` integer
- `cursor` string

## Response `200`

One page of calendar connections.

- CalendarConnectionList
  - `object` string: Always `list`.
  - `data` CalendarConnection[]: The calendar connections on this page.
    - `id` string: Stable typed ID beginning with `cal_`. Treat it as an opaque string.
    - `object` string: Always `calendar_connection`.
    - `workspace_id` string: Workspace ID, beginning with `wks_`. Treat it as an opaque string.
    - `member_id` string: The member whose calendar this is.
    - `provider` 'google' | 'microsoft': The connected calendar. - `google`: Google Calendar. - `microsoft`: Microsoft Outlook calendar.
    - `status` 'active' | 'error' | 'disconnected': - `active`: syncing. - `error`: the account stopped granting access; send the member a new connect link. - `disconnected`: disconnected by you or in HappyScribe, or the member was removed.
    - `account_email` string, nullable: The email of the connected Google or Microsoft account.
    - `error` object, nullable: Why the connection stopped working, while `status` is `error`; otherwise `null`.
      - `code` string: A stable code, such as `access_revoked`.
      - `message` string: What happened, and what to do.
    - `connected_at` string, date-time, nullable: When the member last finished consent, in ISO 8601.
    - `last_synced_at` string, date-time, nullable: When the calendar last synced, in ISO 8601.
    - `created_at` string, date-time: When the connection was first made, in ISO 8601.
  - `has_more` boolean: Whether more results follow this page.
  - `_links` object: Pagination links.
    - `next` object: The next page. Absent on the last page.
      - `url` string: The next page, with the same filters.

## Other responses

- `400`: Missing `workspace_id`, or a `limit` or `cursor` that cannot be read.
- `401`: Missing or invalid API key, or the key is not an owner or admin of the workspace.
- `404`: The workspace or the member is not one the key can see.

---

[API](https://skmtc.dev/happyscribe/apis/happyscribe-api.md) - [All operations](https://skmtc.dev/happyscribe/apis/happyscribe-api/llms.txt) - [OpenAPI document](https://skmtc.dev/happyscribe/apis/happyscribe-api/revisions/1281bd968c3d?raw)