--- title: "List Availabilities" method: GET path: "/v2/company/{company_id}/availabilities" tags: ["Availability"] --- # List Availabilities `GET /v2/company/{company_id}/availabilities` ## Path parameters - `company_id` integer, required ## Query parameters - `cursor` string - `limit` integer - `location_id` integer - `user_id` integer - `status` integer - `repeating` boolean - `week_gte` string — A date with YYYY-MM-DD format - `week_to_include_repeating_gte` string — A date with YYYY-MM-DD format - `order_field` string - `order_dir` string ## Headers - `x-api-version` string — An API version - `x-company-guid` string, uuid ## Response `200` Success - object - `object` 'availability', required - `data` object[], required - `id` integer, required — Availability ID - `user_id` integer, required — User ID - `company_id` integer, required — Company ID - `week` string, nullable, required — Week date of the availability - `week_to` string, nullable, required — Week to date of the availability - `repeat` boolean, required — If true, availability is repeating - `status` integer, required — Indicates the status of the availability - `status_action_user_id` integer, nullable, required — The user ID of the user that approved/declined the availability - `status_action_message` string, nullable, required — The message when the availability was approved/declined - `mon` integer, required — The availability status for the day - `mon_from` string, time, required — The start time of the availability for the day - `mon_to` string, time, required — The end time of the availability for the day - `mon_comments` string, nullable, required — Comments included in the days availability - `mon_reason` string, required — The reason ID for the day - `tue` integer, required — The availability status for the day - `tue_from` string, time, required — The start time of the availability for the day - `tue_to` string, time, required — The end time of the availability for the day - `tue_comments` string, nullable, required — Comments included in the days availability - `tue_reason` string, required — The reason ID for the day - `wed` integer, required — The availability status for the day - `wed_from` string, time, required — The start time of the availability for the day - `wed_to` string, time, required — The end time of the availability for the day - `wed_comments` string, nullable, required — Comments included in the days availability - `wed_reason` string, required — The reason ID for the day - `thu` integer, required — The availability status for the day - `thu_from` string, time, required — The start time of the availability for the day - `thu_to` string, time, required — The end time of the availability for the day - `thu_comments` string, nullable, required — Comments included in the days availability - `thu_reason` string, required — The reason ID for the day - `fri` integer, required — The availability status for the day - `fri_from` string, time, required — The start time of the availability for the day - `fri_to` string, time, required — The end time of the availability for the day - `fri_comments` string, nullable, required — Comments included in the days availability - `fri_reason` string, required — The reason ID for the day - `sat` integer, required — The availability status for the day - `sat_from` string, time, required — The start time of the availability for the day - `sat_to` string, time, required — The end time of the availability for the day - `sat_comments` string, nullable, required — Comments included in the days availability - `sat_reason` string, required — The reason ID for the day - `sun` integer, required — The availability status for the day - `sun_from` string, time, required — The start time of the availability for the day - `sun_to` string, time, required — The end time of the availability for the day - `sun_comments` string, nullable, required — Comments included in the days availability - `sun_reason` string, required — The reason ID for the day - `created` string, nullable, required — The created date of the shift in UTC - `modified` string, nullable, required — The last modified date of the shift in UTC - `old_approved_data` object, nullable - `id` integer, required — Availability ID - `user_id` integer, required — User ID - `company_id` integer, required — Company ID - `week` string, nullable, required — Week date of the availability - `week_to` string, nullable, required — Week to date of the availability - `repeat` boolean, required — If true, availability is repeating - `status` integer, required — Indicates the status of the availability - `mon` integer, required — The availability status for the day - `mon_from` string, time, required — The start time of the availability for the day - `mon_to` string, time, required — The end time of the availability for the day - `mon_comments` string, nullable, required — Comments included in the days availability - `mon_reason` string, required — The reason ID for the day - `tue` integer, required — The availability status for the day - `tue_from` string, time, required — The start time of the availability for the day - `tue_to` string, time, required — The end time of the availability for the day - `tue_comments` string, nullable, required — Comments included in the days availability - `tue_reason` string, required — The reason ID for the day - `wed` integer, required — The availability status for the day - `wed_from` string, time, required — The start time of the availability for the day - `wed_to` string, time, required — The end time of the availability for the day - `wed_comments` string, nullable, required — Comments included in the days availability - `wed_reason` string, required — The reason ID for the day - `thu` integer, required — The availability status for the day - `thu_from` string, time, required — The start time of the availability for the day - `thu_to` string, time, required — The end time of the availability for the day - `thu_comments` string, nullable, required — Comments included in the days availability - `thu_reason` string, required — The reason ID for the day - `fri` integer, required — The availability status for the day - `fri_from` string, time, required — The start time of the availability for the day - `fri_to` string, time, required — The end time of the availability for the day - `fri_comments` string, nullable, required — Comments included in the days availability - `fri_reason` string, required — The reason ID for the day - `sat` integer, required — The availability status for the day - `sat_from` string, time, required — The start time of the availability for the day - `sat_to` string, time, required — The end time of the availability for the day - `sat_comments` string, nullable, required — Comments included in the days availability - `sat_reason` string, required — The reason ID for the day - `sun` integer, required — The availability status for the day - `sun_from` string, time, required — The start time of the availability for the day - `sun_to` string, time, required — The end time of the availability for the day - `sun_comments` string, nullable, required — Comments included in the days availability - `sun_reason` string, required — The reason ID for the day - `created` string, date-time, nullable, required — The created date of the shift in UTC - `meta` object, required - `cursor` object, required - `current` string, nullable, required — The current cursor. - `prev` string, nullable, required — A cursor for navigating to the previous page. - `next` string, nullable, required — A cursor for navigating to the next page. - `count` integer, nullable, required — The total items in the current cursor. ## Other responses - `400` — Bad Request - `401` — Unauthorized - `403` — Forbidden --- [API](https://skmtc.net/7shifts/apis/7shifts-api.md) · [All operations](https://skmtc.net/7shifts/apis/7shifts-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/7shifts/7shifts-api/revisions/96a02ef888ab/schema)