REST DocumentationProjectsGET List employees assigned to a project

List employees assigned to a project

Returns a paginated list of employees assigned to the given project.

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

Request

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

Path parameters

  • Name
    id
    Type
    integer
    Description

    The project ID

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.

Response

{
  "data": [
    {
      "id": 1,
      "employee_id": "string",
      "project_id": 1,
      "from": "2026-01-31T09:00:00.000000Z",
      "to": "2026-01-31T09:00:00.000000Z",
      "note": "string",
      "availability": 1,
      "internal_rate": 12.5,
      "rate_type": {
        "id": 1,
        "name": "Hourly"
      },
      "type": {
        "id": 1,
        "name": "Project member"
      },
      "priceGroup": {
        "id": 1,
        "name": "EU",
        "number": "string",
        "status": true,
        "description": {
          "de": "string",
          "en": "string",
          "fr": "string",
          "es": "string",
          "pl": "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
    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
    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
    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
  • 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.