Returns a list of time bookings. | awork API

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

Required Permissions

Any authenticated user.

<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

idstringformat: "uuid"

The id of the entity.

createdOnstringformat: "date-time"

The date this entity was created.

createdBystringformat: "uuid"

The id of the user who created this entity.

updatedOnstringformat: "date-time"

The date this entity was last modified.

updatedBystringformat: "uuid"

The id of the user who last modified this entity.

userIdstringformat: "uuid"

The id of the user this time booking is for.

projectIdstring or nullformat: "uuid"

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

startDatestringformat: "date"

The start date of the time booking.

endDatestringformat: "date"

The end date of the time booking.

durationinteger

The planned duration, expressed in seconds, of this time booking.

descriptionstring or null

The optional description for this time booking.

laneOrderinteger

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

isAnonymizedboolean or null

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