Sign in

v1

latestOpenAPI 3.1.02026-07-265094114.0 KB
Documents

Retrieve documents

Retrieve all documents in your workspace

get/v1/documents

Query parameters

userIdstring
Example:usr_535B1EC15F5F41EAB1B400E9ED4077B6

The user Id associated with the workspace

sizenumber
Example:50

The maximum number of results to return

pagenumber
Example:1

The number of results to skip before starting to collect the results

sort'LAST_UPDATED' | 'OLDEST_UPDATED' | 'ALPHABETICAL' | 'REVERSE_ALPHABETICAL' | 'NEWEST_CREATED' | 'OLDEST_CREATED'
Example:LAST_UPDATED

The sorting order for the documents

namestring
Example:Project Report

Filter documents by name

statusesstring[]

Filter documents by statuses

[
  "DRAFT",
  "PUBLISHED"
]
createdAtStartstring
Example:2021-09-01T00:00:00.000Z

Start date for the created at filter

createdAtEndstring
Example:2021-09-01T00:00:00.000Z

End date for the created at filter

Response

Retrieve all documents

requestIdstring
resourcestring

Example response

[
  {
    "requestId": "bce766ea-a4ef-48e5-9da1-d9602bfecf2d",
    "resource": "documents",
    "data": [
      {
        "id": "doc_073D2D49094A4AED991A47B614522579",
        "content": "This is the content of the document.",
        "createdAt": "2023-01-01T12:00:00.000Z",
        "updatedAt": "2023-01-02T12:00:00.000Z",
        "name": "My Document",
        "status": "active",
        "userId": "usr_535B1EC15F5F41EAB1B400E9ED4077B6",
        "projectId": "prj_E8F0457A95B04D87A11F6B1DD6AA2356"
      }
    ]
  }
]