# List integrations

List connected business systems and their current connection and synchronization state. Follow review_url in Brigg to finish setup, reconnect or inspect failures. Provider configuration, credentials and execution payloads stay private.

POST https://api.brigg.app/v1/operations/integrations.ListIntegrations

## Access & visibility

Allow `integrations.ListIntegrations` on your API key.

**Workspace access by default.** Private member data requires [approved member delegation](https://developer.brigg.app/authentication#member-delegation) through `Brigg-Act-As`; the key supplies permissions while private ownership and project boundaries remain enforced.

[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 [External integration](#external-integration-response-items) | Yes | Configured workspace integrations with their current setup and synchronization state. This operation has no cursor pagination. |

### External integration · response.items[]

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `connection_id` | string | Yes | Identifier of this configured integration. It is distinct from an API connection ID or MCP server ID. |
| `name` | string | Yes | Display name of the configured integration. |
| `state` | string | Yes | Setup state: preview is being configured; live is active; paused suspends synchronization; disconnected has no active provider connection. Allowed: `"preview"`, `"live"`, `"paused"`, `"disconnected"`. |
| `syncing` | boolean | Yes | Whether a synchronization is currently running. False does not imply a failure. |
| `connected_at` | number or null | Yes | Time the integration was configured, in Unix milliseconds. Null means configuration has not completed. |
| `review_url` | string | Yes | Brigg settings URL where an administrator reviews and configures the integration. Format: uri. |
| `requires_attention` | boolean | Yes | Whether the integration needs a company selection or has a recorded error. Open review_url to inspect and resolve it. |

## 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. If Brigg-Act-As is supplied, the key must be authorized to delegate to that member. |
| 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/integrations.ListIntegrations' \
  -H "Authorization: Bearer $BRIGG_API_KEY" \
  -H 'Content-Type: application/json' \
  --data-raw '{}'
```

#### TypeScript


```typescript
const response = await fetch("https://api.brigg.app/v1/operations/integrations.ListIntegrations", {
  method: "POST",
  headers: {
    Authorization: `Bearer ${process.env.BRIGG_API_KEY}`,
    "Content-Type": "application/json",
  },
  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/integrations.ListIntegrations",
    data=json.dumps(payload).encode("utf-8"),
    headers={
        "Authorization": f"Bearer {os.environ['BRIGG_API_KEY']}",
        "Content-Type": "application/json",
    },
    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": [
    {
      "connection_id": "accounting",
      "name": "Accounting integration",
      "state": "live",
      "syncing": false,
      "connected_at": 1794301200000,
      "review_url": "https://brigg.app/settings/integrations",
      "requires_attention": false
    }
  ]
}
```

## JSON schemas


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


```json-schema-response
{
  "type": "object",
  "properties": {
    "items": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "connection_id": {
            "type": "string",
            "description": "Identifier of this configured integration. It is distinct from an API connection ID or MCP server ID."
          },
          "name": {
            "type": "string",
            "description": "Display name of the configured integration."
          },
          "state": {
            "type": "string",
            "enum": [
              "preview",
              "live",
              "paused",
              "disconnected"
            ],
            "description": "Setup state: preview is being configured; live is active; paused suspends synchronization; disconnected has no active provider connection."
          },
          "syncing": {
            "type": "boolean",
            "description": "Whether a synchronization is currently running. False does not imply a failure."
          },
          "connected_at": {
            "type": [
              "number",
              "null"
            ],
            "description": "Time the integration was configured, in Unix milliseconds. Null means configuration has not completed."
          },
          "review_url": {
            "type": "string",
            "format": "uri",
            "description": "Brigg settings URL where an administrator reviews and configures the integration."
          },
          "requires_attention": {
            "type": "boolean",
            "description": "Whether the integration needs a company selection or has a recorded error. Open review_url to inspect and resolve it."
          }
        },
        "required": [
          "connection_id",
          "name",
          "state",
          "syncing",
          "connected_at",
          "review_url",
          "requires_attention"
        ],
        "additionalProperties": false,
        "title": "External integration"
      },
      "description": "Configured workspace integrations with their current setup and synchronization state. This operation has no cursor pagination."
    }
  },
  "required": [
    "items"
  ],
  "additionalProperties": false,
  "examples": [
    {
      "items": [
        {
          "connection_id": "accounting",
          "name": "Accounting integration",
          "state": "live",
          "syncing": false,
          "connected_at": 1794301200000,
          "review_url": "https://brigg.app/settings/integrations",
          "requires_attention": false
        }
      ]
    }
  ]
}
```