Skip to main content
GET
List Working Time Arrangements.

Headers

Authorization
string
required

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

Query Parameters

Find a working time arrangement based on its name.

isPartTime
boolean

When true, only returns part-time working time arrangements.

unit
enum<string>

Filter working time arrangements on their unit. An event can be set in:

  • Day: "I worked for a half day last Monday".
  • Hour: "I worked for 2 hours last Monday".
  • Time: "I worked between 10:00 AM and 12:00 AM last Monday".
Available options:
day,
hour,
time
statuses
enum<string>[]

Filter Working Time Arrangements on their status (comma separated list), eg ?statuses=active,inactive. Repeating the parameter also works. If omitted, Working Time Arrangements of every status are retrieved.

The status of a Working Time Arrangement.

  • active: not archived, and currently assigned to at least one employee.
  • inactive: not archived, but not currently assigned to any employee.
  • archived: should no longer be given to employees.
Available options:
active,
inactive,
archived
sort
enum<string>

Sort items by property.

Available options:
id,
-id
page
string

Next page token

Examples:

"next_token&fields.root=next"

"2"

limit
integer
default:10

Number of items per page

Required range: 0 <= x <= 100
fields.root
enum<string>

Include collection properties.

Available options:
count

Response

OK

items
The Working Time Arrangement resource · object[]