List employees assigned to a task

Returns a paginated list of employees assigned to the given task, including their price group.

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

Request

GET /api/v1/projects/{id}/tasks/{task_id}/employees

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

Path parameters

Name
id
Type
integer
Description
The project ID
Name
task_id
Type
integer
Description
The task 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
employee_id[]
Type
array of string
Description
Name
from
Type
string (date-time), nullable
Description
Name
to
Type
string (date-time), nullable
Description
Name
price_group[]
Type
array of string
Description

Response

{
  "data": [
    {
      "id": 1,
      "project_id": 16,
      "project_task_id": 1,
      "employee_id": "max.mustermann",
      "from": "string",
      "to": "string",
      "note": "Familienurlaub",
      "price_group": {
        "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
project_id
Type
integer
Description
Identifier of the project the assignment belongs to.
Name
project_task_id
Type
integer
Description
Identifier of the task the employee is assigned to.
Name
employee_id
Type
string
Description
Identifier of the assigned employee.
Name
from
Type
string, nullable
Description
Date the assignment starts.
Name
to
Type
string, nullable
Description
Date the assignment ends.
Name
note
Type
string, nullable
Description
Free-text note about the assignment.
Name
price_group
Type
object (PriceGroup), nullable
Description
Price group the employee is billed with on this task, if one is assigned.
Name
price_group.id
Type
integer
Description
The price group’s unique identifier.
Name
price_group.name
Type
string
Description
The price group’s name, as shown when assigning it to a customer or project.
Name
price_group.number
Type
string, nullable
Description
The price group’s number, used to reference it externally.
Name
price_group.status
Type
boolean
Description
Whether the price group is active; the underlying column is stored inverted, true here means active.
Name
price_group.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.

DELETE Delete a task of a project GET Get an employee assignment of a task