List Connections

curl https://ah-api.merge.dev/api/v1/connections/ \
     -H "Authorization: Bearer <token>"

{
  "count": 123,
  "results": [
    {
      "id": "string",
      "connector": {
        "slug": "string",
        "name": "string"
      },
      "organization_id": "string",
      "auth_option_name": "string",
      "auth_type": "string",
      "auth_scope": "string",
      "owner": {
        "type": "string",
        "id": "string",
        "group": {
          "key": "string",
          "value": "string"
        }
      },
      "excluded_registered_users": [
        "string"
      ],
      "created_at": "2024-01-15T09:30:00Z",
      "modified_at": "2024-01-15T09:30:00Z"
    }
  ],
  "next": "https://ah-api.merge.dev?page=4",
  "previous": "https://ah-api.merge.dev?page=2"
}

Lists authenticated connections across all auth scopes.

Authentication

AuthorizationBearer

Token-based authentication with required prefix “Bearer”

Query parameters

auth_scopestringOptional

Filter by auth scope: INDIVIDUAL (one registered user), SHARED (one company), or ORGANIZATION (the whole organization). Accepts a comma-separated list to match more than one.

companystringOptional

Filter shared connections by company origin ID.

connectorstringOptional

Filter by connector slug.

pageintegerOptional

A page number within the paginated result set.

page_sizeintegerOptional

Number of results to return per page.

Response

countinteger

resultslist of objects

nextstring or nullformat: "uri"

previousstring or nullformat: "uri"