List time-recording devices

Returns a paginated list of registered terminals/devices, including the count of assigned employees and categories.

Availability: Full version and ZEP Clock

Request

GET /api/v1/devices

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

Query parameters

Name
page
Type
integer, nullable
Description
The page of results to return, counting from 1.

Response

{
  "data": [
    {
      "id": 1,
      "type": 1,
      "status": 1,
      "name": "EU",
      "password": "1234",
      "min_time": "string",
      "max_time": "string",
      "track": 0,
      "display_config": 1,
      "employees": [
        {
          "employee_id": "max.mustermann"
        }
      ],
      "categories": [
        {
          "name": "EU",
          "description": {
            "de": "string",
            "en": "string",
            "fr": "string",
            "es": "string",
            "pl": "string"
          },
          "type": {
            "id": "string",
            "name": "Mitarbeiter/in"
          }
        }
      ],
      "employees_count": 0,
      "categories_count": 0
    }
  ],
  "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
integer
Description
Unique identifier of the device.
Name
type
Type
integer, nullable
Description
Kind of terminal this device is (e.g. a physical clock terminal or a mobile app).
Name
status
Type
integer, nullable
Description
Whether the device is currently active.
Name
name
Type
string
Description
Display name of the device.
Name
password
Type
string, nullable
Description
Password required to authenticate this device, if configured.
Name
min_time
Type
string, nullable
Description
Earliest time of day this device may be used to book attendance.
Name
max_time
Type
string, nullable
Description
Latest time of day this device may be used to book attendance.
Name
track
Type
integer, nullable
Description
Whether bookings made on this device should be tracked separately.
Name
display_config
Type
integer, nullable
Description
Display configuration applied on the device itself.
Name
employees
Type
array of DeviceEmployee
Description
Employees currently permitted to use this device.
Name
employees.employee_id
Type
string
Description
Username of the employee permitted to use the device.
Name
categories
Type
array of Category
Description
Categories this device is assigned to.
Name
categories.name
Type
string
Description
Name of the category, shown wherever an entity is tagged with it.
Name
categories.description
Type
object
Description
Longer explanation of what this category should be used for.
Name
categories.type
Type
object
Description
The kind of entity this category can be attached to, e.g. employee, project or customer.
Name
employees_count
Type
integer
Description
Number of employees currently permitted to use this device.
Name
categories_count
Type
integer
Description
Number of categories this device is assigned to.

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

Devices GET Get a single time-recording device