Skip to content
Hype Doc

Spaces

Spaces organize wins and can be shared with collaborators. Each collaborator has read_only, owner_edit, or full_access access.

List spaces

Section titled “List spaces”
GET /api/v1/spaces

Returns a paginated list of spaces the authenticated user owns or can access, in display order.

Example

Section titled “Example”
Terminal window
curl https://app.myhypedoc.com/api/v1/spaces \
  -H "Authorization: Bearer $HYPEDOC_TOKEN"

Get a space

Section titled “Get a space”
GET /api/v1/spaces/:id

Returns a single space by ID.

owner_id identifies the user charged for the space and all wins inside it. access_level is owner for owned spaces, otherwise read_only, owner_edit, or full_access.

Create a space

Section titled “Create a space”
POST /api/v1/spaces

Request body

Section titled “Request body”
FieldTypeRequiredDescription
space[name]stringYesSpace name
space[emoji]stringNoEmoji icon for the space
space[position]integerNoDisplay order (lower = first)

Example

Section titled “Example”
Terminal window
curl -X POST https://app.myhypedoc.com/api/v1/spaces \
  -H "Authorization: Bearer $HYPEDOC_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "space": {
      "name": "Side Project",
      "emoji": "🚀",
      "position": 2
    }
  }'

Update a space

Section titled “Update a space”
PATCH /api/v1/spaces/:id

Accepts the same fields as create. Only the space owner can update it.

Delete a space

Section titled “Delete a space”
DELETE /api/v1/spaces/:id

Returns 204 No Content on success. Only the space owner can delete it. Deleting a space also deletes all wins in that space.

Errors

Section titled “Errors”
StatusMeaning
401Missing or invalid token
402Free plan limit reached (3 spaces)
404Space not found
422Validation error (e.g. missing name)