List API connections — Brigg developers

Access & visibility

Allow integrations.ListApiConnections on your API key.

Workspace access by default. Private member data requires approved member delegation through Brigg-Act-As; the key supplies permissions while private ownership and project boundaries remain enforced.

Set up authentication · Choose permissions

Request

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

What this list tells you

These are outbound connections: Brigg calls another service through them. They are separate from the workspace API key authenticating this request. An enabled connection is configured for use; it is not a live health check. Create or reconnect connections in Brigg Settings. Secrets are never included.

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.

itemsarray of API connectionRequired

All outbound API connections configured for this workspace, including disabled connections, ordered by display name. This operation has no cursor pagination.

Item fields

connection_idstringRequired

Stable identifier of this outbound connection. Pass it to Delete API connection to remove the connection.

namestringRequired

Display name assigned to the connection in Brigg.

providerstring or nullRequired

Catalog provider identifier, such as fiken. Null identifies a custom API connection rather than a catalog provider.

enabledbooleanRequired

Whether Brigg may use this connection for outbound requests. This setting does not confirm that its credentials are valid or that the provider is reachable.

accessstringRequired

Outbound HTTP access allowed through this connection: read_only permits GET and HEAD; full permits supported write methods as well. The provider's own credential permissions still apply. This does not describe the calling Brigg API key's permissions.

Allowed: "read_only", "full".

created_atnumberRequired

Creation time in Unix milliseconds.

updated_atnumberRequired

Last update time in Unix milliseconds.

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 and safe retries and limits.

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 · Versioning & retirement

JSON schemas

Use the complete schemas for validation or client generation.

Full request JSON schema

{
  "type": "object",
  "properties": {},
  "additionalProperties": false,
  "examples": [
    {}
  ]
}

Full response JSON schema

{
  "type": "object",
  "properties": {
    "items": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "connection_id": {
            "type": "string",
            "description": "Stable identifier of this outbound connection. Pass it to [Delete API connection](/developers/reference/integrations/DeleteApiConnection) to remove the connection."
          },
          "name": {
            "type": "string",
            "description": "Display name assigned to the connection in Brigg."
          },
          "provider": {
            "type": [
              "string",
              "null"
            ],
            "description": "Catalog provider identifier, such as fiken. Null identifies a custom API connection rather than a catalog provider."
          },
          "enabled": {
            "type": "boolean",
            "description": "Whether Brigg may use this connection for outbound requests. This setting does not confirm that its credentials are valid or that the provider is reachable."
          },
          "access": {
            "type": "string",
            "enum": [
              "read_only",
              "full"
            ],
            "description": "Outbound HTTP access allowed through this connection: read_only permits GET and HEAD; full permits supported write methods as well. The provider's own credential permissions still apply. This does not describe the calling Brigg API key's permissions."
          },
          "created_at": {
            "type": "number",
            "description": "Creation time in Unix milliseconds."
          },
          "updated_at": {
            "type": "number",
            "description": "Last update time in Unix milliseconds."
          }
        },
        "required": [
          "connection_id",
          "name",
          "provider",
          "enabled",
          "access",
          "created_at",
          "updated_at"
        ],
        "additionalProperties": false,
        "title": "API connection"
      },
      "description": "All outbound API connections configured for this workspace, including disabled connections, ordered by display name. This operation has no cursor pagination."
    }
  },
  "required": [
    "items"
  ],
  "additionalProperties": false,
  "examples": [
    {
      "items": [
        {
          "connection_id": "fiken",
          "name": "Fiken accounting",
          "provider": "fiken",
          "enabled": true,
          "access": "read_only",
          "created_at": 1794301200000,
          "updated_at": 1794301200000
        },
        {
          "connection_id": "warehouse",
          "name": "Warehouse API",
          "provider": null,
          "enabled": false,
          "access": "full",
          "created_at": 1794301200000,
          "updated_at": 1794301200000
        }
      ]
    }
  ]
}

Try the request

Use your API key in a server environment.

Act as a memberRequires administrator-approved delegation.

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

Request

cURL

curl 'https://api.brigg.app/v1/operations/integrations.ListApiConnections' \
  -H "Authorization: Bearer $BRIGG_API_KEY" \
  -H 'Content-Type: application/json' \
  --data-raw '{}'

TypeScript

const response = await fetch("https://api.brigg.app/v1/operations/integrations.ListApiConnections", {
  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

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.ListApiConnections",
    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

cURL

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

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/integrations.ListApiConnections", {
  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

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.ListApiConnections",
    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

200 OK Response example

{
  "items": [
    {
      "connection_id": "fiken",
      "name": "Fiken accounting",
      "provider": "fiken",
      "enabled": true,
      "access": "read_only",
      "created_at": 1794301200000,
      "updated_at": 1794301200000
    },
    {
      "connection_id": "warehouse",
      "name": "Warehouse API",
      "provider": null,
      "enabled": false,
      "access": "full",
      "created_at": 1794301200000,
      "updated_at": 1794301200000
    }
  ]
}

Illustrative values, not a live response.