Skip to main content

​
Summary

Fetch all documents in your workspace. Documents include titles, descriptions, author information, and timestamps.

​
Request

GET https://api.planetaryapp.us/v1/workspace/{workspace_id}/docs

​
Query Parameters

ParameterTypeDescription
pagenumberPage number (default: 1)
limitnumberItems per page (default: 50, max: 100)

​
Response example

{
  "success": true,
  "documents": [
    {
      "id": "clz1234abcd",
      "title": "Getting Started Guide",
      "description": "How to get started with our workspace",
      "author": {
        "userId": 123456,
        "username": "john_doe",
        "displayName": "John Doe",
        "thumbnail": "https://example.com/avatar.png"
      },
      "createdAt": "2024-01-01T00:00:00Z",
      "updatedAt": "2024-01-02T00:00:00Z"
    }
  ],
  "total": 10,
  "page": 1,
  "limit": 50,
  "pages": 1
}