---
title: "Get weekdays availabilities"
method: POST
path: "/v1/public/availabilities/weekdays/get"
tags: ["Public", "Availabilities"]
---

# Get weekdays availabilities

`POST /v1/public/availabilities/weekdays/get`

## Request

- Base URL: `https://api.evolia.com`
- URL: `https://api.evolia.com/v1/public/availabilities/weekdays/get`
- Auth: HTTP basic
- TypeScript: <https://skmtc.dev/evolia/apis/public-evolia/docs/v1/public/availabilities/weekdays/get/post.ts> (a function with typed inputs; its response is checked against the schema)

## Request body

- GetDayAvailabilitiesRequest
  - `sort` object: Sort field. Use 0 for ASC and -1 for DESC.
  - `q` string: Search field, search trough fName, lName, email, phone or code member fields
  - `forMemberIds` string[]: If specified, use this array of member UIDs to only get availabilities linked to those members
  - `forTeamIds` string[]: If specified, use this array of team UIDs to only get member availabilities linked to those teams
  - `forLocationIds` string[]: If specified, use this array of location UIDs to only get member availabilities linked to those locations
  - `forSkillIds` string[]: If specified, use this array of skill UIDs to only get member availabilities linked to those skills
  - `skip` number: Skips over the specified number of items.
  - `take` number: Limits the number of items.
  - `from` number: Timestamp, Get all availabilities from the specified date.
  - `to` number: Timestamp, Get all availabilities to the specified date.
  - `approvalStatus` 'needs_approval' | 'approved' | 'refused': Filter by availability approval status.
  - `includeRelationships` boolean

## Response `200`

- PublicDayAvailability[]
  - `uid` string, required: Availability UID.
  - `allowReplacementsOutsideAvailabilities` boolean: Allow replacements outside availability.
  - `approval` Approval, required
    - `status` string, required: Approval status. NEEDS_APPROVAL, APPROVED or REFUSED
    - `approverId` string, required: Member uid who approved the availability.
    - `refuserId` string, required: Member uid who refused the availability.
    - `approverCode` string, required: Member code who approved the availability.
    - `createdAt` number, required: Creation date of the approval.
    - `updatedAt` number, required: Updated date of the approval.
    - `updatedByMemberId` string, required: Member uid who updated the approval.
    - `updatedByMemberCode` string, required: Member code who updated the approval.
    - `reason` string, required: Reason for unapproved availability.
  - `createdAt` number, required: Availability creation date.
  - `createdByMemberId` string, required: Member uid who created the availability
  - `createdByMemberCode` string, required: Member code who created the availability
  - `fromDate` number: Effective date from. Format: unix timestamp in milliseconds.
  - `groupId` string, required: The group UID linked to this availability.
  - `memberId` string, required: The member UID linked to this availability.
  - `memberCode` string, required: The member code linked to this availability.
  - `note` string, required: Note linked to this availability.
  - `preferredLocationIds` string[]: Array of member's preferred location ids.
  - `preferredLocationCodes` string[]: Array of member's preferred location codes.
  - `preferredMaxHoursPerPayPeriod` number: Maximum number of hours per pay period. Max: 168.
  - `preferredMaxHoursPerWeek` number: Maximum number of hours per week. Max: 168.
  - `preferredMaxRestingHours` number: Maximum hours between shifts.
  - `preferredMaxShiftsPerDay` number: Maximum number of shifts per day.
  - `preferredMaxShiftsPerWeek` number: Maximum number of shifts per week.
  - `preferredMaxWeekDays` number: Maximum number of weekdays. Max: 5.
  - `preferredMaxWeekendDays` number: Maximum number of weekend days. Max: 2.
  - `preferredMinHoursPerWeek` number: Minimum number of hours per week. Max: 168.
  - `preferredSkillIds` string[]: Array of member's preferred skill ids.
  - `preferredSkillCodes` string[]: Array of member's preferred skill codes.
  - `preferredTeamIds` string[]: Array of member's preferred team ids.
  - `preferredTeamCodes` string[]: Array of member's preferred team codes.
  - `toDate` number: Effective date to. Format: unix timestamp in milliseconds.
  - `days` DayAvailabilityDetail[]: Array of DayAvailabilityDetail
  - `preferredTeams` SimplifiedTeam[]: Array of preferredTeams if includeRelationships is true.
    - `_id` string, required: Team UID.
    - `names` object, required: the name of the team in various locales. Accepted locales are en, fr, es
    - `code` string, required: Team code.
  - `preferredSkills` SimplifiedSkill[]: Array of preferredSkills if includeRelationships is true.
    - `_id` string, required: Skill UID.
    - `names` object, required: the name of the skill in various locales. Accepted locales are en, fr, es
    - `code` string, required: Skill code.
  - `preferredLocations` SimplifiedLocation[]: Array of preferredLocations if includeRelationships is true.
    - `_id` string, required: Location UID.
    - `locData` LocData, required
      - `abbrev` string, required: Location abbreviation.
      - `code` string, required: Location code.
      - `name` string, required: Location name.
      - `address` string, required: Location address.
      - `geo` object, required: Geolocation

---

[API](https://skmtc.dev/evolia/apis/public-evolia.md) - [All operations](https://skmtc.dev/evolia/apis/public-evolia/llms.txt) - [OpenAPI document](https://skmtc.dev/evolia/apis/public-evolia/revisions/e42abb18d4b6?raw)