Retrieve a single category

Looks the category up by its unique name and returns its configuration.

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

Request

GET /api/v1/categories/{name}

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

Path parameters

Name
name
Type
string
Description
The category name

Response

{
  "data": {
    "name": "EU",
    "description": {
      "de": "string",
      "en": "string",
      "fr": "string",
      "es": "string",
      "pl": "string"
    },
    "type": {
      "id": "string",
      "name": "Mitarbeiter/in"
    }
  }
}

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.

GET List the categories available for tagging records Price Groups