List project assignments across all projects

Returns the paginated list of every project assignment of the tenant, so a client does not have to read them project by project or employee by employee. Filter by project_id and employee_id (a single value or a list), project_status, project_start_date and project_end_date. Rows are ordered by id unless orderBy says otherwise.

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

Request

GET /api/v1/project-employees

curl --request GET \
     --url 'https://www.zep-online.de/zepinstanz/next/api/v1/project-employees' \
     --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
project_status
Type
string, nullable
Description
Restrict the result to projects in one or more statuses. A single value is accepted as well as a list.
Name
project_start_date
Type
string (date)
Description
Only return projects whose start date is this date or later.
Name
project_end_date
Type
string (date)
Description
Only return projects whose end date is on or before this date. Must not be earlier than project_start_date.
Name
project_id[]
Type
array of integer
Description
Only return assignments to these projects. Send one id (project_id=7) or several (project_id[]=7&project_id[]=8). An unknown id gives an empty list.
Name
employee_id[]
Type
array of string
Description
Only return assignments of these employees. Send one username (employee_id=jdoe) or several (employee_id[]=jdoe&employee_id[]=asmith).

Response

{
  "data": [
    {
      "id": 1,
      "employee_id": "max.mustermann",
      "project_id": 16,
      "project_number": "P-1001",
      "from": "2025-01-01T00:00:00.000000Z",
      "to": "2025-12-31T00:00:00.000000Z",
      "note": "Familienurlaub",
      "availability": 100,
      "internal_rate": 1.5,
      "rate_type": {
        "id": 1,
        "name": "Hourly"
      },
      "type": {
        "id": 0,
        "name": "Project member"
      },
      "priceGroup": {
        "id": 1,
        "name": "EU",
        "number": "EU-1",
        "status": true,
        "description": {
          "de": "Preisgruppe EU",
          "en": "EU price group"
        }
      }
    }
  ],
  "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 assignment.
Name
employee_id
Type
string
Description
Identifier of the assigned employee.
Name
project_id
Type
integer
Description
Identifier of the project the assignment belongs to.
Name
project_number
Type
string, nullable
Description
Number of the project the assignment belongs to, null when the project no longer exists.
Name
from
Type
string (date-time), nullable
Description
Date the assignment starts.
Name
to
Type
string (date-time), nullable
Description
Date the assignment ends.
Name
note
Type
string, nullable
Description
Free-text note about the assignment.
Name
availability
Type
integer, nullable
Description
How much of the employee’s time is available for this project.
Name
internal_rate
Type
number, nullable
Description
Internal rate applied to this employee’s time on the project.
Name
rate_type
Type
object, nullable
Description
How the internal rate is applied: per hour, per day, or as a fixed amount.
Name
rate_type.id
Type
integer
Description
The stored value. Compare against this, not against name.
Name
rate_type.name
Type
string
Description
The human-readable label, delivered in the tenant’s language. Do not parse it.
One of: "Hourly", "Täglich", "keines"
Name
type
Type
object, nullable
Description
The employee’s position on the project, e.g. lead or member.
Name
type.id
Type
integer
Description
The stored value. Compare against this, not against name.
Name
type.name
Type
string
Description
The human-readable label, delivered in the tenant’s language. Do not parse it.
One of: "Project member", "Project manager with budget responsibility", "Projektleiter"
Name
priceGroup
Type
object (PriceGroup)
Description
Price group the employee is billed with on this project.
Name
priceGroup.id
Type
integer
Description
The price group’s unique identifier.
Name
priceGroup.name
Type
string
Description
The price group’s name, as shown when assigning it to a customer or project.
Name
priceGroup.number
Type
string, nullable
Description
The price group’s number, used to reference it externally.
Name
priceGroup.status
Type
boolean
Description
Whether the price group is active; the underlying column is stored inverted, true here means active.
Name
priceGroup.description
Type
object
Description
The price group’s description, published as a per-language structure (i18n) rather than a plain string.

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

Project Employees Employees