List the documents stored in a folder

Returns the documents filed in the given folder, each including its file contents.

Availability: Full version only — a Clock instance answers 404 for this endpoint.

Request

GET /api/v1/folders/{id}/documents

curl --request GET \
     --url 'https://www.zep-online.de/zepinstanz/next/api/v1/folders/{id}/documents' \
     --header 'Accept: application/json' \
     --header 'Authorization: Bearer {token}'

Path parameters

Name
id
Type
integer
Description
The folder ID

Query parameters

Name
perPage
Type
integer, nullable
Description
Ignored on this endpoint — send limit instead. Any value given here is replaced by limit, or by the default when limit is absent.
Name
page
Type
integer, nullable
Description
The page of results to return, counting from 1.
Name
orderBy
Type
string, nullable
Description
Name of the field to sort by.
Name
order
Type
string, nullable
Description
Sort direction, ascending or descending.
One of: "asc", "desc"
Name
limit
Type
integer, nullable
Description
The number of records per page, 1 to 200. Defaults to 15.

Response

{
  "data": [
    {
      "id": 1,
      "filename": "string",
      "file_type": "string",
      "file_contents": "string"
    }
  ],
  "links": {
    "first": "string",
    "last": "string",
    "prev": "string",
    "next": "string"
  },
  "meta": {
    "current_page": 1,
    "from": 1,
    "last_page": 1,
    "links": [
      {
        "url": "string",
        "label": "string",
        "active": true
      }
    ],
    "path": "string",
    "per_page": 1,
    "to": 1,
    "total": 1
  }
}

Response fields

Name
id
Type
integer
Description
Unique identifier of the document.
Name
filename
Type
string
Description
The file’s original name, as it was uploaded.
Name
file_type
Type
string, nullable
Description
MIME type of the stored file.
Name
file_contents
Type
string, nullable
Description
Base64-encoded content of the current document version; null when the version has no stored file.

Generated from the OpenAPI specification — edit the source code, not this page.

GET Retrieve a single document folder GET Retrieve a single document, including its file contents