REST DocumentationEmployeesGET List an employee's employment periods

List an employee’s employment periods

Returns the paginated list of employment periods recorded for the given employee. The page size is set with limit.

Availability: Full version and ZEP Clock

Request

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

Path parameters

  • Name
    username
    Type
    string
    Description

    The employee username

Query parameters

  • Name
    limit
    Type
    integer, nullable
    Description

    The number of records per page, 1 to 200. Defaults to 15.

  • Name
    page
    Type
    integer, nullable
    Description

    The page of results to return, counting from 1.

Response

{
  "data": [
    {
      "id": 1,
      "employee_id": "max.mustermann",
      "start_date": "2024-01-15T00:00:00.000000Z",
      "end_date": "2024-01-16T00:00:00.000000Z",
      "note": "Familienurlaub",
      "beginning_of_year": "2024-01-01T00:00:00.000000Z",
      "annual_leave_entitlement": 30,
      "period_holiday_entitlement": 30,
      "is_holiday_per_year": true,
      "day_absent_in_hours": 8,
      "created": "2024-07-20T11:30:00.000000Z",
      "modified": "2024-07-20T12:30:00.000000Z"
    }
  ],
  "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 employment period.

  • Name
    employee_id
    Type
    string
    Description

    Username of the employee this employment period belongs to.

  • Name
    start_date
    Type
    string (date-time), nullable
    Description

    First calendar day the employee was employed under this period.

  • Name
    end_date
    Type
    string (date-time), nullable
    Description

    Last calendar day the employee was employed under this period, if it ended.

  • Name
    note
    Type
    string, nullable
    Description

    Free-text note attached to the employment period.

  • Name
    beginning_of_year
    Type
    string (date-time), nullable
    Description

    Calendar day the leave year begins on for this employment period.

  • Name
    annual_leave_entitlement
    Type
    number, nullable
    Description

    Number of vacation days the employee is entitled to per full leave year.

  • Name
    period_holiday_entitlement
    Type
    number, nullable
    Description

    Number of vacation days the employee is entitled to, prorated for this period.

  • Name
    is_holiday_per_year
    Type
    boolean, nullable
    Description

    Whether the annual leave entitlement is expressed per calendar year rather than per employment period.

  • Name
    day_absent_in_hours
    Type
    number, nullable
    Description

    Number of hours a full day of absence is booked as for this employment period.

  • Name
    created
    Type
    string (date-time), nullable
    Description

    Timestamp the employment period was created.

  • Name
    modified
    Type
    string (date-time), nullable
    Description

    Timestamp the employment period was last modified.

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