List API keys — Brigg developers

Access & visibility

Allow integrations.ListApiKeys 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 ({}).

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 key summaryRequired

Active workspace API keys. Secret keys are represented only by a preview, never their full value. This operation has no cursor pagination.

Item fields

idstringRequired

Identifier of the workspace API key. Pass it to Revoke API key.

kindstringRequired

Key category. A secret key authenticates server requests; a publishable key is for the browser conversion-tracking API.

previewstringRequired

Abbreviated key value for recognizing the key in settings; it cannot authenticate a request.

labelstring or nullRequired

Name assigned when the key was created. Null means no label was supplied.

created_atnumberRequired

Creation time in Unix milliseconds.

last_used_atnumber or nullRequired

Time the key was last used, in Unix milliseconds. Null means no use has been 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 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": {
          "id": {
            "type": "string",
            "description": "Identifier of the workspace API key. Pass it to [Revoke API key](/reference/integrations/RevokeApiKey).",
            "examples": [
              "key_warehouse"
            ]
          },
          "kind": {
            "type": "string",
            "description": "Key category. A secret key authenticates server requests; a publishable key is for the browser conversion-tracking API.",
            "examples": [
              "secret"
            ]
          },
          "preview": {
            "type": "string",
            "description": "Abbreviated key value for recognizing the key in settings; it cannot authenticate a request.",
            "examples": [
              "brigg_sk_…a1b2"
            ]
          },
          "label": {
            "type": [
              "string",
              "null"
            ],
            "description": "Name assigned when the key was created. Null means no label was supplied.",
            "examples": [
              "Warehouse sync"
            ]
          },
          "created_at": {
            "type": "number",
            "description": "Creation time in Unix milliseconds."
          },
          "last_used_at": {
            "type": [
              "number",
              "null"
            ],
            "description": "Time the key was last used, in Unix milliseconds. Null means no use has been recorded.",
            "examples": [
              null
            ]
          }
        },
        "required": [
          "id",
          "kind",
          "preview",
          "label",
          "created_at",
          "last_used_at"
        ],
        "additionalProperties": false,
        "title": "API key summary"
      },
      "description": "Active workspace API keys. Secret keys are represented only by a preview, never their full value. This operation has no cursor pagination."
    }
  },
  "required": [
    "items"
  ],
  "additionalProperties": false,
  "examples": [
    {
      "items": [
        {
          "id": "key_warehouse",
          "kind": "secret",
          "preview": "brigg_sk_…a1b2",
          "label": "Warehouse sync",
          "created_at": 1794301200000,
          "last_used_at": null
        }
      ]
    }
  ]
}

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.ListApiKeys' \
  -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.ListApiKeys", {
  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.ListApiKeys",
    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.ListApiKeys' \
  -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.ListApiKeys", {
  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.ListApiKeys",
    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": [
    {
      "id": "key_warehouse",
      "kind": "secret",
      "preview": "brigg_sk_…a1b2",
      "label": "Warehouse sync",
      "created_at": 1794301200000,
      "last_used_at": null
    }
  ]
}

Illustrative values, not a live response.