Skip to content

List Stripe Connections

GET/web/v1/workspaces/{workspaceId}/stripe/connectionsJWT

Returns a paginated list of all Stripe connections belonging to the current tenant in the specified workspace.

Authentication

Auth Chain: WEB Chain — requires Authorization: Bearer <jwt> Requires workspace:manage permission. These headers are injected by the system (frontend does nothing): X-PORTAL-ACCESS-CODE (Nginx), X-Request-Id (Gateway)

Request Parameters

NameTypeRequiredInDescription
workspaceIdstringYespathWorkspace business ID
pageintegerNoqueryPage number (zero-based). Default: `0`
sizeintegerNoqueryPage size. Default: `20`

Success Response

Success200
{
  "version": "1.3.0",
  "timestamp": 1709337600000,
  "success": true,
  "code": "2000",
  "message": "SUCCESS",
  "data": {
    "content": [
      {
        "bizId": "sc_abc123",
        "tenantBizId": "tn_xyz789",
        "connectionName": "Production Stripe",
        "connectionDescription": "Main production connection",
        "stripeAccountId": "acct_1234567890",
        "partnerEndpoint": "https://partner.example.com/webhook",
        "configJson": null,
        "status": 1,
        "statusName": "ACTIVE",
        "createdAt": "2026-03-21T00:00:00Z",
        "updatedAt": "2026-03-21T00:00:00Z"
      }
    ],
    "totalElements": 1,
    "totalPages": 1,
    "size": 20,
    "number": 0
  }
}

Error Responses

Unauthorized401
{
  "success": false,
  "code": "4010",
  "message": "Invalid or expired token"
}

Notes

  • Results are scoped to the current tenant; cross-tenant connections are never returned.
  • Requires the workspace:manage permission on the target workspace.

Internal Documentation