Get an activity
Returns a single activity.
Availability: Full version only — a Clock instance answers 404 for this endpoint.
Request
GET /api/v1/activities/{activity}
curl --request GET \
--url 'https://www.zep-online.de/zepinstanz/next/api/v1/activities/{activity}' \
--header 'Accept: application/json' \
--header 'Authorization: Bearer {token}'Path parameters
- Name
activity- Type
- string
- Description
The activity name
Response
{
"data": {
"name": "EU",
"description": "Angebot|en:offer",
"is_travel": false,
"is_goodwill": true,
"note": "Familienurlaub",
"travel_type": {
"id": 1,
"name": "Pure travel"
}
}
}Response fields
- 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
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"