FAfactorialhr
Attendance > BreakConfiguration

Reads a single Break configuration

Changed on

Reads a single Break configuration

get/api/2026-10-01/resources/attendance/break_configurations/{id}

Request

  • Base URL
    https://api.factorialhr.com
  • URL
    https://api.factorialhr.com/api/2026-10-01/resources/attendance/break_configurations/{id}
  • Auth
    • OAuth 2
      Authorization code: https://id.factorialhr.com/oauth/authorize
      Token URL: https://id.factorialhr.com/api/oauth/token scopes: time_tracking
    • or API key in header x-api-key

Path parameters

idstring required

The break configuration ids to retrieve

Response

OK

idstring required
attendance_employees_setting_idstring required

Id of the attendance employee setting

time_settings_break_configuration_idstring required

Id of the time settings break configuration

enabledboolean required

Status of the break configuration if enabled or not

namestring

Name of the break configuration

paidboolean

Check the break configuration is paid or not

Changes