Get companies

GET/companies

Query Parameters

limit?integer

Page size for modern client credentials (default 100, maximum 100); ignored for OAuth and upstream users.

Range1 <= value <= 100

cursor?string

Pagination cursor for modern client credentials; ignored for OAuth and upstream users.

Length1 <= length

include?"integration_health"

Adds integrationHealth to each company. Requires puzzle-client-id, Authorization: Bearer , read:company, an active firm authorization and a nonremoved firm-client link. Ignored for OAuth and upstream users.

Value in

"integration_health"

Response Body

`application/json`

curl -X GET "https://example.com/companies"

{  "companies": [    {      "id": "string",      "name": "string",      "connectedAt": "string",      "status": "Ready",      "financialYearStartDate": "string",      "reportingCurrency": "str",      "integrationHealth": {        "overallStatus": "HEALTHY",        "counts": {          "healthy": 0,          "degraded": 0,          "disconnected": 0        },        "integrations": [          {            "category": "BANKING",            "provider": "ARLO",            "displayName": "string",            "status": "OK",            "actionRequired": true,            "lastSyncAttemptAt": "string",            "lastSyncStatus": "SUCCEEDED",            "errorCode": "LOGIN_REQUIRED"          }        ]      }    }  ],  "nextCursor": "string"}

Query ParametersCopy Anchor Link

Response BodyCopy Anchor Link

200application/json

Query Parameters

Response Body

`application/json`