Skip to content

TimeEntry​

Tracked working time: who worked from when to when, optionally on an assignment or one of its events. Entries add up to the user's time-sheet days, whose approval status they show.


OpenAPI Spec​

GET
/v2/time-entries/spec

Get OpenAPI 3.1.0 spec for TimeEntry API

Responses​

Returns OpenAPI 3.1.0 spec for TimeEntry API

application/json
JSON
{
}

Playground​

Samples​


List TimeEntries​

GET
/v2/time-entries

List TimeEntries

Authorizations​

apiKey
Type
HTTP (bearer)

Parameters​

Query Parameters

page
Type
number
Minimum
0
Default
0
size
Type
number
Minimum
1
Maximum
20
Default
10
uuid
typeUuid
assignmentUuid
eventUuid
eventTypeUuid
userUuid
startsAt
endsAt
dayStatus
daySubmittedAt
dayApprovedAt
externalId
createdAt
updatedAt

Responses​

List response

application/json
JSON
{
  
"page": 0,
  
"pages": 0,
  
"size": 10,
  
"items": [
  
  
{
  
  
  
"uuid": "string",
  
  
  
"typeUuid": "string",
  
  
  
"startsAt": "string",
  
  
  
"endsAt": "string",
  
  
  
"duration": 0,
  
  
  
"computedDuration": 0,
  
  
  
"pausedAt": "string",
  
  
  
"note": "string",
  
  
  
"userUuid": "string",
  
  
  
"assignmentUuid": "string",
  
  
  
"eventUuid": "string",
  
  
  
"eventTypeUuid": "string",
  
  
  
"startLatitude": 0,
  
  
  
"startLongitude": 0,
  
  
  
"startTrackingError": "string",
  
  
  
"endLatitude": 0,
  
  
  
"endLongitude": 0,
  
  
  
"endTrackingError": "string",
  
  
  
"externalId": "string",
  
  
  
"dayStatus": "string",
  
  
  
"daySubmittedAt": "string",
  
  
  
"dayApprovedAt": "string",
  
  
  
"createdAt": "string",
  
  
  
"updatedAt": "string"
  
  
}
  
]
}

Playground​

Server
Authorization
Variables
Key
Value

Samples​


Create a new TimeEntry​

POST
/v2/time-entries

Create a new TimeEntry

Authorizations​

apiKey
Type
HTTP (bearer)

Request Body​

application/json
JSON
{
  
"uuid": "string",
  
"typeUuid": "string",
  
"startsAt": "string",
  
"endsAt": "string",
  
"note": "string",
  
"userUuid": "string",
  
"assignmentUuid": "string",
  
"eventUuid": "string",
  
"eventTypeUuid": "string",
  
"startLatitude": 0,
  
"startLongitude": 0,
  
"startTrackingError": "string",
  
"endLatitude": 0,
  
"endLongitude": 0,
  
"endTrackingError": "string",
  
"externalId": "string"
}

Responses​

TimeEntry found

application/json
JSON
{
  
"uuid": "string",
  
"typeUuid": "string",
  
"startsAt": "string",
  
"endsAt": "string",
  
"duration": 0,
  
"computedDuration": 0,
  
"pausedAt": "string",
  
"note": "string",
  
"userUuid": "string",
  
"assignmentUuid": "string",
  
"eventUuid": "string",
  
"eventTypeUuid": "string",
  
"startLatitude": 0,
  
"startLongitude": 0,
  
"startTrackingError": "string",
  
"endLatitude": 0,
  
"endLongitude": 0,
  
"endTrackingError": "string",
  
"externalId": "string",
  
"dayStatus": "string",
  
"daySubmittedAt": "string",
  
"dayApprovedAt": "string",
  
"createdAt": "string",
  
"updatedAt": "string"
}

Playground​

Server
Authorization
Body

Samples​


Get a TimeEntry​

GET
/v2/time-entries/{timeEntryUuid}

Get a TimeEntry by ID

Authorizations​

apiKey
Type
HTTP (bearer)

Parameters​

Path Parameters

timeEntryUuid*
Type
string
Required
Format
"uuid"

Responses​

TimeEntry found

application/json
JSON
{
  
"uuid": "string",
  
"typeUuid": "string",
  
"startsAt": "string",
  
"endsAt": "string",
  
"duration": 0,
  
"computedDuration": 0,
  
"pausedAt": "string",
  
"note": "string",
  
"userUuid": "string",
  
"assignmentUuid": "string",
  
"eventUuid": "string",
  
"eventTypeUuid": "string",
  
"startLatitude": 0,
  
"startLongitude": 0,
  
"startTrackingError": "string",
  
"endLatitude": 0,
  
"endLongitude": 0,
  
"endTrackingError": "string",
  
"externalId": "string",
  
"dayStatus": "string",
  
"daySubmittedAt": "string",
  
"dayApprovedAt": "string",
  
"createdAt": "string",
  
"updatedAt": "string"
}

Playground​

Server
Authorization
Variables
Key
Value

Samples​


Delete a TimeEntry​

DELETE
/v2/time-entries/{timeEntryUuid}

Delete a TimeEntry by ID

Authorizations​

apiKey
Type
HTTP (bearer)

Parameters​

Path Parameters

timeEntryUuid*
Type
string
Required
Format
"uuid"

Responses​

Successfully removed

Playground​

Server
Authorization
Variables
Key
Value

Samples​


Update a TimeEntry​

PATCH
/v2/time-entries/{timeEntryUuid}

Update a TimeEntry by ID

Authorizations​

apiKey
Type
HTTP (bearer)

Parameters​

Path Parameters

timeEntryUuid*
Type
string
Required
Format
"uuid"

Request Body​

application/json
JSON
{
  
"startsAt": "string",
  
"endsAt": "string",
  
"pausedAt": "string",
  
"note": "string",
  
"endLatitude": 0,
  
"endLongitude": 0,
  
"endTrackingError": "string",
  
"externalId": "string"
}

Responses​

TimeEntry found

application/json
JSON
{
  
"uuid": "string",
  
"typeUuid": "string",
  
"startsAt": "string",
  
"endsAt": "string",
  
"duration": 0,
  
"computedDuration": 0,
  
"pausedAt": "string",
  
"note": "string",
  
"userUuid": "string",
  
"assignmentUuid": "string",
  
"eventUuid": "string",
  
"eventTypeUuid": "string",
  
"startLatitude": 0,
  
"startLongitude": 0,
  
"startTrackingError": "string",
  
"endLatitude": 0,
  
"endLongitude": 0,
  
"endTrackingError": "string",
  
"externalId": "string",
  
"dayStatus": "string",
  
"daySubmittedAt": "string",
  
"dayApprovedAt": "string",
  
"createdAt": "string",
  
"updatedAt": "string"
}

Playground​

Server
Authorization
Variables
Key
Value
Body

Samples​