> For the complete documentation index, see [llms.txt](https://docs.scaleconnect.com.au/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.scaleconnect.com.au/api/connections.md).

# Connections

{% @scale-docs-page-title/page-title title="Connections" %}

{% hint style="warning" %}
**Confirm before publishing:** which connection providers and scopes are supported per product, callback URLs, token storage and renewal, disconnect semantics, account ownership, webhook subscriptions and whether a public Connections API exists. Native connection settings exist in ScaleConnect, but public connection-management routes have not been verified.
{% endhint %}

A **connection** links a Scale account or workspace to an external provider. It is different from an API key: a connection grants Scale access to the provider; an API key grants an integration access to Scale.

## Connection lifecycle

1. Choose the provider and the workspace or account that will own the connection.
2. Start the provider's authorization flow.
3. Review the provider permissions requested and complete consent.
4. Return to ScaleConnect and confirm the connection status and account identity.
5. Use the relevant workflow, such as availability lookup or meeting creation.
6. Reconnect if authorization expires or the provider revokes access.
7. Disconnect to stop future provider calls and event processing.

The final API contract must document the create/status/disconnect operations, callback handling and errors without exposing provider refresh tokens.

## Provider surfaces

| Provider        | Intended use                            | Ownership consideration                                 |
| --------------- | --------------------------------------- | ------------------------------------------------------- |
| Google Calendar | Availability and meeting creation       | Calendar account and authorized workspace               |
| Outlook         | Calendar and client email connection    | Microsoft account and selected scopes                   |
| Zoom            | Meeting link creation                   | Separate provider consent                               |
| Microsoft Teams | Meeting links through the Outlook grant | No separate connection unless product behaviour changes |

A successful connection may still lack a feature-specific scope or a selected calendar. Connection status should distinguish `connected`, `needs_reauthorization`, `insufficient_scope` and `disconnected`.

## For integrators

A partner integrating with Scale uses [Authentication](/api/authentication.md) to obtain its **Scale** credential. It should not reuse or inspect a broker's Google, Microsoft or Zoom token. If a public Connections API is offered, it must expose metadata and permitted actions, not raw provider credentials. Connection events and provider inbound webhooks require their own documented scopes and delivery contract.


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://docs.scaleconnect.com.au/api/connections.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.