List multiple time-entries

curl --request GET \
  --url https://{host}/api/v3/timeentries \
  --header 'Authorization: <authorization>'

{
  "data": {
    "count": 123,
    "items": [
      {
        "ownerId": 199,
        "unit": 2,
        "startsAt": "2022-01-01T08:00:00",
        "duration": "03:45:00",
        "id": 2,
        "owner": {
          "id": 2,
          "firstName": "<string>",
          "lastName": "<string>",
          "mail": "[email protected]",
          "legalEntityId": 123
        },
        "endsAt": "2022-01-01T11:45:00",
        "authorId": 199,
        "createdAt": "2022-01-01T18:35:10",
        "modifierId": 123,
        "modifiedAt": "2022-01-01T18:42:14",
        "archivedAt": "2022-01-01T18:41:12",
        "creationSource": 2,
        "layer": 123,
        "axisSections": [
          {
            "id": 2,
            "code": "<string>",
            "name": "<string>",
            "multilingualName": "<string>",
            "description": "<string>",
            "ownerId": 2,
            "startOn": "2023-11-07T05:31:56Z",
            "endOn": "2023-11-07T05:31:56Z",
            "active": true,
            "axisId": 123,
            "parentAxisSections": [
              {}
            ],
            "childrenAxisSections": [
              {}
            ]
          }
        ],
        "comment": "<unknown>",
        "timeTypeId": 123,
        "timesheetId": 123
      }
    ]
  }
}

GET

api

timeentries

List multiple time-entries

curl --request GET \
  --url https://{host}/api/v3/timeentries \
  --header 'Authorization: <authorization>'

{
  "data": {
    "count": 123,
    "items": [
      {
        "ownerId": 199,
        "unit": 2,
        "startsAt": "2022-01-01T08:00:00",
        "duration": "03:45:00",
        "id": 2,
        "owner": {
          "id": 2,
          "firstName": "<string>",
          "lastName": "<string>",
          "mail": "[email protected]",
          "legalEntityId": 123
        },
        "endsAt": "2022-01-01T11:45:00",
        "authorId": 199,
        "createdAt": "2022-01-01T18:35:10",
        "modifierId": 123,
        "modifiedAt": "2022-01-01T18:42:14",
        "archivedAt": "2022-01-01T18:41:12",
        "creationSource": 2,
        "layer": 123,
        "axisSections": [
          {
            "id": 2,
            "code": "<string>",
            "name": "<string>",
            "multilingualName": "<string>",
            "description": "<string>",
            "ownerId": 2,
            "startOn": "2023-11-07T05:31:56Z",
            "endOn": "2023-11-07T05:31:56Z",
            "active": true,
            "axisId": 123,
            "parentAxisSections": [
              {}
            ],
            "childrenAxisSections": [
              {}
            ]
          }
        ],
        "comment": "<unknown>",
        "timeTypeId": 123,
        "timesheetId": 123
      }
    ]
  }
}

Headers

Authorization

string

required

API key. Value must be formatted like so: lucca application={api_key}.

Query Parameters

paging

string

required

{offset},{limit}. Defaults to 0,1000.

Example:

"2000,500"

ownerId

integer[]

Filter out time-entries on its ownerIds

startsAt

string

{comparator},{date-time}. Filter out time-entries on its startsAt.

Example:

"between,2021-01-01,2021-02-01"

axisSections.id

string

Filter on a comma-separated list of AxisSections identifiers.

axisSections.code

string[]

Filter on a comma-separated list of AxisSections codes.

modifiedAt

string

{comparator},{date-time}. Filter out time-entries on their modifiedAt.

Example:

"since,2021-01-01T08:45:23Z"

archivedAt

string

{comparator},{date-time}. Filter out time-entries on their startsAt.

Example:

"since,2021-01-01T08:45:23Z"

orderBy

string

{fieldName},{direction}. Defaults to {id},{asc}

Response

data

object

Show child attributes

data.count

integer

data.items

The time-entry resource · object[]

Show child attributes

data.items.ownerId

integer

required

Reference to the time-entry owner.

Required range: x >= 1

Example:

199

data.items.unit

enum<integer>

required

Unit in which the time-entry has been entered.

0: Days (eg "1/2 day")
1: Hours (eg "8h15min")
2: Time (eg "23:45:00")

Available options:

0,

1,

2

Example:

2

