List integrations

Lists the third-party apps and integration connections available to the workspace: browse the catalogue of supported apps, see connections grouped by app with active and inactive counts, or list individual connections.

Example: “What integrations are available to connect?”

Usage: pick what you want with view: apps for the full catalogue of supported apps, apps_overview for connections grouped by app with active and inactive counts, connections for the individual connections, and connection_detail for one connection (needs its id). Narrow the lists with free-text search, and connections also by app, status, or whether they have project access; pass a project id to scope either list to one project. The lists come back in pages of up to 100 (50 by default). Credentials are never returned.

Response: the data for the chosen view: the app catalogue, the per-app overview with counts, the list of connections, or one connection’s details.

POST /api/v1/business/integrations/query

List integrations

cURL

curl --request POST \
  --url https://api.example.com/api/v1/business/integrations/query \
  --header 'Content-Type: application/json' \
  --data '
{
  "connection_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "project_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "q": "<string>",
  "app": "<string>",
  "page": 1,
  "page_size": 50
}
'

422

{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>",
      "input": "<unknown>",
      "ctx": {}
    }
  ]
}

Headers

X-Workspace-Id · string<uuid> | null

Overrides the key's workspace

X-API-Key · string | null

User API key

Body

application/json

view · enum<string> · required

Which integrations view to return

Available options: apps, apps_overview, connections, connection_detail

connection_id · string<uuid> | null

Connection to act on: the id field of a connection read, not its connection_id field. Required for connection_detail.

project_id · string<uuid> | null

Filter connections and apps_overview to connections usable from this project

q · string | null

Free-text filter for apps_overview and connections

app · string | null

Filter connections by integration slug

status · enum<string> | null

Filter connections by the derived display status (e.g. active, inactive, expired). status=no_project_access only matches when that's the highest-precedence status - a connection that also has no project access but is expired/setup_pending shows as that status instead, not no_project_access. For 'which connections lack project access' (independent of other statuses), use access instead.

Available options: setup_pending, active, inactive, no_project_access, expired

access · enum<string> | null

Filter connections by project access (has_access or no_access) - a direct, complete check independent of other status precedence. Prefer this over status=no_project_access when the question is purely about project accessibility.

Available options: has_access, no_access

page · integer · default: 1

1-based page number

Required range: x >= 1

page_size · integer · default: 50

Items per page

Required range: 1 <= x <= 100

Response

200

application/json

Successful Response