List resource plannings

Returns a paginated list of the plannings of the resource planning, each with its planned hours in total and per month. Only with the resource planning module (MOD_PLANNING_NEXT, or product line 4 without MOD_RESSOURCENPLANUNG); tenants on the former planning keep using GET /plannings.

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

Request

GET /api/v1/resource-plannings

curl --request GET \
     --url 'https://www.zep-online.de/zepinstanz/next/api/v1/resource-plannings' \
     --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
date_from
Type
string (date), nullable
Description
Only return plannings that end on or after this date.
Name
date_to
Type
string (date), nullable
Description
Only return plannings that start on or before this date.
Name
employee_ids[]
Type
array of string
Description
Restrict the result to one or more employee usernames.
Name
project_ids[]
Type
array of integer
Description
Restrict the result to one or more project ids.
Name
customer_numbers[]
Type
array of string
Description
Restrict the result to the projects of one or more customers.

Response

{
  "data": [
    {
      "id": 1,
      "employee_id": "max.mustermann",
      "project_id": 16,
      "project_task_id": 1,
      "start_date": "2026-10-01",
      "end_date": "2026-10-31",
      "unit": "percent",
      "value": 1.5,
      "note": "Familienurlaub",
      "created": "2024-07-20T11:30:00.000000Z",
      "modified": "2024-07-20T12:30:00.000000Z",
      "total_hours": 1.5,
      "monthly_hours": [
        {
          "month": "2026-10",
          "hours": 68.9
        },
        {
          "month": "2026-11",
          "hours": 65.7
        }
      ],
      "employee": {
        "username": "max.mustermann",
        "firstname": "Max",
        "lastname": "Mustermann",
        "email": "max.mustermann@example.com"
      },
      "project": {
        "id": 16,
        "name": "Website relaunch"
      }
    }
  ],
  "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 resource planning.
Name
employee_id
Type
string
Description
Identifier of the planned employee.
Name
project_id
Type
integer
Description
Identifier of the planned project.
Name
project_task_id
Type
integer, nullable
Description
Identifier of the planned project task, or null when the whole project is planned.
Name
start_date
Type
string
Description
First day of the planning.
Name
end_date
Type
string
Description
Last day of the planning, inclusive.
Name
unit
Type
string
Description
How the value is expressed: percent of each day’s regular working time, or hours per working day.
One of: "percent", "hours"
Name
value
Type
number
Description
The planned amount per day, in the unit.
Name
note
Type
string, nullable
Description
Free-text note about the planning.
Name
created
Type
string, nullable
Description
Date and time the planning was created.
Name
modified
Type
string, nullable
Description
Date and time the planning was last modified.
Name
total_hours
Type
number
Description
Planned hours over the whole planning, from the employee’s regular working time of each day; holidays and absences are not subtracted.
Name
monthly_hours
Type
array of ResourcePlanningMonth
Description
Planned hours per calendar month the planning touches, in ascending order.
Name
monthly_hours.month
Type
string
Description
Calendar month, as YYYY-MM.
Name
monthly_hours.hours
Type
number
Description
Planned hours in that month.
Name
employee
Type
object
Description
The planned employee’s basic details, when loaded.
Name
employee.username
Type
string, nullable
Description
Name
employee.firstname
Type
string, nullable
Description
Name
employee.lastname
Type
string, nullable
Description
Name
employee.email
Type
string, nullable
Description
Name
project
Type
object
Description
The planned project’s basic details, when loaded.
Name
project.id
Type
integer, nullable
Description
Name
project.name
Type
string, nullable
Description

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

Resource Planning Tickets