API v1 Reference › TimeBookings

Creates a time booking for a project and user.

POSThttps://api.awork.com/api/v1/timebookings
POST https://api.awork.com/api/v1/timebookings

Creates a time booking for a project and user. The booking records time for the submitted project and user.

Authentication

AuthorizationBearer

Send your token in the Authorization: Bearer <token> header. See Authentication for API keys and OAuth.

Request body Required

The model to create the time booking.

application/json

userIdstringOptional
format: uuid

The id of the user this time booking is for.

projectIdstring or nullOptional
format: uuid

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

startDatestringOptional
format: date

The start date of this time booking.

endDatestringOptional
format: date

The end date and time of this time booking.

durationintegerOptional
format: int32

The duration (in seconds) of this time booking.

descriptionstring or nullOptional

The optional name/description for this time booking.

laneOrderintegerOptional
format: int32

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

Responses

200 OK

application/json

idstringOptional
format: uuid

The id of the entity.

createdOnstringOptional
format: date-time

The date this entity was created.

createdBystringOptional
format: uuid

The id of the user who created this entity.

updatedOnstringOptional
format: date-time

The date this entity was last modified.

updatedBystringOptional
format: uuid

The id of the user who last modified this entity.

userIdstringOptional
format: uuid

The id of the user this time booking is for.

projectIdstring or nullOptional
format: uuid

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

startDatestringOptional
format: date

The start date of the time booking.

endDatestringOptional
format: date

The end date of the time booking.

durationintegerOptional
format: int32

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

descriptionstring or nullOptional

The optional description for this time booking.

laneOrderintegerOptional
format: int32

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.

400 Bad Request

application/json

codestringRequired
minLength: 1

The error code.

descriptionstringRequired
minLength: 1

The description of the error.

linkstringRequired
minLength: 1

The link to the API documentation page.

detailsarray of string or nullOptional

A list of details describing the error.

validationErrorsarray of object or nullOptional

If a validation error occurred, this contains the validation errors for each property.

Show 2 properties
propertystring or nullOptional

The name of the property that failed validation.

messagestring or nullOptional

The reason why this property failed validation.

traceIdstring or nullOptional

The request trace id for tracking the request.

401 Unauthorized

application/json

codestringRequired
minLength: 1

The error code.

descriptionstringRequired
minLength: 1

The description of the error.

linkstringRequired
minLength: 1

The link to the API documentation page.

detailsarray of string or nullOptional

A list of details describing the error.

validationErrorsarray of object or nullOptional

If a validation error occurred, this contains the validation errors for each property.

Show 2 properties
propertystring or nullOptional

The name of the property that failed validation.

messagestring or nullOptional

The reason why this property failed validation.

traceIdstring or nullOptional

The request trace id for tracking the request.

Search documentation