Dokumentordner auflisten

Liefert die Ordner, in denen Dokumente organisiert sind, optional eingeschränkt auf diejenigen, die zu einem bestimmten Projekt, Kunden, Mitarbeiter, einer Rechnung oder einem Angebot gehören.

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

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

Name
perPage
Type
integer, nullable
Description
Wird auf diesem Endpunkt ignoriert — senden Sie stattdessen limit. Ein hier angegebener Wert wird durch limit ersetzt, oder durch den Standardwert, wenn limit fehlt.
Name
page
Type
integer, nullable
Description
Die zurückzugebende Ergebnisseite, beginnend bei 1.
Name
orderBy
Type
string, nullable
Description
Name des Feldes, nach dem sortiert wird.
Name
order
Type
string, nullable
Description
Sortierrichtung, aufsteigend oder absteigend.
Einer der Werte: "asc", "desc"
Name
limit
Type
integer, nullable
Description
Die Anzahl der Datensätze pro Seite, 1 bis 200. Standardwert ist 15.
Name
modified_after
Type
string (date-time)
Description
Nur Datensätze zurückgeben, die nach diesem Zeitstempel geändert wurden (ISO 8601 oder “Y-m-d H:i:s”).
Name
modified_before
Type
string (date-time)
Description
Nur Datensätze zurückgeben, die vor oder zu diesem Zeitstempel geändert wurden (ISO 8601 oder “Y-m-d H:i:s”).
Name
name
Type
string, nullable
Description
Beschränkt die Liste auf Ordner, deren Name diesen Text enthält.
Name
type_id
Type
integer, nullable
Description
Beschränkt die Liste auf Ordner dieser Ordnertyp-ID, z. B. Projekt- oder Kundenordner.
Name
project_id
Type
integer, nullable
Description
Beschränkt die Liste auf Ordner, die zu diesem Projekt gehören.
Name
employee_username
Type
string, nullable
Description
Beschränkt die Liste auf Ordner, die zu diesem Mitarbeiter gehören.
Name
invoice_number
Type
string, nullable
Description
Beschränkt die Liste auf Ordner, die zu dieser Rechnung gehören.
Name
customer_number
Type
string, nullable
Description
Beschränkt die Liste auf Ordner, die zu diesem Kunden gehören.
Name
offer_id
Type
integer, nullable
Description
Beschränkt die Liste auf Ordner, die zu diesem Angebot gehören.

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

Ordner GET Einzelnen Dokumentordner abrufen