List Documents

GET /bucket/:id/documents

Retrieve list of all the documents associated with this bucket.

Request

METHOD: GET

AUTHENTICATION: required

URL: https://api.jsonstorage.online/v1/bucket/:id/documents

QUERY PARAMETERS:

• meta: boolean (optional, defaults to false) - if true, the response will contain metadata; otherwise, only the documents will be returned.
• limit: number (optional, defaults to 100) - Total number of documents to include in the response. (Max Value: 100)
• offset: number (optional, defaults to 0) - Determine the starting point for fetching results, allowing you to skip a specified number of initial documents.

Example Request

  curl -X GET https://api.jsonstorage.online/v1/document/862976a2-0d02-4973-9cee-5d8841b42857/documents

Response

• Status: 200 OK
• Body: Array of JSON object representing the document or metadata.

Example Response

[{
    "key": "value"
}]

With Metadata

[{
  "id": "77b22667-a2e3-438a-a2e4-1a36fd557c1d",
  "title": "New Document",
  "validation_schema": {"type": "object"},
  "visibility": "private",
  "document": {"key": "value"},
  "created_at": "2024-04-03T12:00:00Z"
}]