[EXPERIMENTAL] Get Actual by id

Request

Get a single Actual for an Employee.

Security

clientCredentials

Path

employee_idstringrequired

employee_id of the employee that the Actual applies to

Example:my-employee-id

idstring^[a-zA-Z0-9.~\-_]{1,512}$required

Unique identifier for this Actual. Should only contain characters which do not need URL encoding.

Payload

// No request payload

Responses

Actual retrieved

Headers

ETagstring

A weak Etag (ex W/"<etag_value>") which contains the current version of the entity

Example:"W/\"25\""

Bodyapplication/json

employee_idstringread-onlyrequired

Example:"hvertenten"

idstring^[a-zA-Z0-9.~\-_]+$read-onlyrequired

Unique identifier for this Actual.

Example:"14-05-2025-morning-shift"

startstring, (date-time)required

A date and time when the activity was started.

Example:"2025-05-14T08:00:00Z"

endstring, (date-time)

A date and time when the activity has ended.

Example:"2025-05-14T17:00:00Z"

work_timestring, (ISO-8601)required

The total work time performed by an Employee. Must be an ISO-8601 compliant Duration string. Must be strictly positive.

Example:"PT8H"

business_idstring^[a-zA-Z0-9.~\-_]+$read-onlyrequireddeprecated

Unique identifier for this Actual. Deprecated in favor of id.

Example:"14-05-2025-morning-shift"

Response

{
  "employee_id": "hvertenten",
  "business_id": "14-05-2025-morning-shift",
  "id": "14-05-2025-morning-shift",
  "start": "2025-05-14T08:00:00Z",
  "end": "2025-05-14T17:00:00Z",
  "work_time": "PT8H"
}