List document folders

Returns the folders documents are organised in, optionally restricted to those belonging to a given project, customer, employee, invoice or offer.

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

Request

GET /api/v1/folders

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

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.
Name
modified_after
Type
string (date-time)
Description
Only return records modified after this timestamp (ISO 8601, or “Y-m-d H:i:s”).
Name
modified_before
Type
string (date-time)
Description
Only return records modified before or at this timestamp (ISO 8601, or “Y-m-d H:i:s”).
Name
name
Type
string, nullable
Description
Restricts the list to folders whose name contains this text.
Name
type_id
Type
integer, nullable
Description
Restricts the list to folders of this folder-type id, e.g. project or customer folders.
Name
project_id
Type
integer, nullable
Description
Restricts the list to folders that belong to this project.
Name
employee_username
Type
string, nullable
Description
Restricts the list to folders that belong to this employee.
Name
invoice_number
Type
string, nullable
Description
Restricts the list to folders that belong to this invoice.
Name
customer_number
Type
string, nullable
Description
Restricts the list to folders that belong to this customer.
Name
offer_id
Type
integer, nullable
Description
Restricts the list to folders that belong to this offer.

Response

{
  "data": [
    {
      "id": 1,
      "folder_name": "Interne Dokumente",
      "parent_id": 1,
      "type": {
        "id": 1,
        "name": "Allgemein"
      },
      "project_id": 16,
      "customer_number": "K-12345",
      "employee_username": "string",
      "invoice_number": "20240001",
      "offer_id": 1,
      "subfolders": [
        "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 folder.
Name
folder_name
Type
string
Description
Display name of the folder.
Name
parent_id
Type
integer, nullable
Description
Id of the parent folder, or null for a folder at the top level.
Name
type
Type
object, nullable
Description
What the folder is used for, e.g. a project’s or a customer’s documents.
Name
type.id
Type
integer
Description
The stored value. Compare against this, not against name.
Name
type.name
Type
string
Description
The human-readable label, delivered in the tenant’s language. Do not parse it.
One of: "Allgemein", "Projekt", "Kunde", "Ticket", "Abrechnung", "Mitarbeiter/in", "Invoice Attachments", "Angebot", "Offer Attachments"
Name
project_id
Type
integer
Description
Id of the project this folder belongs to. Only present when the folder belongs to a project.
Name
customer_number
Type
string, nullable
Description
Number of the customer this folder belongs to. Only present when the folder belongs to a customer.
Name
employee_username
Type
string, nullable
Description
Username of the employee this folder belongs to. Only present when the folder belongs to an employee.
Name
invoice_number
Type
string, nullable
Description
Number of the invoice this folder belongs to. Only present when the folder belongs to an invoice.
Name
offer_id
Type
integer, nullable
Description
Id of the offer this folder belongs to. Only present when the folder belongs to an offer.
Name
subfolders
Type
array of string
Description
Nested subfolders of this folder. Filled only when the subfolder relation was loaded, empty otherwise.

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

Folders GET Retrieve a single document folder