• Features
  • Pricing
Get Started

OverviewList DocumentsCreate DocumentGet DocumentUpdate DocumentTrash DocumentRestore DocumentDelete PermanentlyDuplicate Document

Documents

GET /v1/documents

List documents with pagination, search, folder filters, and an optional trash-only filter.

GET /v1/documents returns a paginated list of documents.

Authentication

Send an organization API key in x-api-key or Authorization: Bearer <key>.

Query Parameters

NameTypeDefaultDescription
pageinteger1Page number to return.
limitinteger20Number of results per page. Maximum: 100.
qstring""Free-text search term.
folderIdstring (uuid)noneRestrict the result set to one folder.
withoutFolderbooleanfalseWhen true, return only documents without a folder.
deletedOnlybooleanfalseWhen true, only trashed documents are returned.

Example

curl "https://api.blueputto.com/v1/documents?page=1&limit=20&folderId=FOLDER_ID&deletedOnly=false" \
  -H "x-api-key: YOUR_API_KEY"

Success Response

200 OK

{
  "data": [{}],
  "meta": {
    "page": 1,
    "limit": 20,
    "totalItems": 1,
    "totalPages": 1,
    "hasNextPage": false,
    "hasPrevPage": false
  }
}

Error Responses

  • 400 Bad Request
  • 401 Unauthorized
  • 429 Too Many Requests

Documents

Reference for listing, creating, updating, duplicating, trashing, restoring, and permanently deleting documents.

POST /v1/documents

Create a new document by sending a JSON request body.

On this page

AuthenticationQuery ParametersExampleSuccess ResponseError Responses