Skip to content

Rooms

Rooms are created automatically when users connect or when you create a thread.

List Rooms

GET /api/v1/rooms
bash
curl https://pulse.hire.rest/api/v1/rooms \
  -H "Authorization: Bearer sk_your_secret_key"

Response:

json
{
  "items": [
    {
      "id": "dashboard",
      "environmentId": "env_abc123",
      "metadata": null,
      "createdAt": "2026-03-10T12:00:00.000Z"
    },
    {
      "id": "settings",
      "environmentId": "env_abc123",
      "metadata": null,
      "createdAt": "2026-03-11T09:30:00.000Z"
    }
  ]
}

Get Room

GET /api/v1/rooms/:roomId

Returns the room and its threads.

bash
curl https://pulse.hire.rest/api/v1/rooms/dashboard \
  -H "Authorization: Bearer sk_your_secret_key"

Response:

json
{
  "room": {
    "id": "dashboard",
    "environmentId": "env_abc123",
    "createdAt": "2026-03-10T12:00:00.000Z"
  },
  "threads": [
    {
      "id": "thread_abc",
      "roomId": "dashboard",
      "resolved": false,
      "positionX": 0.45,
      "positionY": 0.72,
      "createdAt": "2026-03-10T14:00:00.000Z",
      "updatedAt": "2026-03-10T14:05:00.000Z"
    }
  ]
}

Pulse Collaboration SDK