Availability
List Availabilities
get/v2/company/{company_id}/availabilities
Request
- Base URLhttps://api.7shifts.com
- Auth
- OAuth 2Authorization codehttps://app.7shifts.com/oauth2/authorizeClient credentialsPasswordToken URLhttps://app.7shifts.com/oauth2/token
- or API key in cookie 7session
- TypeScriptA function with typed inputs. Its response is checked against the schema.
Path parameters
company_idinteger required
Company ID
Query parameters
cursorstring
Cursor for the next or previous page of results.
limitinteger
The number results desired per page.
location_idinteger
Location ID
user_idinteger
User ID
statusinteger
Return availabilities for a specified status (pending = 0, approved = 1, declined = 2).
repeatingboolean
Return repeating or weekly availabilities.
week_gtestring
A date with YYYY-MM-DD format
Example:2020-01-01
Return availabilities for a specific week.
week_to_include_repeating_gtestring
A date with YYYY-MM-DD format
Example:2020-01-01
Return repeating availabilities that end before or on a specified week.
order_fieldstring
The field that availabilities will be sorted by.
order_dirstring
The direction that availabilities will be sorted by.
Headers
x-api-versionstring
An API version
Example:2022-05-01
7shifts API version
x-company-guidstring uuid
Company GUID
Response
Success
Changes
No recorded changes to this operation across all 2 revisions of this API.