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 roleKey and roleKeys.
GET
/api/v1/workspacesAuthorization
apiKey X-API-Key<token>
Your SteelEngine API key (personal, workspace, or organization). Create personal and workspace keys under Settings > API Keys. Create organization keys under Organization 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.
Range
1 <= value <= 250Default
50offset?integerDeprecated
Number of records to skip. Deprecated: use cursor. When both are sent, cursor wins.
Range
0 <= valueDefault
0cursor?string
Pagination cursor returned in a previous response's nextCursor field.
Response Body
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, "createdAt": "2026-01-15T10:30:00Z", "updatedAt": "2026-01-15T10:30:00Z", "archivedAt": null, "roleKey": "workspace:admin", "roleKeys": [ "workspace:admin" ] } ], "totalCount": 1, "limit": 50, "offset": 0 }}