Documentation
Document
Read Document

Read Document

GET /document/:id

Retrieve a document by its ID.

Request

METHOD: GET

AUTHENTICATION: required if visibility is private

URL: https://api.jsonstorage.online/v1/document/:id

QUERY PARAMETERS:

  • meta: boolean (optional, defaults to false) - if true, the response will contain metadata; otherwise, only the document will be returned.
Example Request
  curl -X GET https://api.jsonstorage.online/v1/document/77b22667-a2e3-438a-a2e4-1a36fd557c1d

Response

  • Status: 200 OK
  • Body: 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"
}