Skip to main content
GET
/
room
/
public
/
:room_name
Get Public Room
curl --request GET \
  --url https://api.example.com/room/public/:room_name
{
  "id": "<string>",
  "name": "<string>",
  "owner_id": "<string>",
  "is_private": true,
  "documents": [
    {
      "id": "<string>",
      "name": "<string>",
      "room_id": "<string>"
    }
  ]
}
Retrieves a public room by its name, including all documents in the room.

Authentication

Not required. This endpoint is publicly accessible.

Path Parameters

room_name
string
required
Name of the public room to retrieve.

Response

id
string
Unique identifier of the room.
name
string
Name of the room.
owner_id
string
User ID of the room owner.
is_private
boolean
Whether the room is private. Always false for this endpoint.
documents
array
Array of document objects in the room.
id
string
Document unique identifier.
name
string
Document name.
room_id
string
ID of the room containing this document.

Errors

  • 400 - No room name specified
  • 404 - Room not found
  • 500 - Internal server error

Example Request

curl https://api.planttogether.com/room/public/my-garden-room

Example Response

{
  "id": "550e8400-e29b-41d4-a716-446655440000",
  "name": "my-garden-room",
  "owner_id": "user-123",
  "is_private": false,
  "documents": [
    {
      "id": "doc-001",
      "name": "main-document",
      "room_id": "550e8400-e29b-41d4-a716-446655440000"
    }
  ]
}
Source: express/src/index.ts:34-54

Build docs developers (and LLMs) love