Einzelnen Dokumentordner abrufen

Sucht den Ordner anhand seiner ID und liefert ihn zusammen mit seinen Unterordnern.

Verfügbarkeit: Nur Vollversion — eine Clock-Instanz antwortet auf diesen Endpunkt mit 404.

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}'

Pfad-Parameter

Name
id
Type
integer
Description
Die ID des Ordners

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-Felder

Name
id
Type
integer
Description
Eindeutige ID des Ordners.
Name
folder_name
Type
string
Description
Anzeigename des Ordners.
Name
parent_id
Type
integer, nullable
Description
ID des übergeordneten Ordners oder null für einen Ordner auf der obersten Ebene.
Name
type
Type
object, nullable
Description
Wofür der Ordner verwendet wird, z. B. Dokumente eines Projekts oder eines Kunden.
Name
type.id
Type
integer
Description
Der gespeicherte Wert. Vergleichen Sie gegen diesen, nicht gegen name.
Name
type.name
Type
string
Description
Die lesbare Bezeichnung in der Sprache des Mandanten. Nicht parsen.
Einer der Werte: "Allgemein", "Projekt", "Kunde", "Ticket", "Abrechnung", "Mitarbeiter/in", "Invoice Attachments", "Angebot", "Offer Attachments"
Name
project_id
Type
integer
Description
ID des Projekts, zu dem dieser Ordner gehört. Nur enthalten, wenn der Ordner zu einem Projekt gehört.
Name
customer_number
Type
string, nullable
Description
Nummer des Kunden, zu dem dieser Ordner gehört. Nur enthalten, wenn der Ordner zu einem Kunden gehört.
Name
employee_username
Type
string, nullable
Description
Benutzername des Mitarbeiters, zu dem dieser Ordner gehört. Nur enthalten, wenn der Ordner zu einem Mitarbeiter gehört.
Name
invoice_number
Type
string, nullable
Description
Nummer der Rechnung, zu der dieser Ordner gehört. Nur enthalten, wenn der Ordner zu einer Rechnung gehört.
Name
offer_id
Type
integer, nullable
Description
ID des Angebots, zu dem dieser Ordner gehört. Nur enthalten, wenn der Ordner zu einem Angebot gehört.
Name
subfolders
Type
Liste von string
Description
Untergeordnete Unterordner dieses Ordners. Nur gefüllt, wenn die Unterordner-Relation geladen wurde, andernfalls leer.

Aus der OpenAPI-Spezifikation erzeugt — Änderungen gehören in den Quellcode, nicht auf diese Seite.

GET Dokumentordner auflisten GET In einem Ordner abgelegte Dokumente auflisten