Retrieve a single document folder

Looks the folder up by its id and returns it together with its subfolders.

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

Request

GET /api/v1/folders/{id}

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

Path parameters

Name
id
Type
integer
Description
The folder ID

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"
    ]
  }
}

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.

GET List document folders GET List the documents stored in a folder