List planning entries

Returns a paginated list of planning entries, optionally filled in with default planning where none was recorded.

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

Request

GET /api/v1/plannings

curl --request GET \
     --url 'https://www.zep-online.de/zepinstanz/next/api/v1/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 planning entries on or after this date.
Name
date_to
Type
string (date), nullable
Description
Only return planning entries 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 one or more customer numbers.
Name
include_defaults
Type
boolean, nullable
Description
Include the tenant’s default planning entries alongside the explicit ones.

Response

{
  "data": [
    {
      "id": "string",
      "date": "2024-07-20T00:00:00.000000Z",
      "employee_id": "max.mustermann",
      "project_id": 16,
      "customer_number": "K-12345",
      "project_task_id": 1,
      "ticket_id": 1234,
      "subtask_id": 1,
      "type": 1,
      "kind": 1,
      "planning": 1.5,
      "from": "2026-01-31T09:00:00.000000Z",
      "to": "2026-01-31T09:00:00.000000Z",
      "planning_in_hours": 1.5,
      "planning_in_days": 1.5,
      "planning_in_percent": 1.5,
      "working_day": 1,
      "note": "Familienurlaub",
      "created_at": "2024-01-15T10:30:00+01:00",
      "updated_at": "2024-06-20T14:45:00+02:00",
      "planning_details": {
        "type": "string",
        "value": 12.5,
        "unit": "string",
        "effective_hours": 12.5,
        "from_time": "2026-01-31T09:00:00.000000Z",
        "to_time": "2026-01-31T09:00:00.000000Z"
      },
      "employee": {
        "username": "string",
        "firstname": "string",
        "lastname": "string",
        "email": "string"
      },
      "project": {
        "id": 1,
        "name": "string"
      },
      "customer": {
        "customer_number": "string",
        "name": "string"
      }
    }
  ],
  "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 planning entry.
Name
date
Type
string
Description
Date the planning entry applies to.
Name
employee_id
Type
string
Description
Identifier of the planned employee.
Name
project_id
Type
integer, nullable
Description
Identifier of the planned project.
Name
customer_number
Type
string, nullable
Description
Number of the planned customer.
Name
project_task_id
Type
integer, nullable
Description
Identifier of the planned project task.
Name
ticket_id
Type
integer, nullable
Description
Identifier of the planned ticket.
Name
subtask_id
Type
integer, nullable
Description
Identifier of the planned ticket subtask.
Name
type
Type
integer
Description
What kind of object the entry plans: project, ticket, task, or subtask.
Name
kind
Type
integer
Description
How the planned amount is expressed: percentage, hours, day, or a time range.
Name
planning
Type
number, nullable
Description
The planned amount, in the unit its kind defines.
Name
from
Type
string (date-time), nullable
Description
Start of the planned time range, when the kind is a time range.
Name
to
Type
string (date-time), nullable
Description
End of the planned time range, when the kind is a time range.
Name
planning_in_hours
Type
number, nullable
Description
The planned amount converted to hours.
Name
planning_in_days
Type
number, nullable
Description
The planned amount converted to days.
Name
planning_in_percent
Type
number, nullable
Description
The planned amount converted to a percentage.
Name
working_day
Type
integer, nullable
Description
Whether the planned date is a working day for the employee.
Name
note
Type
string, nullable
Description
Free-text note about the planning entry.
Name
created_at
Type
string, nullable
Description
Date and time the planning entry was created.
Name
updated_at
Type
string, nullable
Description
Date and time the planning entry was last modified.
Name
planning_details
Type
object
Description
Planning details based on kind Breakdown of the planned amount, shaped according to the entry’s kind.
Name
planning_details.type
Type
string
Description
Name
planning_details.value
Type
number, nullable
Description
Name
planning_details.unit
Type
string
Description
Name
planning_details.effective_hours
Type
number, nullable
Description
Name
planning_details.from_time
Type
string (date-time), nullable
Description
Name
planning_details.to_time
Type
string (date-time), nullable
Description
Name
employee
Type
object
Description
Related data (when loaded) The planned employee’s basic details, when loaded.
Name
employee.username
Type
string
Description
Name
employee.firstname
Type
string
Description
Name
employee.lastname
Type
string
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
Description
Name
project.name
Type
string, nullable
Description
Name
customer
Type
object
Description
The planned customer’s basic details, when loaded.
Name
customer.customer_number
Type
string
Description
Name
customer.name
Type
string, nullable
Description

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

Planning GET List planning entries (deprecated alias)