Documentation
Bucket
List Buckets

List Buckets

GET /buckets

Retrieve list of all the buckets.

Request

METHOD: GET

AUTHENTICATION: required

URL: https://api.jsonstorage.online/v1/buckets

QUERY PARAMETERS:

  • 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/buckets

Response

  • Status: 200 OK
  • Body: Array of JSON object representing bucket.
Example Response
[{
  "id": "862976a2-0d02-4973-9cee-5d8841b42857",
  "title": "New Bucket",
  "documents_validation_schema": null,
  "documents_visibility": "private",
  "created_at": "2024-04-03T12:00:00Z"
}]