User Employments

>>>

GET /api/users/:user_id/employments
Get user employment settings (Time & Attendance feature)

Examples

[{
  "id": 17,
  "is_current": true,
  "start_date": null,
  "end_date": null,
  "work_time_group_id": 5,
  "work_time_group_name": "Swedish employees",
  "percentage": 1.0,
  "working_weekdays": [0,1,2,3,4],
  "hide_flex_time": false
}]
>>>

POST /api/users/:user_id/employments
Create user employment settings (Time & Attendance feature)

Params

Param name Description
employment
required

Validations:

  • Must be a Hash
employment[start_date]
optional

Start date (optional). E.g. 2026-01-14.

Validations:

  • Must be a String
employment[end_date]
optional

End date (optonal). E.g. 2026-12-31.

Validations:

  • Must be a String
employment[work_time_group_id]
optional

Work-time group ID.

Validations:

  • Must be a Integer
employment[percentage]
optional

Work-time percentage, 0-1. E.g. 0.8 for 80%. Default: 1.0.

Validations:

  • Must be a Float
employment[hide_flex_time]
optional

Hide user’s flex balance. Default: false.

Validations:

  • Must be one of: true, false, 1, 0.
employment[working_weekdays]
optional

Working weekdays (0 for Mon, 1 for Tue, …, 6 for Sun). Default: [0,1,2,3,4] (Mon-Fri).

Validations:

  • Must be an array of Integer
>>>

PUT /api/users/:user_id/employments/:id
Update user employment settings (Time & Attendance feature)

Params

Param name Description
employment
required

Validations:

  • Must be a Hash
employment[start_date]
optional

Start date (optional). E.g. 2026-01-14.

Validations:

  • Must be a String
employment[end_date]
optional

End date (optonal). E.g. 2026-12-31.

Validations:

  • Must be a String
employment[work_time_group_id]
optional

Work-time group ID.

Validations:

  • Must be a Integer
employment[percentage]
optional

Work-time percentage, 0-1. E.g. 0.8 for 80%. Default: 1.0.

Validations:

  • Must be a Float
employment[hide_flex_time]
optional

Hide user’s flex balance. Default: false.

Validations:

  • Must be one of: true, false, 1, 0.
employment[working_weekdays]
optional

Working weekdays (0 for Mon, 1 for Tue, …, 6 for Sun). Default: [0,1,2,3,4] (Mon-Fri).

Validations:

  • Must be an array of Integer
>>>

DELETE /api/users/:user_id/employments/:id
Delete user employment settings (Time & Attendance feature)