New API version v7.7.0 has been released! 🎉
REST Documentation
Get all planning entries

Get all planning entries

Use this endpoint to retrieve a paginated list of all planning entries.

Request

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

Filter Parameters

  • Name
    date_from
    Type
    string
    Description

    Start date for filtering (YYYY-MM-DD)

  • Name
    date_to
    Type
    string
    Description

    End date for filtering (YYYY-MM-DD)

  • Name
    employee_ids
    Type
    array
    Description

    Array of employee IDs to filter by

  • Name
    project_ids
    Type
    array
    Description

    Array of project IDs to filter by

  • Name
    customer_numbers
    Type
    array
    Description

    Array of customer numbers to filter by

Response

{
	"data": [
		{
			"id": 1,
			"date": "2025-10-15",
			"employee_id": "john.doe",
			"project_id": 123,
			"customer_number": "C10001",
			"project_task_id": 456,
			"ticket_id": null,
			"subtask_id": null,
			"type": "project",
			"kind": "hour",
			"planning": "8.00",
			"from": null,
			"to": null,
			"planning_in_hours": "8.00",
			"planning_in_days": "1.00",
			"planning_in_percent": "100.00",
			"working_day": "8.00",
			"note": "Development work",
			"created_at": "2025-10-01T10:00:00.000000Z",
			"updated_at": "2025-10-01T10:00:00.000000Z",
			"planning_details": {
				"type": "hours",
				"value": "8.00",
				"unit": "hours",
				"effective_hours": "8.00"
			},
			"employee": {
				"username": "john.doe",
				"first_name": "John",
				"last_name": "Doe",
				"email": "john.doe@example.com"
			},
			"project": {
				"id": 123,
				"name": "Website Relaunch"
			},
			"customer": {
				"customer_number": "C10001",
				"name": "Example Corp"
			}
		},
		{
			"id": 2,
			"date": "2025-10-16",
			"employee_id": "jane.smith",
			"project_id": 124,
			"customer_number": "C10002",
			"project_task_id": 457,
			"ticket_id": null,
			"subtask_id": null,
			"type": "project",
			"kind": "percent",
			"planning": "50.00",
			"from": null,
			"to": null,
			"planning_in_hours": "4.00",
			"planning_in_days": "0.50",
			"planning_in_percent": "50.00",
			"working_day": "8.00",
			"note": null,
			"created_at": "2025-10-01T11:00:00.000000Z",
			"updated_at": "2025-10-01T11:00:00.000000Z",
			"planning_details": {
				"type": "percentage",
				"value": "50.00",
				"unit": "%",
				"effective_hours": "4.00"
			},
			"employee": {
				"username": "jane.smith",
				"first_name": "Jane",
				"last_name": "Smith",
				"email": "jane.smith@example.com"
			},
			"project": {
				"id": 124,
				"name": "Mobile App"
			},
			"customer": {
				"customer_number": "C10002",
				"name": "Test Inc"
			}
		},
		{
			"id": 3,
			"date": "2025-10-17",
			"employee_id": "john.doe",
			"project_id": 123,
			"customer_number": "C10001",
			"project_task_id": 458,
			"ticket_id": null,
			"subtask_id": null,
			"type": "project",
			"kind": "from_to",
			"planning": null,
			"from": "09:00:00",
			"to": "13:30:00",
			"planning_in_hours": "4.50",
			"planning_in_days": "0.56",
			"planning_in_percent": "56.25",
			"working_day": "8.00",
			"note": "Meeting and concept",
			"created_at": "2025-10-01T12:00:00.000000Z",
			"updated_at": "2025-10-01T12:00:00.000000Z",
			"planning_details": {
				"type": "time_range",
				"value": null,
				"from_time": "09:00:00",
				"to_time": "13:30:00",
				"unit": "time",
				"effective_hours": "4.50"
			},
			"employee": {
				"username": "john.doe",
				"first_name": "John",
				"last_name": "Doe",
				"email": "john.doe@example.com"
			},
			"project": {
				"id": 123,
				"name": "Website Relaunch"
			},
			"customer": {
				"customer_number": "C10001",
				"name": "Example Corp"
			}
		}
	],
	"links": {
		"first": "https://www.zep-online.de/zepinstanz/next/api/v1/planning?page=1",
		"last": "https://www.zep-online.de/zepinstanz/next/api/v1/planning?page=1",
		"prev": null,
		"next": null
	},
	"meta": {
		"current_page": 1,
		"from": 1,
		"last_page": 1,
		"path": "https://www.zep-online.de/zepinstanz/next/api/v1/planning",
		"per_page": 100,
		"to": 3,
		"total": 3
	}
}

Response Fields

  • Name
    id
    Type
    integer
    Description

    Unique ID of the planning entry

  • Name
    date
    Type
    string
    Description

    Date of planning (YYYY-MM-DD)

  • Name
    employee_id
    Type
    string
    Description

    Employee username

  • Name
    project_id
    Type
    integer
    Description

    Project ID

  • Name
    customer_number
    Type
    string
    Description

    Customer number

  • Name
    project_task_id
    Type
    integer|null
    Description

    Project task ID

  • Name
    ticket_id
    Type
    integer|null
    Description

    Ticket ID

  • Name
    subtask_id
    Type
    integer|null
    Description

    Subtask ID

  • Name
    type
    Type
    string
    Description

    Planning type (e.g. "project")

  • Name
    kind
    Type
    string
    Description

    Planning kind: "hour" (hours), "percent" (percentage), "from_to" (time range), "day" (days)

  • Name
    planning
    Type
    string|null
    Description

    Planning value (depends on kind)

  • Name
    from
    Type
    string|null
    Description

    Start time for kind="from_to" (HH:MM:SS)

  • Name
    to
    Type
    string|null
    Description

    End time for kind="from_to" (HH:MM:SS)

  • Name
    planning_in_hours
    Type
    string
    Description

    Planning converted to hours

  • Name
    planning_in_days
    Type
    string
    Description

    Planning converted to days

  • Name
    planning_in_percent
    Type
    string
    Description

    Planning converted to percentage

  • Name
    working_day
    Type
    string
    Description

    Working hours per day

  • Name
    note
    Type
    string|null
    Description

    Planning note

  • Name
    created_at
    Type
    string
    Description

    Creation timestamp (ISO 8601)

  • Name
    updated_at
    Type
    string
    Description

    Update timestamp (ISO 8601)

  • Name
    planning_details
    Type
    object
    Description

    Detailed planning information with type, value, unit and effective_hours

  • Name
    employee
    Type
    object
    Description

    Employee information (username, first_name, last_name, email)

  • Name
    project
    Type
    object
    Description

    Project information (id, name)

  • Name
    customer
    Type
    object
    Description

    Customer information (customer_number, name)