New API version v7.12 has been released! 🎉
REST DocumentationProjectsGET Get an employee assignment of a task

Get an employee assignment of a task

Returns a single employee assignment, including the employee’s price group on this task.

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

Request

GET /api/v1/projects/{id}/tasks/{task_id}/employees/{project_task_employee_id}
curl --request GET \
     --url 'https://www.zep-online.de/zepinstanz/next/api/v1/projects/{id}/tasks/{task_id}/employees/{project_task_employee_id}' \
     --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

  • Name
    project_task_employee_id
    Type
    integer
    Description

    The project task employee ID

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"
      }
    }
  }
}

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.