Spaces

Spaces are categories for organizing wins (e.g. “Work”, “Personal”, “Side Project”).

List spaces

GET /api/v1/spaces

Returns a paginated list of spaces in display order.

Example

Request

curl https://app.myhypedoc.com/api/v1/spaces \
  -H "Authorization: Bearer YOUR_TOKEN"

Response

[
  {
    "id": 1,
    "name": "Work",
    "emoji": "💼",
    "position": 0,
    "wins_count": 28,
    "created_at": "2026-01-01T00:00:00Z",
    "updated_at": "2026-01-15T10:00:00Z"
  },
  {
    "id": 2,
    "name": "Personal",
    "emoji": "🌱",
    "position": 1,
    "wins_count": 12,
    "created_at": "2026-01-01T00:00:00Z",
    "updated_at": "2026-01-10T08:00:00Z"
  }
]

Get a space

GET /api/v1/spaces/:id

Returns a single space by ID.

Create a space

POST /api/v1/spaces

Request body

Field	Type	Required	Description
space[name]	string	Yes	Space name
space[emoji]	string	No	Emoji icon for the space
space[position]	integer	No	Display order (lower = first)

Example

Request

curl -X POST https://app.myhypedoc.com/api/v1/spaces \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "space": {
      "name": "Side Project",
      "emoji": "🚀",
      "position": 2
    }
  }'

Response (201)

{
  "id": 3,
  "name": "Side Project",
  "emoji": "🚀",
  "position": 2,
  "wins_count": 0,
  "created_at": "2026-03-01T12:00:00Z",
  "updated_at": "2026-03-01T12:00:00Z"
}

Update a space

PATCH /api/v1/spaces/:id

Accepts the same fields as create. Only send the fields you want to change.

Delete a space

DELETE /api/v1/spaces/:id

Returns 204 No Content on success. Deleting a space also deletes all wins in that space.

Errors

Status	Meaning
401	Missing or invalid token
402	Free plan limit reached (3 spaces)
404	Space not found
422	Validation error (e.g. missing name)