List the dynamic attribute definitions

Returns the custom fields configured for employees, projects, customers and the other entity kinds a dynamic attribute can be attached to.

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

Request

GET /api/v1/dynamic-attributes

curl --request GET \
     --url 'https://www.zep-online.de/zepinstanz/next/api/v1/dynamic-attributes' \
     --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.

Response

{
  "data": [
    {
      "id": "string",
      "name": "EU",
      "description": {
        "de": "string",
        "en": "string",
        "fr": "string",
        "es": "string",
        "pl": "string"
      },
      "note": "Familienurlaub",
      "placeholder": "string",
      "position": 1,
      "is_active": true,
      "constraints": {},
      "type": {},
      "kind": {},
      "options": {}
    }
  ],
  "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
id
Type
string
Description
Unique identifier of the attribute definition.
Name
name
Type
string
Description
Label shown for this attribute wherever it is entered or displayed.
Name
description
Type
object, nullable
Description
Explanation of what this attribute captures, shown as help text next to the field.
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
note
Type
string, nullable
Description
Internal note about this definition, not shown to the person filling in the value.
Name
placeholder
Type
string, nullable
Description
Placeholder text shown in the empty input for this attribute.
Name
position
Type
integer
Description
Sort position of this definition among the other attributes of the same kind.
Name
is_active
Type
boolean
Description
Whether this definition is currently active and offered for use.
Name
constraints
Type
object, nullable
Description
Validation rules applied to a value entered for this attribute, e.g. required or a numeric range.
Name
type
Type
object, nullable
Description
The data type of the attribute’s value, e.g. text, number, date or options.
Name
kind
Type
object, nullable
Description
The kind of entity this attribute can be attached to, e.g. employee, project or customer.
Name
options
Type
object, nullable
Description
The selectable option values. Only present for definitions of type OPTIONS.

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

Dynamic Attributes GET Retrieve a single dynamic attribute definition