List Workspaces

List workspaces the API key holder has access to. Supports pagination and scope filtering (active/archived/all). Returns each workspace with the caller's role.

GET/api/v1/workspaces

Authorization

apiKey
X-API-Key<token>

Your SteelEngine API key (personal or workspace). Generate one from the SteelEngine dashboard under Settings > API Keys.

In: header

Query Parameters

scope?string

Filter by archived state.

Default"active"

Value in

  • "active"
  • "archived"
  • "all"
limit?integer

Page size. Capped at 250.

Range1 <= value <= 250
Default50
offset?integer

Number of records to skip.

Range0 <= value
Default0

Response Body

application/json

application/json

application/json

application/json

curl -X GET "https://example.com/api/v1/workspaces"
{  "success": true,  "data": {    "workspaces": [      {        "id": "wsp_abc123",        "name": "Engineering",        "slug": "engin3r2",        "color": "#3972F6",        "ownerId": "usr_x",        "organizationId": "org_y",        "billedAccountUserId": "usr_x",        "allowPersonalApiKeys": true,        "role": "admin",        "createdAt": "2026-01-15T10:30:00Z",        "updatedAt": "2026-01-15T10:30:00Z",        "archivedAt": null      }    ],    "totalCount": 1,    "limit": 50,    "offset": 0  }}