data.items.startsAt

string<date-time>

required

The timeEntry start date and time. Please do NOT send any offset/timezone information ("Z", "+01:00", etc...).

Example:

"2022-01-01T08:00:00"

data.items.duration

string<timespan>

default:00:00:00

required

Duration of the time-entry in the "c" format of a C# timespan In other words : d.hh:mm:ss. Max: "1.00:00:00" (ie 24 hours).

Example:

"03:45:00"

data.items.id

integer

Unique identifier for this object.

Required range: x >= 1

data.items.owner

Timesheet User · object

The owner of this time-entry.

Show child attributes

data.items.owner.id

integer

Unique identifier of this User.

Required range: x >= 1

data.items.owner.firstName

string

Given name.

data.items.owner.lastName

string

Family name

data.items.owner.mail

string<email>

Email address.

data.items.owner.legalEntityId

integer

Unique identifier of the legal establishment this user currently has a work contract with.

data.items.endsAt

string<date-time>

Automatically set as startsAs + duration when editing a timeentry.

Example:

"2022-01-01T11:45:00"

data.items.authorId

integer

Identifier of the user who initially created this time-entry.

Example:

199

data.items.createdAt

string<date-time>

Date and time when time-entry was first created. (Central European Time)

Example:

"2022-01-01T18:35:10"

data.items.modifierId

integer

The unique identifier of the user who last updated the time-entry.

data.items.modifiedAt

string<date-time>

Date and time when time-entry was last modified. (Central European Time). The time-entry is modified by any change made to the time-entry, including when corresponding timesheet is sent for approbation (status=1) and when the timesheet is completely approved (status=2).

Example:

"2022-01-01T18:42:14"

data.items.archivedAt

string<date-time>

Date and time when time-entry was deleted (Central European Time). When null, implies that the time-entry still has not been deleted (and maybe never will).

Example:

"2022-01-01T18:41:12"

data.items.creationSource

enum<integer>

default:2

Attribute used to identify last modification source :

0: Automatic fallback on theoretical time-entries from workcycles.
1: Entered with Lucca Timesheet quick-fill tools.
2: Manually created or edited (default).
3: Imported from external sources. Is read-only on Lucca Timesheet user interfaces only if Timesheet regulation is in following modes : attendance schedule with clock-in clock-out, and activity schedule.
4: Entered with Lucca Timesheet clock-in clock-out tool.

Available options:

0,

1,

2,

3

data.items.layer

integer

Used to store the original workcycle at the time of time-entry modification. In 99.999% of use cases, you will want the 0 : Actual time-entry.

0: Actual time-entry.
1: Theoretical workcycle.

data.items.axisSections

The AxisSection resource · object[] | null

Represent the activities that time-entry should be associated with. When not in activity mode, send an empty array, or do not serialize this property.

Show child attributes

data.items.axisSections.id

integer

Required range: x >= 1

data.items.axisSections.code

string

data.items.axisSections.name

string

data.items.axisSections.multilingualName

string

data.items.axisSections.description

string

data.items.axisSections.ownerId

integer

Required range: x >= 1

data.items.axisSections.startOn

string<date-time>

data.items.axisSections.endOn

string<date-time>

data.items.axisSections.active

boolean

data.items.axisSections.axisId

integer

data.items.axisSections.parentAxisSections

object[]

data.items.axisSections.childrenAxisSections

object[]

data.items.comment

object

A comment to add additional information about the given time-entry. It will be visible on Lucca Timesheet user interface.

Show child attributes

data.items.comment.id

integer

data.items.comment.content

string

Comment content

data.items.comment.authorId

integer

Identifier of the user who initially created this comment

data.items.comment.createdAt

string<date-time>

Date and time when the comment was first created. (Central European Time)

data.items.timeTypeId

integer | null

Optional reference of a configured Time Type. To use only if the timesheet is set up to use Time Types. Null otherwise.

data.items.timesheetId

integer

The reference to the timeshet this timeentry is associated with when the timesheet is at least sent for approval. Is null if the timesheet is still pending submission.

The time-entry resource

Create new time-entries

⌘I

Documentation

Files

Organization Structure API

Core HR API

Expenses API

Invoices API

Absences API

Office API

Project API

Schedule API

Timesheet API

Mealvouchers API

Compensation API

Training API

List multiple time-entries

Headers

Query Parameters

Response