List the categories available for tagging records

Returns the categories that can be attached to employees, projects, customers, documents or the other entity kinds named by their type.

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

Request

GET /api/v1/categories

curl --request GET \
     --url 'https://www.zep-online.de/zepinstanz/next/api/v1/categories' \
     --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
type
Type
string, nullable
Description
Restricts the list to categories of this type, e.g. employee, project or customer.
One of: "mitarbeiter", "projekt", "kunde", "dokument", "angebot", "ansprechpartner", "ticket", "ticket2", "ticket3"

Response

{
  "data": [
    {
      "name": "EU",
      "description": {
        "de": "string",
        "en": "string",
        "fr": "string",
        "es": "string",
        "pl": "string"
      },
      "type": {
        "id": "string",
        "name": "Mitarbeiter/in"
      }
    }
  ],
  "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
name
Type
string
Description
Name of the category, shown wherever an entity is tagged with it.
Name
description
Type
object
Description
Longer explanation of what this category should be used for.
Name
description.de
Type
string, nullable
Description
Name
description.en
Type
string
Description
Name
description.fr
Type
string
Description
Name
description.es
Type
string
Description
Name
description.pl
Type
string
Description
Name
type
Type
object
Description
The kind of entity this category can be attached to, e.g. employee, project or customer.
Name
type.id
Type
string
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: "Mitarbeiter/in", "Projekt", "Kunde", "Dokument", "Angebot", "Kontakt", "Ticket", "Ticket2", "Ticket3"

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

Categories GET Retrieve a single category