StoreBay Developers
Integrations

List integration connections

GET
/integration-connections

Authorization

AuthorizationBearer <token>

Present an API key (sb_live_… / sb_test_…), an OAuth2 access token, or a static token as a Bearer credential. The operator is implied by the credential; it is never in the path. Only a SHA-256 hash of an API key is stored server-side.

In: header

Query Parameters

cursor?string

Opaque pagination cursor from meta.cursor.next of the previous page. Do not construct or parse it.

limit?integer

Page size. Values above the maximum are clamped.

Range1 <= value <= 100
Default25
provider?string

Filter by provider (e.g. stripe, xero, noke).

category?string

Filter by category.

Value in

  • "payments"
  • "comms"
  • "accounting"
  • "access"
  • "identity"
status?string

Filter by status.

Value in

  • "pending"
  • "active"
  • "error"
  • "disconnected"
  • "expired"

Response Body

application/json

application/json

application/json

application/json

application/json

curl -X GET "https://example.com/integration-connections"
{  "data": [    {      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",      "object": "integration_connection",      "provider": "string",      "category": "payments",      "status": "pending",      "scopes": "string",      "connected_at": "2019-08-24T14:15:22Z",      "last_error": "string",      "created_at": "2019-08-24T14:15:22Z",      "updated_at": "2019-08-24T14:15:22Z"    }  ],  "meta": {    "limit": 0,    "cursor": {      "next": "string",      "has_more": true    }  }}
{  "error": {    "code": "unauthorized",    "message": "Missing or invalid credential."  }}
{  "error": {    "code": "insufficient_scope",    "message": "The credential lacks a scope required by this endpoint."  }}
{  "error": {    "code": "rate_limited",    "message": "Rate limit exceeded. Retry after 7s."  }}
{  "error": {    "code": "validation_error",    "message": "string",    "details": [      {        "field": "string",        "issue": "string"      }    ]  }}