# Bridges

> A bridge links your organization with another organization. The requests on this page list your bridges and the people you can chat with over each one. To start a chat over a bridge, see Chats with another organization.

Canonical HTML page: https://conclude.io/doc/api/bridges/
Last updated: 2026-11-12

---

**The API is in beta.** API keys are available to organizations in the beta program. Requests and responses may still change, and we tell beta customers before they do. [Contact us](https://conclude.io/contact/) to get access.

A bridge links your organization with another organization. The requests on this page list your bridges and the people you can chat with over each one. To start a chat over a bridge, see [Chats with another organization](https://conclude.io/doc/api/chats/#bridge-chats).

## Who can use bridges

Both requests need the scope `chats:read`. A key that acts as Conclude, without a [subject](https://conclude.io/doc/api/authentication/#acts-as), reads every bridge of your organization and its chat users.

## The bridge object

```json
{
  "id": "B-1a3c5e7g",
  "status": "active",
  "partner": {
    "id": "O-3c5e7g9i",
    "name": "Partner Corp"
  },
  "canChat": true
}
```

| Field | Type | Description |
|---|---|---|
| `id` | string | The bridge's ID. The paths below take it as `{bridge}`. |
| `status` | string | `active`, or `disabled` while an admin has paused the bridge. |
| `partner` | object | The organization on the other side, with its `id` and `name`. |
| `canChat` | boolean | `true` when the person the token acts for has **Chat access** on the bridge. Always `false` for a token without a subject. |

## List bridges

`GET /v1/bridges` · scope `chats:read`

Returns your organization's active and paused bridges, as an array of [bridge objects](#bridge-object). Invitations that no one has accepted yet are left out. The list is not paged.

```sh
curl https://api.conclude.io/v1/bridges -H "Authorization: Bearer $ACCESS_TOKEN"
```

## List chat users

`GET /v1/bridges/{bridge}/chatUsers` · scope `chats:read`

Returns the people with **Chat access** on the bridge, from both organizations. The response is an array of [user objects](https://conclude.io/doc/api/chats/#user-object), sorted by name. `orgID` tells you which organization each person belongs to. Name them, with the bridge's ID, to [start a chat](https://conclude.io/doc/api/chats/#bridge-chats) with them.

```sh
curl https://api.conclude.io/v1/bridges/B-1a3c5e7g/chatUsers -H "Authorization: Bearer $ACCESS_TOKEN"
```

```json
[
  {
    "id": "U-2b4d6f8h",
    "mention": "Ana",
    "name": "Ana Silva",
    "email": "ana@example.com",
    "orgID": "O-2a4c6e8g"
  },
  {
    "id": "U-5e7g9i1k",
    "mention": "Pat",
    "name": "Pat Partner",
    "email": "pat@partner.example",
    "orgID": "O-3c5e7g9i"
  }
]
```

The person the token acts for must be an admin of the bridge or have a role on it. Admins of your organization, and people with the **Manage bridges** permission, administer every bridge.

| Status | Code | When |
|---|---|---|
| 404 | `not_found` | The bridge doesn't exist or doesn't involve your organization. Or the person the token acts for has no role on it. |