{"items":[{"type":"link","fsPath":"index.md","metadata":{"type":"markdown"},"label":"Overview","link":"/","routeSlug":"/"},{"type":"group","label":"Guides","items":[{"type":"link","fsPath":"guides/quickstart.md","metadata":{"type":"markdown"},"label":"Quickstart","link":"/guides/quickstart","routeSlug":"/guides/quickstart"},{"type":"link","fsPath":"guides/use-cases.md","metadata":{"type":"markdown"},"label":"Use cases","link":"/guides/use-cases","routeSlug":"/guides/use-cases"},{"type":"link","fsPath":"guides/webhooks.md","metadata":{"type":"markdown"},"label":"Webhooks","link":"/guides/webhooks","routeSlug":"/guides/webhooks"},{"type":"link","fsPath":"guides/become-a-partner.md","metadata":{"type":"markdown"},"label":"Become a partner","link":"/guides/become-a-partner","routeSlug":"/guides/become-a-partner"}],"expanded":"true"},{"type":"link","label":"Dyflexis API","link":"/openapi","routeSlug":"/openapi"},{"type":"link","label":"Base URL","link":"/openapi/section/base-url","routeSlug":"/openapi/section/base-url"},{"type":"link","label":"Authentication","link":"/openapi/section/authentication","routeSlug":"/openapi/section/authentication"},{"type":"link","label":"API scopes","link":"/openapi/section/api-scopes","routeSlug":"/openapi/section/api-scopes"},{"type":"link","label":"Timezones","link":"/openapi/section/timezones","routeSlug":"/openapi/section/timezones"},{"type":"link","label":"Errors","link":"/openapi/section/errors","routeSlug":"/openapi/section/errors"},{"type":"link","label":"Rate limiting","link":"/openapi/section/rate-limiting","routeSlug":"/openapi/section/rate-limiting"},{"type":"link","label":"Pagination","link":"/openapi/section/pagination","routeSlug":"/openapi/section/pagination"},{"type":"separator","label":"Offices & departments"},{"type":"group","label":"Offices & departments","link":"/openapi/offices-and-departments","routeSlug":"/openapi/offices-and-departments","items":[{"label":"Fetch the department tree","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/offices-and-departments/getdepartmenttree","routeSlug":"/openapi/offices-and-departments/getdepartmenttree","metadata":{"seo":{"title":"Fetch the department tree","description":"Requires scope: business or payroll."}},"httpPath":"/api/department-management/v3/tree"},{"label":"List offices","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/offices-and-departments/listoffices","routeSlug":"/openapi/offices-and-departments/listoffices","metadata":{"seo":{"title":"List offices","description":"Requires scope: external_employees or clock."}},"badges":[{"name":"LEGACY","color":"#526fa6"}],"httpPath":"/api2/offices"}]},{"type":"separator","label":"Employees"},{"type":"group","label":"Employees","link":"/openapi/employees","routeSlug":"/openapi/employees","items":[{"label":"List employees","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/employees/listbusinessemployees","routeSlug":"/openapi/employees/listbusinessemployees","metadata":{"seo":{"title":"List employees","description":"Requires scope: business."}},"httpPath":"/api/business/v3/employees"},{"label":"List personnel numbers","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/employees/listpersonnelnumbers","routeSlug":"/openapi/employees/listpersonnelnumbers","metadata":{"seo":{"title":"List personnel numbers","description":"Requires scope: employee_mappings."}},"badges":[{"name":"LEGACY","color":"#526fa6"}],"httpPath":"/api2/employee-mappings"},{"label":"Create or update an employee","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/employees/createorupdateemployee","routeSlug":"/openapi/employees/createorupdateemployee","metadata":{"seo":{"title":"Create or update an employee","description":"Requires scope: external_employees."}},"httpPath":"/api2/external-employees/{employeeReference}"}]},{"type":"separator","label":"Employment contracts"},{"type":"group","label":"Employment contracts","link":"/openapi/employment-contracts","routeSlug":"/openapi/employment-contracts","items":[{"label":"List contract types","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/employment-contracts/listcontracttypes","routeSlug":"/openapi/employment-contracts/listcontracttypes","metadata":{"seo":{"title":"List contract types","description":"Requires scope: external_employees."}},"httpPath":"/api2/contract-types"},{"label":"Create or update contracts","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/employment-contracts/createorupdatecontracts","routeSlug":"/openapi/employment-contracts/createorupdatecontracts","metadata":{"seo":{"title":"Create or update contracts","description":"Requires scope: external_employees."}},"httpPath":"/api2/external-employees/{employeeReference}/contracts"}]},{"type":"separator","label":"Workload & capacity"},{"type":"group","label":"Information streams","link":"/openapi/information-streams","routeSlug":"/openapi/information-streams","items":[{"type":"link","label":"Onboarding flow","link":"/openapi/information-streams/onboarding-flow","routeSlug":"/openapi/information-streams/onboarding-flow"},{"type":"link","label":"Roll-ups","link":"/openapi/information-streams/roll-ups","routeSlug":"/openapi/information-streams/roll-ups"},{"label":"List information streams","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/information-streams/listinformationstreams","routeSlug":"/openapi/information-streams/listinformationstreams","metadata":{"seo":{"title":"List information streams","description":"Requires scope: forecasting."}},"httpPath":"/information-streams/v3/list"},{"label":"Fetch information stream data points","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/information-streams/listinformationstreamdatapoints","routeSlug":"/openapi/information-streams/listinformationstreamdatapoints","metadata":{"seo":{"title":"Fetch information stream data points","description":"Requires scope: forecasting."}},"httpPath":"/information-streams/v3/data-points"},{"label":"Create or update an information stream","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/information-streams/createorupdateinformationstream","routeSlug":"/openapi/information-streams/createorupdateinformationstream","metadata":{"seo":{"title":"Create or update an information stream","description":"Requires scope: forecasting."}},"httpPath":"/information-streams/v3/streams"},{"label":"Store data in an information stream","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/information-streams/storeinformationstreamdata","routeSlug":"/openapi/information-streams/storeinformationstreamdata","metadata":{"seo":{"title":"Store data in an information stream","description":"Requires scope: forecasting."}},"httpPath":"/information-streams/v3/datapoint/{key}"}]},{"type":"separator","label":"Scheduling"},{"type":"group","label":"Scheduling","link":"/openapi/scheduling","routeSlug":"/openapi/scheduling","items":[{"label":"List scheduled shifts","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/scheduling/listscheduledshifts","routeSlug":"/openapi/scheduling/listscheduledshifts","metadata":{"seo":{"title":"List scheduled shifts","description":"Requires scope: business."}},"httpPath":"/api/business/v3/scheduled"},{"label":"Schedule mutations","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/scheduling/listschedulemutations","routeSlug":"/openapi/scheduling/listschedulemutations","metadata":{"seo":{"title":"Schedule mutations","description":"Authentication: legacy X-Dyflexis-AuthToken header (see the Legacy v0 token security scheme), not Authorization."}},"badges":[{"name":"LEGACY","color":"#526fa6"}],"httpPath":"/api/v0/mutation"}]},{"type":"separator","label":"Time & attendance"},{"type":"group","label":"Clocked hours","link":"/openapi/clocked-hours","routeSlug":"/openapi/clocked-hours","items":[{"label":"Register a clock-in","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/clocked-hours/registerclockin","routeSlug":"/openapi/clocked-hours/registerclockin","metadata":{"seo":{"title":"Register a clock-in","description":"Requires scope: clock."}},"httpPath":"/api/clock/v3/clock-in"},{"label":"Register a clock-out","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/clocked-hours/registerclockout","routeSlug":"/openapi/clocked-hours/registerclockout","metadata":{"seo":{"title":"Register a clock-out","description":"Requires scope: clock."}},"httpPath":"/api/clock/v3/clock-out"},{"label":"List clock moments","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/clocked-hours/listclockmoments","routeSlug":"/openapi/clocked-hours/listclockmoments","metadata":{"seo":{"title":"List clock moments","description":"Requires scope: attendance_registration."}},"httpPath":"/api2/attendance-registration/{date}"}]},{"type":"group","label":"Registered hours","link":"/openapi/registered-hours","routeSlug":"/openapi/registered-hours","items":[{"label":"List registered hours","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/registered-hours/listregisteredhours","routeSlug":"/openapi/registered-hours/listregisteredhours","metadata":{"seo":{"title":"List registered hours","description":"Requires scope: business."}},"httpPath":"/api/business/v3/registered-hours"}]},{"type":"separator","label":"Payroll"},{"type":"group","label":"Payroll","link":"/openapi/payroll","routeSlug":"/openapi/payroll","items":[{"label":"List payroll employees","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/payroll/listpayrollemployees","routeSlug":"/openapi/payroll/listpayrollemployees","metadata":{"seo":{"title":"List payroll employees","description":"Requires scope: payroll."}},"httpPath":"/api/payroll/v3/employees"},{"label":"Fetch hours per day","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/payroll/gethoursperday","routeSlug":"/openapi/payroll/gethoursperday","metadata":{"seo":{"title":"Fetch hours per day","description":"Requires scope: payroll."}},"httpPath":"/api/payroll/v3/hours-per-day/{officeUrl}/{contractTypeGroupName}/{period}"},{"label":"Fetch hours per department","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/payroll/gethoursperdepartment","routeSlug":"/openapi/payroll/gethoursperdepartment","metadata":{"seo":{"title":"Fetch hours per department","description":"Requires scope: payroll."}},"httpPath":"/api/payroll/v3/hours-per-department/{officeUrl}/{contractTypeGroupName}/{period}"},{"label":"List wage components","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/payroll/listwagecomponents","routeSlug":"/openapi/payroll/listwagecomponents","metadata":{"seo":{"title":"List wage components","description":"Requires scope: payroll_hours."}},"httpPath":"/api2/payroll/wage-components"},{"label":"Fetch the payroll period queue","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/payroll/getpayrollperiodqueue","routeSlug":"/openapi/payroll/getpayrollperiodqueue","metadata":{"seo":{"title":"Fetch the payroll period queue","description":"Requires scope: payroll_hours."}},"httpPath":"/api2/payroll/queue/from/{lastQueueId}"},{"label":"Update queue item status","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/payroll/updatepayrollqueuestatus","routeSlug":"/openapi/payroll/updatepayrollqueuestatus","metadata":{"seo":{"title":"Update queue item status","description":"Requires scope: payroll_hours."}},"httpPath":"/api2/payroll/queue/{queueId}/status"},{"type":"separator","label":"Webhooks","variant":"secondary"},{"label":"Payroll period ready","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/openapi/payroll/payrollperiodreadyevent","routeSlug":"/openapi/payroll/payrollperiodreadyevent","metadata":{"seo":{"title":"Payroll period ready","description":"Webhook, Dyflexis sends this POST request to a URL you host. See the Webhooks guide for how to register your receiver and what it must return."}},"httpPath":"payrollPeriodReady"}]},{"type":"separator","label":"Absence"},{"type":"group","label":"Absence","link":"/openapi/absence","routeSlug":"/openapi/absence","items":[{"label":"Get sick leave status history","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/absence/getsickleavestatushistory","routeSlug":"/openapi/absence/getsickleavestatushistory","metadata":{"seo":{"title":"Get sick leave status history","description":"Requires scope: absence."}},"httpPath":"/api/absence/v3/sick-leave/{sickLeaveRegistrationId}/status-history"},{"label":"List sick leave registrations","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/absence/listsickleaveregistrations","routeSlug":"/openapi/absence/listsickleaveregistrations","metadata":{"seo":{"title":"List sick leave registrations","description":"Requires scope: absence."}},"httpPath":"/api/absence/v3/sick-leave"},{"label":"Report sick leave status","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/absence/reportsickleavestatus","routeSlug":"/openapi/absence/reportsickleavestatus","metadata":{"seo":{"title":"Report sick leave status","description":"Requires scope: absence."}},"httpPath":"/api/absence/v3/sick-leave/{sickLeaveRegistrationId}/status"},{"type":"separator","label":"Webhooks","variant":"secondary"},{"label":"Sick leave registration event","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/openapi/absence/sickleaveregistrationevent","routeSlug":"/openapi/absence/sickleaveregistrationevent","metadata":{"seo":{"title":"Sick leave registration event","description":"Webhook, Dyflexis sends this POST request to a URL you host. See the Webhooks guide for how to register your receiver and what it must return."}},"httpPath":"sickLeaveRegistration"}]},{"type":"separator","label":"Employment agency"},{"type":"group","label":"Employment agency","link":"/openapi/employment-agency","routeSlug":"/openapi/employment-agency","items":[{"label":"Submit a human resource","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/employment-agency/submithumanresource","routeSlug":"/openapi/employment-agency/submithumanresource","metadata":{"seo":{"title":"Submit a human resource","description":"Requires scope: setu."}},"httpPath":"/api/setu/1.4.1/humanResource"},{"label":"Submit an assignment","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/employment-agency/submitassignment","routeSlug":"/openapi/employment-agency/submitassignment","metadata":{"seo":{"title":"Submit an assignment","description":"Requires scope: setu."}},"httpPath":"/api/setu/1.4.1/assignment"},{"type":"separator","label":"Webhooks","variant":"secondary"},{"label":"Time card event","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/openapi/employment-agency/timecardevent","routeSlug":"/openapi/employment-agency/timecardevent","metadata":{"seo":{"title":"Time card event","description":"Webhook, Dyflexis sends this POST request to a URL you host. See the Webhooks guide for how to register your receiver and what it must return."}},"httpPath":"timeCard"}]}]}