API v1 ReferenceTime Bookings

Returns a list of time bookings.

<Check title="Required Permissions" icon="key">Any authenticated user.</Check>

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Query parameters

pageintegerOptionalDefaults to 1
Page number for pagination
pageSizeintegerOptionalDefaults to 10
Number of items per page
orderbystringOptional
The properties to order by
filterbystringOptional
The filter expression to filter by

Response

OK
idstringOptionalformat: "uuid"
The id of the entity.
createdOnstringOptionalformat: "date-time"
The date this entity was created.
createdBystringOptionalformat: "uuid"
The id of the user who created this entity.
updatedOnstringOptionalformat: "date-time"
The date this entity was last modified.
updatedBystringOptionalformat: "uuid"
The id of the user who last modified this entity.
userIdstringOptionalformat: "uuid"
The id of the user this time booking is for.
projectIdstring or nullOptionalformat: "uuid"

(optional) The id of the project this time booking is for.

startDatestringOptionalformat: "date"
The start date of the time booking.
endDatestringOptionalformat: "date"
The end date of the time booking.
durationintegerOptional
The planned duration, expressed in seconds, of this time booking.
descriptionstring or nullOptional
The optional description for this time booking.
laneOrderintegerOptional

The order in which this object should be shown in the timeline (row number). Used by the awork web app.

isAnonymizedboolean or nullOptional
This will be true if the user doesn't have access to the project. In that case the description will be shadowed.