v6

latestOpenAPI 3.0.0raw.githubusercontent.com2024-10-187525179.6 KB

Documents

List all documents

This method will list all published documents and draft documents belonging to the current user.

post/documents.list

Request body

offsetnumber

limitnumber

sortstring

direction'ASC' | 'DESC'

collectionIdstring uuid

Optionally filter to a specific collection

userIdstring uuid

backlinkDocumentIdstring uuid

parentDocumentIdstring uuid

templateboolean

Optionally filter to only templates

Example request

{
  "limit": 25,
  "sort": "updatedAt",
  "direction": "DESC"
}

Response

Example response

{
  "data": [
    {
      "title": "🎉 Welcome to Acme Inc",
      "emoji": "🎉",
      "text": "…",
      "urlId": "hDYep1TPAM",
      "collaborators": [
        {
          "name": "Jane Doe"
        }
      ],
      "createdBy": {
        "name": "Jane Doe"
      },
      "updatedBy": {
        "name": "Jane Doe"
      }
    }
  ],
  "pagination": {
    "limit": 25
  }
}