REST DocumentationProjectsGET List activities assigned to a project

List activities assigned to a project

Returns a paginated list of activities assigned to the given project, including the project-specific factor and travel type.

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

Request

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

Path parameters

  • Name
    id
    Type
    integer
    Description

    The project ID

Query parameters

  • Name
    page
    Type
    integer, nullable
    Description

    The page of results to return, counting from 1.

Response

{
  "data": [
    {
      "id": "string",
      "name": "EU",
      "description": "Angebot|en:offer",
      "is_travel": false,
      "is_goodwill": true,
      "note": "Familienurlaub",
      "default_factor": 1.5,
      "travel_type": {
        "id": 1,
        "name": "Pure travel"
      }
    }
  ],
  "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
    string
    Description

    Unique identifier of the activity.

  • Name
    name
    Type
    string
    Description

    Name of the activity.

  • Name
    description
    Type
    string, nullable
    Description

    Free-text description of the activity.

  • Name
    is_travel
    Type
    boolean
    Description

    Whether the activity counts as travel time.

  • Name
    is_goodwill
    Type
    boolean, nullable
    Description

    Whether the activity is non-billable goodwill work, not charged to the customer.

  • Name
    note
    Type
    string, nullable
    Description

    Free-text note about the activity.

  • Name
    default_factor
    Type
    number
    Description

    Factor this activity’s hours are multiplied by for this project, e.g. for travel time.

  • Name
    travel_type
    Type
    object, nullable
    Description

    Whether the activity is pure travel, purely on call, or both travel and on call.

  • Name
    travel_type.id
    Type
    integer
    Description

    The stored value. Compare against this, not against name.

  • Name
    travel_type.name
    Type
    string
    Description

    The human-readable label, delivered in the tenant’s language. Do not parse it.

    One of: "Pure travel", "Purely on call", "Travel and on call"

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