Workspaces

The Workspaces API allows you to retrieve the workspaces your API key has access to. A workspace is an isolated environment within BillPipe, typically representing a single organization or brand.

List Workspaces

Retrieve a list of all workspaces associated with the authenticated account.

Request

GET /v1/workspaces

Response

Returns a JSON array of workspace objects.

[
  {
    "id": "ws_1234567890",
    "name": "Acme Corp",
    "created_at": "2024-01-01T00:00:00Z"
  }
]

Get a Workspace

Retrieve details for a specific workspace.

Request

GET /v1/workspaces/{workspace_id}

Response

Returns a JSON workspace object.

{
  "id": "ws_1234567890",
  "name": "Acme Corp",
  "created_at": "2024-01-01T00:00:00Z"
}