List workspaces - Scrums.com Docs

List all workspaces

curl --request GET \
  --url https://api.scrums.com/v1/workspaces \
  --header 'Authorization: Bearer <token>'

{
  "data": [
    {
      "id": "WS-26-000021",
      "organization_id": "ORG-26-090500",
      "name": "Platform Engineering",
      "slug": "platform-engineering",
      "status": "active",
      "member_count": 12,
      "active_service_lines": 3,
      "health_score": 87,
      "cost_mtd": 34500,
      "currency": "USD",
      "created_at": "2025-11-05T09:00:00Z",
      "updated_at": "2026-04-12T07:30:00Z"
    }
  ],
  "meta": {
    "cursor": null,
    "has_more": false
  }
}

GET

workspaces

List all workspaces

curl --request GET \
  --url https://api.scrums.com/v1/workspaces \
  --header 'Authorization: Bearer <token>'

{
  "data": [
    {
      "id": "WS-26-000021",
      "organization_id": "ORG-26-090500",
      "name": "Platform Engineering",
      "slug": "platform-engineering",
      "status": "active",
      "member_count": 12,
      "active_service_lines": 3,
      "health_score": 87,
      "cost_mtd": 34500,
      "currency": "USD",
      "created_at": "2025-11-05T09:00:00Z",
      "updated_at": "2026-04-12T07:30:00Z"
    }
  ],
  "meta": {
    "cursor": null,
    "has_more": false
  }
}

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

organization_id

string

Filter by organization ID.

status

enum<string>

Filter by workspace status.

Available options:

active,

archived

cursor

string

Pagination cursor from a previous response.

limit

integer

default:20

Maximum number of results to return (1–100).

Required range: 1 <= x <= 100

Response

Paginated list of workspaces.

data

object[]

Show child attributes