Spaces

Create and manage spaces (projects) within an organization.

A space is the top-level container for a Hyperspeed workspace. Each space has its own board, file tree, chat rooms, and automations.

List spaces

GET /api/v1/organizations/{orgId}/spaces

Returns all spaces in the organization visible to the authenticated user.

Path parameters

orgId · string · required

Organization UUID.

Example

curl https://your-hostname/api/v1/organizations/YOUR_ORG_ID/spaces \
  -H "Authorization: Bearer YOUR_TOKEN"

Response 200 OK

{
  "spaces": [
    {
      "id": "018e1234-abcd-7000-8000-000000000001",
      "organization_id": "018e1234-abcd-7000-8000-000000000000",
      "name": "Product Launch",
      "description": "Q3 product launch campaign",
      "created_at": "2024-03-01T10:00:00Z"
    }
  ]
}

spaces · array

Array of space objects.

spaces[].id · string

Space UUID.

spaces[].organization_id · string

Parent organization UUID.

spaces[].name · string

Human-readable space name.

spaces[].description · string

Optional description.

spaces[].created_at · string

ISO 8601 creation timestamp.

---

Create a space

POST /api/v1/organizations/{orgId}/spaces

Creates a new space. The authenticated user is automatically added as owner.

Path parameters

orgId · string · required

Organization UUID.

Request body

name · string · required

Display name for the space.

description · string

Optional description for the space.

Example

curl -X POST https://your-hostname/api/v1/organizations/YOUR_ORG_ID/spaces \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"name": "Engineering", "description": "Engineering team space"}'

Response 201 Created

{
  "id": "018e1234-abcd-7000-8000-000000000002",
  "organization_id": "018e1234-abcd-7000-8000-000000000000",
  "name": "Engineering",
  "description": "Engineering team space",
  "created_at": "2024-03-15T09:00:00Z"
}

---

Get a space

GET /api/v1/organizations/{orgId}/spaces/{spaceId}

Path parameters

orgId · string · required

Organization UUID.

spaceId · string · required

Space UUID.

Example

curl https://your-hostname/api/v1/organizations/YOUR_ORG_ID/spaces/YOUR_SPACE_ID \
  -H "Authorization: Bearer YOUR_TOKEN"

Response 200 OK

Returns a single space object (same shape as the list item above).

---

Update a space

The space update endpoint is not exposed as a standalone PATCH /spaces/{spaceId} on the current API version. Space names and descriptions are managed through the web UI. Use the boards endpoints or settings panel for space-level changes.

---

Delete a space

Space deletion is not available via the REST API in the current version. Use the web UI to archive or delete a space.

---

Get the board for a space

GET /api/v1/organizations/{orgId}/spaces/{spaceId}/board

Returns the default board and its columns for the space.

Example

curl https://your-hostname/api/v1/organizations/YOUR_ORG_ID/spaces/YOUR_SPACE_ID/board \
  -H "Authorization: Bearer YOUR_TOKEN"

Response 200 OK

{
  "board": {
    "id": "018e1234-abcd-7000-8000-000000000010",
    "space_id": "018e1234-abcd-7000-8000-000000000002",
    "name": "Main Board",
    "created_at": "2024-03-15T09:00:00Z"
  },
  "columns": [
    {
      "id": "018e1234-abcd-7000-8000-000000000020",
      "board_id": "018e1234-abcd-7000-8000-000000000010",
      "name": "To Do",
      "position": 0
    },
    {
      "id": "018e1234-abcd-7000-8000-000000000021",
      "board_id": "018e1234-abcd-7000-8000-000000000010",
      "name": "In Progress",
      "position": 1
    }
  ]
}

The column.id values are used as column_id when creating tasks.