Skip to main content
GET
/
room
/
private
/
:owner_id
/
:room_name
Get Private Room
curl --request GET \
  --url https://api.example.com/room/private/:owner_id/:room_name
{
  "id": "<string>",
  "name": "<string>",
  "owner_id": "<string>",
  "is_private": true,
  "documents": [
    {
      "id": "<string>",
      "name": "<string>",
      "room_id": "<string>"
    }
  ]
}
Retrieves a private room by owner ID and room name. Requires authentication and proper access permissions. Optionally processes a signature token for access sharing.

​
Authentication

Required. Include the authentication token in the Authorization header.

​
Path Parameters

​
owner_id
string
required
User ID of the room owner.
​
room_name
string
required
Name of the private room to retrieve.

​
Query Parameters

​
signature
string
Optional signature token that grants temporary access to the room. Generated via the share endpoint.

​
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 true 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
  • 400 - No owner ID specified
  • 401 - Unauthorized (no token provided)
  • 403 - Forbidden (user does not have access to this private room)
  • 404 - Room not found
  • 500 - Internal server error

​
Example Request

curl https://api.planttogether.com/room/private/user-123/my-private-room \
  -H "Authorization: YOUR_AUTH_TOKEN"

​
Example Response

{
  "id": "550e8400-e29b-41d4-a716-446655440000",
  "name": "my-private-room",
  "owner_id": "user-123",
  "is_private": true,
  "documents": [
    {
      "id": "doc-001",
      "name": "main-document",
      "room_id": "550e8400-e29b-41d4-a716-446655440000"
    }
  ]
}

​
Signature Processing

If a signature is provided in the query parameters, the endpoint will attempt to process it to grant the user access to the room. If signature processing fails, the request continues with the user’s existing permissions. Source: express/src/index.ts:56-98

Build docs developers (and LLMs) love

Get started for freeTalk to us