> ## Documentation Index > Fetch the complete documentation index at: https://docs.flowpayroll.ai/llms.txt > Use this file to discover all available pages before exploring further. # Get the organisation's default working pattern and qualifying-day policy ## OpenAPI ````yaml /api-reference/specs/pay-api.yaml get /organisation/working-pattern-defaults openapi: 3.0.3 info: title: FlowPayroll API description: >- API for payroll management, including payroll upload, lock, HMRC submission, employee management version: 0.1.0 servers: - url: https://api.sandbox.flowpayroll.ai/v1 security: - XAuthToken: [] XOrgId: [] tags: - name: Employees description: >- Create, retrieve, update, and delete employee records, and look them up by NI number or payroll ID. - name: Starters & leavers description: Set and clear starter and leaver details, individually or in bulk. - name: Tax codes description: >- Manage employee tax codes and query the effective tax code and NI category on a given date. - name: NI & identifiers description: Manage NI categories, National Insurance numbers, and payroll IDs. - name: Student loans description: Start and end student and postgraduate loans. - name: Payroll setup description: Assign an employee's payroll config and set opening balances. - name: Payroll - name: Payroll lines - name: PayrollConfig - name: Pay Elements - name: Calculator - name: Payslip - name: RTI - name: YearEnd - name: Organisation paths: /organisation/working-pattern-defaults: get: tags: - Organisation summary: Get the organisation's default working pattern and qualifying-day policy operationId: GetOrganisationWorkingPatternDefaults responses: '200': description: Working pattern defaults retrieved successfully content: application/json: schema: type: object allOf: - $ref: '#/components/schemas/ResponseBody' - properties: content: type: object properties: data: $ref: '#/components/schemas/WorkingPatternDefaultsDto' '500': description: An internal server error occurred content: application/json: schema: $ref: '#/components/schemas/ResponseBody' components: schemas: ResponseBody: type: object properties: message: $ref: '#/components/schemas/MessageWithTokenResponse' content: type: object properties: data: type: object nullable: true metadata: type: object nullable: true properties: dateFormat: type: string default: yyyy-MM-dd dateTimeFormat: type: string default: yyyy-MM-ddTHH:mm:ss.fffZ paginationToken: type: string nullable: true validationIssues: type: array items: $ref: '#/components/schemas/ValidationIssue' messageToken: type: string WorkingPatternDefaultsDto: type: object description: >- A default working pattern and SSP qualifying-day policy, used at organisation and payroll-config scope as a fallback for employees with no pattern of their own. properties: defaultWorkingDays: $ref: '#/components/schemas/WorkingDaysConfigurationDto' qualifyingDayMode: type: string enum: - DeriveFromPattern - AgreedFixedDays - WednesdayDefault default: DeriveFromPattern agreedQualifyingDays: $ref: '#/components/schemas/StandardWorkingDaysDto' MessageWithTokenResponse: type: object properties: text: type: string token: type: string tokenArguments: type: array items: $ref: '#/components/schemas/ValidationIssueArgument' ValidationIssue: type: object description: > Field validation item. `reasonToken` is a stable snake_case key for i18n or custom client messages; `reason` is the default English text from the API. properties: field: type: string description: Dot-path of the field (e.g. name.firstName, address.line1). reason: type: string description: Default human-readable message. reasonToken: type: string description: Machine-readable error identifier (snake_case). reasonTokenArguments: type: array nullable: true items: $ref: '#/components/schemas/ValidationIssueArgument' WorkingDaysConfigurationDto: type: object description: Configuration of employee's working days properties: standardWorkingDays: $ref: '#/components/schemas/StandardWorkingDaysDto' description: Standard working days configuration example: monday: true tuesday: true wednesday: true thursday: true friday: true saturday: false sunday: false shiftPattern: $ref: '#/components/schemas/ShiftPatternDto' description: Shift pattern configuration (if applicable) example: rotationStartDate: '2024-01-01' shifts: - name: Morning Shift workingDays: monday: true tuesday: true wednesday: true thursday: true friday: true saturday: false sunday: false durationInDays: 5 weekNumber: 1 - name: Night Shift workingDays: monday: true tuesday: true wednesday: true thursday: true friday: true saturday: false sunday: false durationInDays: 5 weekNumber: 2 patternType: FourOnFourOff patternWeeks: 8 workingPattern: type: string description: Type of working pattern enum: - Standard - Shift - Explicit default: Standard example: Standard explicitSchedule: $ref: '#/components/schemas/ExplicitScheduleDto' description: >- Explicit week-by-week schedule, used when workingPattern is "Explicit" StandardWorkingDaysDto: type: object description: Standard working days configuration properties: monday: type: boolean description: Whether Monday is a working day example: true tuesday: type: boolean description: Whether Tuesday is a working day example: true wednesday: type: boolean description: Whether Wednesday is a working day example: true thursday: type: boolean description: Whether Thursday is a working day example: true friday: type: boolean description: Whether Friday is a working day example: true saturday: type: boolean description: Whether Saturday is a working day example: false sunday: type: boolean description: Whether Sunday is a working day example: false ValidationIssueArgument: type: object properties: name: type: string value: type: string ShiftPatternDto: type: object description: Configuration for shift-based working patterns required: - rotationStartDate - shifts properties: rotationStartDate: type: string format: date description: The date when the shift pattern rotation begins example: '2024-01-01' shifts: type: array description: List of shifts in the pattern items: $ref: '#/components/schemas/ShiftDto' example: - name: Morning Shift workingDays: monday: true tuesday: true wednesday: true thursday: true friday: true saturday: false sunday: false durationInDays: 5 weekNumber: 1 - name: Night Shift workingDays: monday: true tuesday: true wednesday: true thursday: true friday: true saturday: false sunday: false durationInDays: 5 weekNumber: 2 patternType: type: string description: Type of shift pattern enum: - Custom - FourFourFive - FourOnFourOff - ThreeOnThreeOff - TwoOnTwoOff - FiveOnTwoOff default: Custom example: FourOnFourOff patternWeeks: type: integer description: Number of weeks the rota repeats over (1 to 53) default: 1 example: 8 ExplicitScheduleDto: type: object description: >- An explicit, week-by-week schedule for irregular workers whose pattern does not repeat. properties: weeks: type: array items: $ref: '#/components/schemas/ScheduledWeekDto' ShiftDto: type: object description: Configuration for a single shift in a shift pattern required: - name - workingDays properties: name: type: string description: Name of the shift example: Morning Shift workingDays: $ref: '#/components/schemas/StandardWorkingDaysDto' description: Working days configuration for this shift durationInDays: type: integer description: Number of days this shift lasts default: 1 example: 5 weekNumber: type: integer description: Week number in the pattern when this shift occurs default: 1 example: 1 ScheduledWeekDto: type: object description: The working days for a single calendar week within an explicit schedule. properties: weekCommencing: type: string description: >- The date this week starts on (any weekday; a 7-day block). Format YYYY-MM-DD. example: '2026-07-06' workingDays: $ref: '#/components/schemas/StandardWorkingDaysDto' securitySchemes: XAuthToken: type: apiKey in: header name: X-Auth-Token description: Access token obtained from OAuth2 client credentials flow XOrgId: type: apiKey in: header name: X-Org-Id description: >- Organisation to scope the request to. Required when the principal can access more than one organisation; optional for single-organisation principals (the authorizer resolves it automatically). ````