# List calendar connections

List your connected calendar accounts and their granted capabilities, calendars and connection status.

POST https://api.brigg.app/v1/operations/meetings.ListCalendarConnections

## Access & visibility

Allow `meetings.ListCalendarConnections` on your API key.

**Acting member required.** Send `Brigg-Act-As` with an [approved member account ID](https://developer.brigg.app/authentication#member-delegation). The key supplies permissions; the member selects whose data is used.

The selected member must be active and approved by the credential. This selects whose private data is used; the credential supplies permissions. Private ownership and project boundaries still apply.

[Set up authentication](https://developer.brigg.app/authentication) · [Choose permissions](https://developer.brigg.app/permissions)

## Request

No parameters. Send an empty JSON object (`{}`).

## Response

Returns **200 OK** with a JSON body.

This operation has no continuation cursor. An empty `items` array means no matching visible results were returned.
| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `items` | array of [Calendar connection](#calendar-connection-response-items) | Yes | Calendar connections available to the acting member, including their calendars and granted capabilities. This operation has no cursor pagination. |

### Calendar connection · response.items[]

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `calendars` | array of [object](#response-items-calendars) | Yes | Individual calendars discovered for this connection, with selection and edit capabilities. |
| `can_send_email` | boolean | Yes | Whether this connection has provider permission to send email. The Brigg operation grant is still required. Allowed: `false`, `true`. |
| `can_write_calendar` | boolean | Yes | Whether this connection has provider permission to write calendar events. Individual calendars can still be read-only. Allowed: `false`, `true`. |
| `can_read_mailbox` | boolean | Yes | Whether this connection has provider permission to read the mailbox. This does not grant the calling API key mailbox access. Allowed: `false`, `true`. |
| `id` | string | Yes | Connected calendar account ID. Calendar IDs inside calendars identify individual calendars. |
| `provider` | string | Yes | Calendar provider identifier, such as google or microsoft. |
| `email` | string | Yes | Email address of the connected provider account. |
| `display_name` | null or string | Yes | Provider account's display name, or null when the provider did not supply one. |
| `org_id` | string | Yes | Workspace associated with this connection. |
| `created_at` | number | Yes | Connection creation time in Unix milliseconds. |
| `disabled_at` | null or number | Yes | Time the connection was disabled, in Unix milliseconds; null while not disabled. |
| `disabled_reason` | null or string | Yes | Recorded reason for disabling the connection, or null when no reason was recorded. |
| `borrowed` | boolean | Yes | Whether this account used the legacy authorization client when it connected. This does not indicate delegation to another member. Allowed: `false`, `true`. |
| `scopes` | array of string | Yes | Provider OAuth permissions granted to this connection. These are distinct from Brigg API operation and resource grants. |

### response.items[].calendars[]

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `id` | string | Yes | Unique identifier. Use the value returned by a create or list operation. |
| `external_id` | string | Yes | Calendar identifier assigned by the external provider; use the separate Brigg id for Brigg calendar operations. |
| `summary` | string | Yes | Calendar's display name in the provider account. |
| `primary` | boolean | Yes | Whether the provider marks this as the account's primary calendar. Allowed: `false`, `true`. |
| `selected` | boolean | Yes | Whether this calendar is selected for synchronization in Brigg. Allowed: `false`, `true`. |
| `color` | null or string | Yes | Calendar display color supplied by the provider, or null when none is supplied. |
| `can_edit` | boolean | Yes | Whether the provider permits writes to this individual calendar. The connection's write permission and Brigg grants must also permit the operation. Allowed: `false`, `true`. |
| `disabled_at` | null or number | Yes | Time synchronization was disabled, in Unix milliseconds, or null when enabled. |
| `synced_through` | string | Yes | Synchronization mode: initial before an incremental cursor is stored, delta afterward. This is not the time of the most recent sync. |
| `watch_expires_at` | null or number | Yes | Expiry time of the provider's change-notification subscription in Unix milliseconds, or null when no expiry is recorded. |

## Errors & retries

This operation reads data. It needs no idempotency key and can be retried after a transient failure.

For rate limits, follow the server’s retry guidance and back off. See [HTTP errors](https://developer.brigg.app/http#errors) and [safe retries and limits](https://developer.brigg.app/reliability).

| HTTP status | Code | What to do |
| --- | --- | --- |
| 400 | `invalid_json` | Send a JSON object with Content-Type: application/json. |
| 400 | `invalid_input` | Check the request fields and types. |
| 401 | `invalid_key` | The workspace API key is missing, invalid or revoked. |
| 403 | `forbidden` | Check the key’s operation and resource grants. Supply Brigg-Act-As with a member authorized by the key’s delegation grant. The selected member must be active and approved by the credential. This selects whose private data is used; the credential supplies permissions. Private ownership and project boundaries still apply. |
| 404 | `not_found` | The requested operation or resource is not available to this credential. |
| 429 | `rate_limited` | Wait for Retry-After before retrying. |

## Next steps

[Download OpenAPI](https://developer.brigg.app/openapi.json) · [Versioning & retirement](https://developer.brigg.app/versioning)

## Examples

### Example request

Fictional values. Replace IDs and business details with values from your workspace.
#### cURL


```sh
curl 'https://api.brigg.app/v1/operations/meetings.ListCalendarConnections' \
  -H "Authorization: Bearer $BRIGG_API_KEY" \
  -H 'Content-Type: application/json' \
  -H "Brigg-Act-As: $BRIGG_ACT_AS" \
  --data-raw '{}'
```

#### TypeScript


```typescript
const actAs = process.env.BRIGG_ACT_AS;
if (!actAs) throw new Error("Set BRIGG_ACT_AS to an approved member account ID.");

const response = await fetch("https://api.brigg.app/v1/operations/meetings.ListCalendarConnections", {
  method: "POST",
  headers: {
    Authorization: `Bearer ${process.env.BRIGG_API_KEY}`,
    "Content-Type": "application/json",
    "Brigg-Act-As": actAs,
  },
  body: JSON.stringify({}),
});
const result = await response.json();
if (!response.ok) throw new Error(`${response.status}: ${result.error} — ${result.message}`);
console.log(result);
```

#### Python


```python
import json
import os
from urllib.request import Request, urlopen
from urllib.error import HTTPError

payload = {}
request = Request(
    "https://api.brigg.app/v1/operations/meetings.ListCalendarConnections",
    data=json.dumps(payload).encode("utf-8"),
    headers={
        "Authorization": f"Bearer {os.environ['BRIGG_API_KEY']}",
        "Content-Type": "application/json",
        "Brigg-Act-As": os.environ["BRIGG_ACT_AS"],
    },
    method="POST",
)
try:
    with urlopen(request) as response:
        print(json.load(response))
except HTTPError as error:
    print(error.code, json.load(error))
    raise
```

#### Response example


```json
{
  "items": [
    {
      "calendars": [
        {
          "id": "calendar_primary",
          "external_id": "alex@example.com",
          "summary": "Alex’s calendar",
          "primary": true,
          "selected": true,
          "color": null,
          "can_edit": true,
          "disabled_at": null,
          "synced_through": "delta",
          "watch_expires_at": null
        }
      ],
      "can_send_email": false,
      "can_write_calendar": true,
      "can_read_mailbox": false,
      "id": "calendar_account_alex",
      "provider": "google",
      "email": "alex@example.com",
      "display_name": "Alex Morgan",
      "org_id": "org_example",
      "created_at": 1794301200000,
      "disabled_at": null,
      "disabled_reason": null,
      "borrowed": false,
      "scopes": [
        "https://www.googleapis.com/auth/calendar.events"
      ]
    }
  ]
}
```

## JSON schemas


```json-schema-request
{
  "type": "object",
  "properties": {},
  "additionalProperties": false,
  "examples": [
    {}
  ]
}
```


```json-schema-response
{
  "type": "object",
  "properties": {
    "items": {
      "type": "array",
      "items": {
        "title": "Calendar connection",
        "type": "object",
        "properties": {
          "calendars": {
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "id": {
                  "type": "string",
                  "description": "Unique identifier. Use the value returned by a create or list operation."
                },
                "external_id": {
                  "type": "string",
                  "description": "Calendar identifier assigned by the external provider; use the separate Brigg id for Brigg calendar operations."
                },
                "summary": {
                  "type": "string",
                  "description": "Calendar's display name in the provider account."
                },
                "primary": {
                  "type": "boolean",
                  "enum": [
                    false,
                    true
                  ],
                  "description": "Whether the provider marks this as the account's primary calendar."
                },
                "selected": {
                  "type": "boolean",
                  "enum": [
                    false,
                    true
                  ],
                  "description": "Whether this calendar is selected for synchronization in Brigg."
                },
                "color": {
                  "anyOf": [
                    {
                      "type": "null"
                    },
                    {
                      "type": "string"
                    }
                  ],
                  "description": "Calendar display color supplied by the provider, or null when none is supplied."
                },
                "can_edit": {
                  "type": "boolean",
                  "enum": [
                    false,
                    true
                  ],
                  "description": "Whether the provider permits writes to this individual calendar. The connection's write permission and Brigg grants must also permit the operation."
                },
                "disabled_at": {
                  "anyOf": [
                    {
                      "type": "null"
                    },
                    {
                      "type": "number"
                    }
                  ],
                  "description": "Time synchronization was disabled, in Unix milliseconds, or null when enabled."
                },
                "synced_through": {
                  "type": "string",
                  "description": "Synchronization mode: initial before an incremental cursor is stored, delta afterward. This is not the time of the most recent sync."
                },
                "watch_expires_at": {
                  "anyOf": [
                    {
                      "type": "null"
                    },
                    {
                      "type": "number"
                    }
                  ],
                  "description": "Expiry time of the provider's change-notification subscription in Unix milliseconds, or null when no expiry is recorded."
                }
              },
              "required": [
                "id",
                "external_id",
                "summary",
                "primary",
                "selected",
                "color",
                "can_edit",
                "disabled_at",
                "synced_through",
                "watch_expires_at"
              ],
              "additionalProperties": false
            },
            "description": "Individual calendars discovered for this connection, with selection and edit capabilities.",
            "examples": [
              [
                {
                  "id": "calendar_primary",
                  "external_id": "alex@example.com",
                  "summary": "Alex’s calendar",
                  "primary": true,
                  "selected": true,
                  "color": null,
                  "can_edit": true,
                  "disabled_at": null,
                  "synced_through": "delta",
                  "watch_expires_at": null
                }
              ]
            ]
          },
          "can_send_email": {
            "type": "boolean",
            "enum": [
              false,
              true
            ],
            "description": "Whether this connection has provider permission to send email. The Brigg operation grant is still required.",
            "examples": [
              false
            ]
          },
          "can_write_calendar": {
            "type": "boolean",
            "enum": [
              false,
              true
            ],
            "description": "Whether this connection has provider permission to write calendar events. Individual calendars can still be read-only.",
            "examples": [
              true
            ]
          },
          "can_read_mailbox": {
            "type": "boolean",
            "enum": [
              false,
              true
            ],
            "description": "Whether this connection has provider permission to read the mailbox. This does not grant the calling API key mailbox access.",
            "examples": [
              false
            ]
          },
          "id": {
            "type": "string",
            "description": "Connected calendar account ID. Calendar IDs inside calendars identify individual calendars.",
            "examples": [
              "calendar_account_alex"
            ]
          },
          "provider": {
            "type": "string",
            "description": "Calendar provider identifier, such as google or microsoft.",
            "examples": [
              "google"
            ]
          },
          "email": {
            "type": "string",
            "description": "Email address of the connected provider account.",
            "examples": [
              "alex@example.com"
            ]
          },
          "display_name": {
            "anyOf": [
              {
                "type": "null"
              },
              {
                "type": "string"
              }
            ],
            "description": "Provider account's display name, or null when the provider did not supply one.",
            "examples": [
              "Alex Morgan"
            ]
          },
          "org_id": {
            "type": "string",
            "description": "Workspace associated with this connection.",
            "examples": [
              "org_example"
            ]
          },
          "created_at": {
            "type": "number",
            "description": "Connection creation time in Unix milliseconds.",
            "examples": [
              1794301200000
            ]
          },
          "disabled_at": {
            "anyOf": [
              {
                "type": "null"
              },
              {
                "type": "number"
              }
            ],
            "description": "Time the connection was disabled, in Unix milliseconds; null while not disabled.",
            "examples": [
              null
            ]
          },
          "disabled_reason": {
            "anyOf": [
              {
                "type": "null"
              },
              {
                "type": "string"
              }
            ],
            "description": "Recorded reason for disabling the connection, or null when no reason was recorded.",
            "examples": [
              null
            ]
          },
          "borrowed": {
            "type": "boolean",
            "enum": [
              false,
              true
            ],
            "description": "Whether this account used the legacy authorization client when it connected. This does not indicate delegation to another member.",
            "examples": [
              false
            ]
          },
          "scopes": {
            "type": "array",
            "items": {
              "type": "string"
            },
            "description": "Provider OAuth permissions granted to this connection. These are distinct from Brigg API operation and resource grants.",
            "examples": [
              [
                "https://www.googleapis.com/auth/calendar.events"
              ]
            ]
          }
        },
        "required": [
          "calendars",
          "can_send_email",
          "can_write_calendar",
          "can_read_mailbox",
          "id",
          "provider",
          "email",
          "display_name",
          "org_id",
          "created_at",
          "disabled_at",
          "disabled_reason",
          "borrowed",
          "scopes"
        ],
        "additionalProperties": false
      },
      "description": "Calendar connections available to the acting member, including their calendars and granted capabilities. This operation has no cursor pagination."
    }
  },
  "required": [
    "items"
  ],
  "additionalProperties": false,
  "examples": [
    {
      "items": [
        {
          "calendars": [
            {
              "id": "calendar_primary",
              "external_id": "alex@example.com",
              "summary": "Alex’s calendar",
              "primary": true,
              "selected": true,
              "color": null,
              "can_edit": true,
              "disabled_at": null,
              "synced_through": "delta",
              "watch_expires_at": null
            }
          ],
          "can_send_email": false,
          "can_write_calendar": true,
          "can_read_mailbox": false,
          "id": "calendar_account_alex",
          "provider": "google",
          "email": "alex@example.com",
          "display_name": "Alex Morgan",
          "org_id": "org_example",
          "created_at": 1794301200000,
          "disabled_at": null,
          "disabled_reason": null,
          "borrowed": false,
          "scopes": [
            "https://www.googleapis.com/auth/calendar.events"
          ]
        }
      ]
    }
  ]
}
```