# 7shifts API API

> 7shifts API API on Apizie: 138 endpoints (Create OAuth Token, Retrieve Identity, Create Trial Account, List Companies, …) returned as clean JSON through one API key. Send your own provider key in the x-upstream-key header. Call it over REST at https://apizie.tech/v1/business:7-shifts/{endpoint} or from Claude, ChatGPT and Cursor through the Apizie MCP server. Free plan: 1,000 requests a month.

- Project key: `business:7-shifts`
- Category: Business
- Status: byok
- Source: https://7shifts.com
- Page: https://apizie.tech/api/business/7-shifts
- OpenAPI: https://apizie.tech/api/business/7-shifts/openapi.json

7shifts is a team management software designed for restaurants. We help managers and operators spend less time and effort scheduling their staff, reduce their monthly labor costs and improve team communication. The…

## Endpoints

### Create OAuth Token
`POST https://apizie.tech/v1/business:7-shifts/authentication-generate-oauth-token` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| body | object | yes | Form fields as a JSON object |

### Retrieve Identity
`GET https://apizie.tech/v1/business:7-shifts/authentication-get-identity` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| x-api-version | string | no | 7shifts API version |
| x-company-guid | string | no | Company GUID |

### Create Trial Account
`POST https://apizie.tech/v1/business:7-shifts/account-create-trial-account` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| x-api-version | string | no | 7shifts API version |
| x-company-guid | string | no | Company GUID |
| body | object | yes | JSON request body |

### List Companies
`GET https://apizie.tech/v1/business:7-shifts/companies-list` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| x-api-version | string | no | 7shifts API version |
| x-company-guid | string | no | Company GUID |
| modified_since | string | no | Return companies that have been modified since the specified date. Format YYYY-MM-DD |

### Retrieve Company
`GET https://apizie.tech/v1/business:7-shifts/companies-get-by-id` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| x-api-version | string | no | 7shifts API version |
| x-company-guid | string | no | Company GUID |
| id | integer | yes | Company ID |

### Update Company
`POST https://apizie.tech/v1/business:7-shifts/companies-update-company-by-id` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| x-api-version | string | no | 7shifts API version |
| x-company-guid | string | no | Company GUID |
| id | integer | yes | Company ID |
| body | object | yes | JSON request body |

### Retrieve Labor Settings
`GET https://apizie.tech/v1/business:7-shifts/companies-get-labor-settings` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| x-api-version | string | no | 7shifts API version |
| x-company-guid | string | no | Company GUID |
| company_id | integer | yes | Company ID |

### List Inactive Reasons
`GET https://apizie.tech/v1/business:7-shifts/companies-list-inactive-reasons` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| x-api-version | string | no | 7shifts API version |
| x-company-guid | string | no | Company GUID |
| company_id | integer | yes | Company ID |

### List Locations
`GET https://apizie.tech/v1/business:7-shifts/locations-list-get` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| x-api-version | string | no | 7shifts API version |
| x-company-guid | string | no | Company GUID |
| company_id | integer | yes | Company ID |
| modified_since | string | no | Return locations that have been modified since the specified date. Format YYYY-MM-DD |
| deleted | boolean | no | When TRUE the search will return deleted locations |
| cursor | string | no | Cursor for the next or previous page of results. |
| limit | integer | no | The number of results desired per page. |

### Create Location
`POST https://apizie.tech/v1/business:7-shifts/locations-create` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| x-api-version | string | no | 7shifts API version |
| x-company-guid | string | no | Company GUID |
| company_id | integer | yes | Company ID |
| body | object | yes | JSON request body |

### Retrieve Location
`GET https://apizie.tech/v1/business:7-shifts/locations-get-location` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| x-api-version | string | no | 7shifts API version |
| x-company-guid | string | no | Company GUID |
| company_id | integer | yes | Company ID |
| location_id | integer | yes | Location ID |

### Update Location
`POST https://apizie.tech/v1/business:7-shifts/locations-update-location-by-id` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| x-api-version | string | no | 7shifts API version |
| x-company-guid | string | no | Company GUID |
| company_id | integer | yes | Company ID |
| location_id | integer | yes | Location ID |
| body | object | yes | JSON request body |

### Delete Location
`POST https://apizie.tech/v1/business:7-shifts/locations-remove-location-by-id` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| x-api-version | string | no | 7shifts API version |
| x-company-guid | string | no | Company GUID |
| company_id | integer | yes | Company ID |
| location_id | integer | yes | Location ID |

### List Departments
`GET https://apizie.tech/v1/business:7-shifts/departments-list` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| x-api-version | string | no | 7shifts API version |
| x-company-guid | string | no | Company GUID |
| company_id | integer | yes | Company ID |
| modified_since | string | no | Return departments that have been modified since the specified date. Format YYYY-MM-DD |
| cursor | string | no | Cursor for the next or previous page of results. |
| limit | integer | no | The number of results desired per page. |
| location_id | integer | no | Return departments that match the provided location ID |

### Create Department
`POST https://apizie.tech/v1/business:7-shifts/departments-create-new-department` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| x-api-version | string | no | 7shifts API version |
| x-company-guid | string | no | Company GUID |
| company_id | integer | yes | Company ID |
| body | object | yes | JSON request body |

### Retrieve Department
`GET https://apizie.tech/v1/business:7-shifts/departments-get-department` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| x-api-version | string | no | 7shifts API version |
| x-company-guid | string | no | Company GUID |
| company_id | integer | yes | Company ID |
| department_id | integer | yes | Department ID |

### Update Department
`POST https://apizie.tech/v1/business:7-shifts/departments-update-department` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| x-api-version | string | no | 7shifts API version |
| x-company-guid | string | no | Company GUID |
| company_id | integer | yes | Company ID |
| department_id | integer | yes | Department ID |
| body | object | yes | JSON request body |

### Delete Department
`POST https://apizie.tech/v1/business:7-shifts/departments-delete-by-id` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| x-api-version | string | no | 7shifts API version |
| x-company-guid | string | no | Company GUID |
| company_id | integer | yes | Company ID |
| department_id | integer | yes | Department ID |
| transfer_to | integer | no | Department ID to move roles and shifts to |

### List Roles
`GET https://apizie.tech/v1/business:7-shifts/roles-list` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| x-api-version | string | no | 7shifts API version |
| x-company-guid | string | no | Company GUID |
| company_id | integer | yes | Company ID |
| location_id | integer | no | Location ID |
| department_id | integer | no | Department ID |
| ids | array | no | Role IDs |
| modified_since | string | no | Return roles that have been modified since the specified date. Format YYYY-MM-DD |
| cursor | string | no | Cursor for the next or previous page of results. |
| limit | integer | no | The number of results desired per page. |

### Create Role
`POST https://apizie.tech/v1/business:7-shifts/roles-create-role` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| x-api-version | string | no | 7shifts API version |
| x-company-guid | string | no | Company GUID |
| company_id | integer | yes | The company id |
| body | object | yes | JSON request body |

### Retrieve Role
`GET https://apizie.tech/v1/business:7-shifts/roles-get-role` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| x-api-version | string | no | 7shifts API version |
| x-company-guid | string | no | Company GUID |
| company_id | integer | yes | Company ID |
| role_id | integer | yes | Role ID |

### Update Role
`POST https://apizie.tech/v1/business:7-shifts/roles-update-role-by-id` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| x-api-version | string | no | 7shifts API version |
| x-company-guid | string | no | Company GUID |
| company_id | integer | yes | Company ID |
| role_id | integer | yes | Role ID |
| body | object | yes | JSON request body |

### Delete Role
`POST https://apizie.tech/v1/business:7-shifts/roles-delete-role` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| x-api-version | string | no | 7shifts API version |
| x-company-guid | string | no | Company GUID |
| company_id | integer | yes | Company ID |
| role_id | integer | yes | Role ID |

### List Users
`GET https://apizie.tech/v1/business:7-shifts/users-list` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| x-api-version | string | no | 7shifts API version |
| x-company-guid | string | no | Company GUID |
| company_id | integer | yes | Company ID |
| modified_since | string | no | Return users that have been modified since the specified date. Format YYYY-MM-DD |
| location_id | integer | no | Location ID (cannot be used in conjunction with Department ID and Role ID) |
| department_id | integer | no | Department ID (cannot be used in conjunction with Location ID and Role ID) |
| role_id | integer | no | Role ID (cannot be used in conjunction with Location ID and Department ID) |
| status | string | no | The user status |
| name | string | no | Filter by partial or full employee name |
| sort_by | string | no | Sort the paginated result by the given field and direction. |
| cursor | string | no | Cursor for the next or previous page of results. |
| limit | integer | no | The number of results desired per page. |

### Create User
`POST https://apizie.tech/v1/business:7-shifts/users-create-new-user` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| x-api-version | string | no | 7shifts API version |
| x-company-guid | string | no | Company GUID |
| company_id | integer | yes | Company ID |
| body | object | yes | JSON request body |

### Create Many Users
`POST https://apizie.tech/v1/business:7-shifts/users-bulk-create` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| x-api-version | string | no | 7shifts API version |
| x-company-guid | string | no | Company GUID |
| company_id | integer | yes | Company ID |
| body | object | yes | JSON request body |

### Retrieve User
`GET https://apizie.tech/v1/business:7-shifts/users-get-user-by-identifier` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| x-api-version | string | no | 7shifts API version |
| x-company-guid | string | no | Company GUID |
| company_id | integer | yes | Company ID |
| identifier | string | yes | User ID. Accepted values are 7shifts user id or punch id. Use prefix punch: for punch id |

### Update User
`POST https://apizie.tech/v1/business:7-shifts/users-update-user-by-identifier` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| x-api-version | string | no | 7shifts API version |
| x-company-guid | string | no | Company GUID |
| company_id | integer | yes | Company ID |
| identifier | integer | yes | User ID |
| body | object | yes | JSON request body |

### Deactivate User
`POST https://apizie.tech/v1/business:7-shifts/users-deactivate` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| x-api-version | string | no | 7shifts API version |
| x-company-guid | string | no | Company GUID |
| company_id | integer | yes | Company ID |
| identifier | integer | yes | User ID |
| body | object | no | JSON request body |

### List User Wages
`GET https://apizie.tech/v1/business:7-shifts/user-wages-list` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| x-api-version | string | no | 7shifts API version |
| x-company-guid | string | no | Company GUID |
| company_id | integer | yes | Company ID |
| user_id | integer | yes | User ID |

### Create User Wage
`POST https://apizie.tech/v1/business:7-shifts/user-wages-create` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| x-api-version | string | no | 7shifts API version |
| x-company-guid | string | no | Company GUID |
| company_id | integer | yes | Company ID |
| user_id | integer | yes | User ID |
| body | object | yes | JSON request body |

### List Assignments
`GET https://apizie.tech/v1/business:7-shifts/user-assignments-list` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| x-api-version | string | no | 7shifts API version |
| x-company-guid | string | no | Company GUID |
| company_id | integer | yes | Company ID |
| user_id | integer | yes | User ID |

### List Location Assignments
`GET https://apizie.tech/v1/business:7-shifts/user-assignments-list-location-assignments` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| x-api-version | string | no | 7shifts API version |
| x-company-guid | string | no | Company GUID |
| company_id | integer | yes | Company ID |
| user_id | integer | yes | User ID |

### Create Location Assignments
`POST https://apizie.tech/v1/business:7-shifts/user-assignments-create-location-assignment` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| x-api-version | string | no | 7shifts API version |
| x-company-guid | string | no | Company GUID |
| company_id | integer | yes | Company ID |
| user_id | integer | yes | User ID |
| body | object | yes | JSON request body |

### Delete Location Assignment
`POST https://apizie.tech/v1/business:7-shifts/user-assignments-remove-location-assignment` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| x-api-version | string | no | 7shifts API version |
| x-company-guid | string | no | Company GUID |
| company_id | integer | yes | Company ID |
| user_id | integer | yes | User ID |
| location_id | integer | yes | Location ID |

### List Department Assignments
`GET https://apizie.tech/v1/business:7-shifts/user-assignments-list-department-assignments` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| x-api-version | string | no | 7shifts API version |
| x-company-guid | string | no | Company GUID |
| company_id | integer | yes | Company ID |
| user_id | integer | yes | User ID |

### Create Department Assignment
`POST https://apizie.tech/v1/business:7-shifts/user-assignments-create-department-assignment` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| x-api-version | string | no | 7shifts API version |
| x-company-guid | string | no | Company GUID |
| company_id | integer | yes | Company ID |
| user_id | integer | yes | User ID |
| body | object | yes | JSON request body |

### Delete Department Assignment
`POST https://apizie.tech/v1/business:7-shifts/user-assignments-remove-department-assignment` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| x-api-version | string | no | 7shifts API version |
| x-company-guid | string | no | Company GUID |
| company_id | integer | yes | Company ID |
| user_id | integer | yes | User ID |
| department_id | integer | yes | Department ID |

### List Role Assignments
`GET https://apizie.tech/v1/business:7-shifts/user-assignments-list-role-assignments` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| x-api-version | string | no | 7shifts API version |
| x-company-guid | string | no | Company GUID |
| company_id | integer | yes | Company ID |
| user_id | integer | yes | User ID |

### Create Role Assignment
`POST https://apizie.tech/v1/business:7-shifts/user-assignments-create-role-assignment` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| x-api-version | string | no | 7shifts API version |
| x-company-guid | string | no | Company GUID |
| company_id | integer | yes | Company ID |
| user_id | integer | yes | User ID |
| body | object | yes | JSON request body |

### Delete Role Assignment
`POST https://apizie.tech/v1/business:7-shifts/user-assignments-delete-role-assignment` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| x-api-version | string | no | 7shifts API version |
| x-company-guid | string | no | Company GUID |
| company_id | integer | yes | Company ID |
| user_id | integer | yes | User ID |
| role_id | integer | yes | Role ID |

### List Shifts
`GET https://apizie.tech/v1/business:7-shifts/shifts-list` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| x-api-version | string | no | 7shifts API version |
| x-company-guid | string | no | Company GUID |
| company_id | integer | yes | Company ID |
| cursor | string | no | Cursor for the next or previous page of results. |
| limit | integer | no | The number of results desired per page. |
| location_id | integer | no | Location ID |
| shift_ids | array | no | A comma separated list of Shift IDs |
| department_id | integer | no | Department ID |
| department_ids | array | no | Department IDs |
| role_id | integer | no | Role ID |
| user_id | integer | no | User ID |
| start[lte] | string | no | Return shifts that start before or on specified date. In ISO8601 Format |
| start[gte] | string | no | Return shifts that start after or on specified date time. In ISO8601 Format |
| end[lte] | string | no | Return shifts that end before or on specified date time. In ISO8601 Format |
| end[gte] | string | no | Return shifts that end after or on specified date time. In ISO8601 Format |
| deleted | boolean | no | Return shifts that were published and have been deleted. Cannot be combined with draft. |
| draft | boolean | no | Return shifts that are in draft. Draft shifts have created, edited or deleted but not been published. Overrides deleted flag. |
| include_draft | boolean | no | Return shifts that are published, and also shifts in draft. Overrides deleted flag and draft flag. |
| open | boolean | no | Return shifts that are open. Open shifts means anyone can request to take it and not assigned to any individual. |
| modified_since | string | no | Return only shifts that have been modified from specified date time. In ISO8601 Format |
| sort_by | string | no | Sort by either start or end |
| sort_dir | string | no | Sort by direction (asc, desc) |

### Create Shift
`POST https://apizie.tech/v1/business:7-shifts/shifts-create-new-shift` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| x-api-version | string | no | 7shifts API version |
| x-company-guid | string | no | Company GUID |
| company_id | integer | yes | Company ID |
| body | object | yes | JSON request body |

### Retrieve Shift
`GET https://apizie.tech/v1/business:7-shifts/shifts-get-shift-by-id` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| x-api-version | string | no | 7shifts API version |
| x-company-guid | string | no | Company GUID |
| company_id | integer | yes | Company ID |
| shift_id | integer | yes | Shift ID |
| include_deleted | boolean | no | Return the shift even if its deleted |

### Update Shift
`POST https://apizie.tech/v1/business:7-shifts/shifts-update-shift-by-id` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| x-api-version | string | no | 7shifts API version |
| x-company-guid | string | no | Company GUID |
| company_id | integer | yes | Company ID |
| shift_id | integer | yes | Shift ID |
| body | object | yes | JSON request body |

### Delete Shift
`POST https://apizie.tech/v1/business:7-shifts/shifts-delete-shift-by-id` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| x-api-version | string | no | 7shifts API version |
| x-company-guid | string | no | Company GUID |
| company_id | integer | yes | Company ID |
| shift_id | integer | yes | Shift ID |

### List Scheduled Shifts
`GET https://apizie.tech/v1/business:7-shifts/schedule-enforcement-list-scheduled-shifts` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| x-api-version | string | no | 7shifts API version |
| x-company-guid | string | no | Company GUID |
| company_id | integer | yes | Company ID |
| id | string | yes | Specified user_id of the user to check if scheduled. If the value begins with punch_id: then this specifies a user punch_id. |
| location_id | integer | yes | Location ID. |
| grace_period | integer | no | Grace period in minutes. |

### List Time Punches
`GET https://apizie.tech/v1/business:7-shifts/time-punches-list` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| x-api-version | string | no | 7shifts API version |
| x-company-guid | string | no | Company GUID |
| company_id | integer | yes | Company ID |
| location_id | integer | no | Location ID |
| department_id | integer | no | Department ID |
| role_id | integer | no | Role ID |
| user_id | integer | no | User ID |
| approved | boolean | no | Returns time punches that have been approved. Default null, returns both approved and unapproved punches. If true returns only approved… |
| limit | integer | no | The limit of results that will be returned. |
| modified_since | string | no | Return time punches that have been modified after the specified date time. UTC in ISO8601 Format |
| clocked_in[lte] | string | no | Return time punches with clocked in before or on the specified date. UTC in ISO8601 format |
| clocked_in[gte] | string | no | Return time punches with clocked in after or on the specified date. UTC in ISO8601 format |
| clocked_out[lte] | string | no | Return time punches with clocked out before or on the specified date. UTC in ISO8601 format |
| clocked_out[gte] | string | no | Return time punches with clocked out after or on the specified date. UTC in ISO8601 format |
| include_deleted | boolean | no | Deprecated, see 'deleted' |
| deleted | boolean | no | Returns punches filtered by deleted status. Default false, returns undeleted punches. If true returns only deleted punches. if value is… |
| localize_search_time | boolean | no | If true, convert any date ranges to consider the local timezone of the punches. If false, date ranges will be in UTC |
| cursor | string | no | Cursor for the next or previous page of results. |
| sort_by | string | no | The name of the field and direction you want the results ordered by. |

### Create Time Punch
`POST https://apizie.tech/v1/business:7-shifts/time-punches-create` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| x-api-version | string | no | 7shifts API version |
| x-company-guid | string | no | Company GUID |
| company_id | integer | yes | The company id |
| body | object | yes | JSON request body |

### Retrieve Time Punch
`GET https://apizie.tech/v1/business:7-shifts/time-punches-get-time-punch` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| x-api-version | string | no | 7shifts API version |
| x-company-guid | string | no | Company GUID |
| company_id | integer | yes | Company ID |
| time_punch_id | integer | yes | Time punch ID |

### Update Time Punch
`POST https://apizie.tech/v1/business:7-shifts/time-punches-update-by-id` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| x-api-version | string | no | 7shifts API version |
| x-company-guid | string | no | Company GUID |
| company_id | integer | yes | Company id |
| time_punch_id | integer | yes | Time punch id |
| body | object | yes | JSON request body |

### Delete Time Punch
`POST https://apizie.tech/v1/business:7-shifts/time-punches-delete-by-id` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| x-api-version | string | no | 7shifts API version |
| x-company-guid | string | no | Company GUID |
| company_id | integer | yes | Company ID |
| time_punch_id | integer | yes | Time punch ID |

### List Receipts
`GET https://apizie.tech/v1/business:7-shifts/receipts-list` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| x-api-version | string | no | 7shifts API version |
| x-company-guid | string | no | Company GUID |
| company_id | integer | yes | Company ID |
| location_id | integer | yes | Location ID |
| receipt_date[gte] | string | no | Return receipts that were created on or after a specific date |
| receipt_date[lte] | string | no | Return receipts that were created on or before a specific date |
| modified_since | string | no | Return receipts that were modified on or after a specific date |
| status | string | no | Filter receipts by status type |
| external_user_id | string | no | Filter receipts by external user id |
| cursor | string | no | An opaque cursor for the next or previous result set. |
| limit | integer | no | The number of results desired per page. |

### Create Receipt
`POST https://apizie.tech/v1/business:7-shifts/receipts-create-receipt` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| x-api-version | string | no | 7shifts API version |
| x-company-guid | string | no | Company GUID |
| company_id | integer | yes | Company ID |
| body | object | yes | JSON request body |

### Retrieve Receipt
`GET https://apizie.tech/v1/business:7-shifts/receipts-get-receipt` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| x-api-version | string | no | 7shifts API version |
| x-company-guid | string | no | Company GUID |
| company_id | integer | yes | Company ID |
| receipt_id | string | yes | Receipt UUID |

### Update Receipt
`POST https://apizie.tech/v1/business:7-shifts/receipts-update-receipt` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| x-api-version | string | no | 7shifts API version |
| x-company-guid | string | no | Company GUID |
| company_id | integer | yes | Company ID |
| receipt_id | string | yes | Receipt ID. Either 7shifts receipt UUID or a combination of the External ID of the sales receipt in your system and a Location ID.… |
| body | object | yes | JSON request body |

### Retrieve Receipts Summary
`GET https://apizie.tech/v1/business:7-shifts/receipts-get-summary` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| x-api-version | string | no | 7shifts API version |
| x-company-guid | string | no | Company GUID |
| company_id | integer | yes | Company ID |
| location_id | integer | yes | Location ID |
| receipt_date[gte] | string | no | Return receipts that were created on or after a specific date. Limit to 31-day range with receipt_date[lte]. |
| receipt_date[lte] | string | no | Return receipts that were created on or before a specific date. Limit to 31-day range with receipt_date[gte]. |
| modified_since | string | no | Return receipts that were modified on or after a specific date. Limited to past 30 days. |

### Retrieve User External Mapping
`GET https://apizie.tech/v1/business:7-shifts/external-user-mappings-get-mapping-by-id` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| x-api-version | string | no | 7shifts API version |
| x-company-guid | string | no | Company GUID |
| company_id | integer | yes | Company ID |
| identifier | string | yes | User ID. Accepted values are 7Shifts user id or external user id. Use prefix ext: for external id |
| location_id | integer | no | Location ID |

### Update External User Mappings
`POST https://apizie.tech/v1/business:7-shifts/external-user-mappings-update-mapping-by-identifier` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| x-api-version | string | no | 7shifts API version |
| x-company-guid | string | no | Company GUID |
| company_id | integer | yes | Company ID |
| identifier | string | yes | User ID. Accepted values are 7Shifts user id or external user id. Use prefix ext: for external id |
| location_id | integer | no | Location ID |
| body | object | no | JSON request body |

### Delete External User Mapping
`POST https://apizie.tech/v1/business:7-shifts/external-user-mappings-delete-mapping` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| x-api-version | string | no | 7shifts API version |
| x-company-guid | string | no | Company GUID |
| company_id | integer | yes | Company ID |
| identifier | string | yes | User ID. Accepted values are 7Shifts user id, external user id or user email address. Use prefix ext: for external id or email: for email… |
| location_id | integer | no | Location ID |

### List External User Mapping
`GET https://apizie.tech/v1/business:7-shifts/external-user-mappings-list` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| x-api-version | string | no | 7shifts API version |
| x-company-guid | string | no | Company GUID |
| company_id | integer | yes | Company ID |
| location_id | integer | no | Location ID |
| user_id | integer | no | The 7shifts user ID |
| external_user_id | string | no | The external user ID |
| modified_since | string | no | Return records that have been modified since the specified date. Format YYYY-MM-DD |
| cursor | string | no | Cursor for the next or previous page of results. |
| limit | integer | no | The number of results desired per page. |

### Create External User Mapping
`POST https://apizie.tech/v1/business:7-shifts/external-user-mappings-create-mapping` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| x-api-version | string | no | 7shifts API version |
| x-company-guid | string | no | Company GUID |
| company_id | integer | yes | Company ID |
| location_id | integer | no | Location ID |
| body | object | no | JSON request body |

### Create User External Mappings
`POST https://apizie.tech/v1/business:7-shifts/external-user-mappings-create-bulk-mappings` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| x-api-version | string | no | 7shifts API version |
| x-company-guid | string | no | Company GUID |
| company_id | integer | yes | Company ID |
| location_id | integer | no | Location ID |
| body | object | yes | JSON request body |

### List Events
`GET https://apizie.tech/v1/business:7-shifts/schedule-events-list-events` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| x-api-version | string | no | 7shifts API version |
| x-company-guid | string | no | Company GUID |
| company_id | integer | yes | Company ID |
| location_id | integer | no | Location ID |
| start_date | string | yes | A date string to request only events within a range. Format YYYY-MM-DD |
| end_date | string | yes | A date string to request only events within a range. Format YYYY-MM-DD |

### Create Event
`POST https://apizie.tech/v1/business:7-shifts/schedule-events-create-event` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| x-api-version | string | no | 7shifts API version |
| x-company-guid | string | no | Company GUID |
| company_id | integer | yes | Company ID |
| body | object | yes | JSON request body |

### Retrieve Event
`GET https://apizie.tech/v1/business:7-shifts/schedule-events-get-event-by-id` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| x-api-version | string | no | 7shifts API version |
| x-company-guid | string | no | Company GUID |
| company_id | integer | yes | Company ID |
| event_id | integer | yes | Event ID |

### Update Event
`POST https://apizie.tech/v1/business:7-shifts/schedule-events-update-event-by-id` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| x-api-version | string | no | 7shifts API version |
| x-company-guid | string | no | Company GUID |
| company_id | integer | yes | Company ID |
| event_id | integer | yes | Event ID |
| body | object | yes | JSON request body |

### Delete Event
`POST https://apizie.tech/v1/business:7-shifts/schedule-events-delete-event` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| x-api-version | string | no | 7shifts API version |
| x-company-guid | string | no | Company GUID |
| company_id | integer | yes | Company ID |
| event_id | integer | yes | Event ID |
| recurrence_target | string | no | Recurrence Target |
| start_date | string | no | Start of the targeted range for recurrence. Format YYYY-MM-DD HH:MM:SS |

### Gets task management settings for a company
`GET https://apizie.tech/v1/business:7-shifts/task-management-get-settings` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| x-api-version | string | no | 7shifts API version |
| company_id | integer | yes | Company ID |

### Create Task Tags
`POST https://apizie.tech/v1/business:7-shifts/task-management-create-task-tags` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| x-api-version | string | no | 7shifts API version |
| company_id | integer | yes | Company ID |
| body | object | yes | JSON request body |

### Delete Task Tags
`POST https://apizie.tech/v1/business:7-shifts/task-management-delete-task-tags` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| x-api-version | string | no | 7shifts API version |
| x-company-guid | string | no | Company GUID |
| company_id | integer | yes | Company ID |
| body | object | yes | JSON request body |

### Get task list templates
`GET https://apizie.tech/v1/business:7-shifts/task-management-get-task-list-templates` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| x-api-version | string | no | 7shifts API version |
| x-company-guid | string | no | Company GUID |
| company_id | integer | yes | Company ID |
| location_id | integer | no | Location ID |
| department_id | integer | no | Department ID |
| role_id | integer | no | Role ID |
| cursor | string | no | Cursor for the next or previous page of results. |
| limit | integer | no | The number of results desired per page. |

### Create Task List Template
`POST https://apizie.tech/v1/business:7-shifts/task-management-create-task-list-template` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| x-api-version | string | no | 7shifts API version |
| x-company-guid | string | no | Company GUID |
| company_id | integer | yes | Company ID |
| body | object | yes | JSON request body |

### Retrieve Task List Template
`GET https://apizie.tech/v1/business:7-shifts/task-management-get-task-list-template` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| x-api-version | string | no | 7shifts API version |
| company_id | integer | yes | Company ID |
| uuid | string | yes | Task List Template UUID |

### edit task list template
`POST https://apizie.tech/v1/business:7-shifts/task-management-edit-task-list-template` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| x-api-version | string | no | 7shifts API version |
| x-company-guid | string | no | Company GUID |
| company_id | integer | yes | Company ID |
| uuid | string | yes | Task List Template UUID |
| body | object | yes | JSON request body |

### Delete Task List Template
`POST https://apizie.tech/v1/business:7-shifts/task-management-delete-task-list-template` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| x-api-version | string | no | 7shifts API version |
| x-company-guid | string | no | Company GUID |
| company_id | integer | yes | Company ID |
| uuid | string | yes | Task List Template UUID |

### List Task Lists
`GET https://apizie.tech/v1/business:7-shifts/task-management-get-task-lists` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| x-api-version | string | no | 7shifts API version |
| x-company-guid | string | no | Company GUID |
| company_id | integer | yes | Company ID |
| user_id | integer | no | User ID |
| location_id | integer | no | Location ID |
| uuid | string | no | Task List Template UUID |
| active_on_date | string | no | Show only tasks lists that were active on a date (YYYY-MM-DD) |

### Retrieve Task List
`GET https://apizie.tech/v1/business:7-shifts/task-management-get-task-list` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| x-api-version | string | no | 7shifts API version |
| x-company-guid | string | no | Company GUID |
| company_id | integer | yes | Company ID |
| list_id | integer | yes | List ID |
| user_id | integer | no | User ID |

### Clear task
`POST https://apizie.tech/v1/business:7-shifts/task-management-clear-task` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| x-api-version | string | no | 7shifts API version |
| x-company-guid | string | no | Company GUID |
| company_id | integer | yes | Company ID |
| list_id | integer | yes | Task List ID |
| task_id | integer | yes | Task ID |
| body | object | yes | JSON request body |

### Complete Task
`POST https://apizie.tech/v1/business:7-shifts/task-management-mark-complete` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| x-api-version | string | no | 7shifts API version |
| x-company-guid | string | no | Company GUID |
| company_id | integer | yes | Company ID |
| list_id | integer | yes | Task List ID |
| task_id | integer | yes | Task ID |
| body | object | yes | JSON request body |

### List Task Lists Summary
`GET https://apizie.tech/v1/business:7-shifts/task-management-list-task-lists-summary` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| company_id | integer | yes | Company ID |
| location_id | integer | yes | Location ID |
| date | string | yes | Date of requested task lists |

### List Log Book Categories
`GET https://apizie.tech/v1/business:7-shifts/log-book-list-categories` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| x-api-version | string | no | 7shifts API version |
| x-company-guid | string | no | Company GUID |
| company_id | integer | yes | Company ID |

### Create Log Book Category
`POST https://apizie.tech/v1/business:7-shifts/log-book-create-category` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| x-api-version | string | no | 7shifts API version |
| x-company-guid | string | no | Company GUID |
| company_id | integer | yes | Company ID |
| body | object | yes | JSON request body |

### Update Log Book Category
`POST https://apizie.tech/v1/business:7-shifts/log-book-update-category-by-id` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| x-api-version | string | no | 7shifts API version |
| x-company-guid | string | no | Company GUID |
| company_id | integer | yes | Company ID |
| id | integer | yes | Category ID |
| body | object | yes | JSON request body |

### Delete Log Book Category
`POST https://apizie.tech/v1/business:7-shifts/log-book-delete-category-by-id` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| x-api-version | string | no | 7shifts API version |
| x-company-guid | string | no | Company GUID |
| company_id | integer | yes | Company ID |
| id | integer | yes | Category ID |

### List Log Book Posts
`GET https://apizie.tech/v1/business:7-shifts/log-book-list-posts` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| x-api-version | string | no | 7shifts API version |
| x-company-guid | string | no | Company GUID |
| company_id | integer | yes | Company ID |
| location_id | integer | no | Location ID |
| log_book_category_id | integer | no | Log Book Category ID |
| user_id | integer | no | Post Author User ID |
| date | string | no | Date of log book creation, format YYYY-MM-DD |
| posted_date_gte | string | no | List only log book posts from dates inclusive after, format YYYY-MM-DD |
| posted_date_lte | string | no | List only log book posts from dates inclusive before, format YYYY-MM-DD |
| message | string | no | List only posts containing the message |
| order_field | string | no | Order listed log book posts by a field |
| order_dir | string | no | Specified direction to order listed log book posts |
| cursor | string | no | Cursor for the next or previous page of results. |
| limit | integer | no | The number of results desired per page. |

### Create Log Book Post
`POST https://apizie.tech/v1/business:7-shifts/log-book-create-post` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| x-api-version | string | no | 7shifts API version |
| x-company-guid | string | no | Company GUID |
| company_id | integer | yes | Company ID |
| body | object | yes | JSON request body |

### Retrieve Log Book Post
`GET https://apizie.tech/v1/business:7-shifts/log-book-get-post` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| x-api-version | string | no | 7shifts API version |
| x-company-guid | string | no | Company GUID |
| company_id | integer | yes | Company ID |
| id | integer | yes | Log Book Post ID |

### Delete Log Book Post
`POST https://apizie.tech/v1/business:7-shifts/log-book-delete-post` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| x-api-version | string | no | 7shifts API version |
| x-company-guid | string | no | Company GUID |
| company_id | integer | yes | Company ID |
| id | integer | yes | Log Book Post ID |

### List Log Book Comments
`GET https://apizie.tech/v1/business:7-shifts/log-book-list-comments` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| x-api-version | string | no | 7shifts API version |
| x-company-guid | string | no | Company GUID |
| company_id | integer | yes | Company ID |
| log_book_ids | array | yes | Log book post id associated with log book comments |

### Create Log Book Comment
`POST https://apizie.tech/v1/business:7-shifts/log-book-create-comment` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| x-api-version | string | no | 7shifts API version |
| x-company-guid | string | no | Company GUID |
| company_id | integer | yes | Company ID |
| body | object | yes | JSON request body |

### Retrieve Log Book Comment
`GET https://apizie.tech/v1/business:7-shifts/log-book-get-comment` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| x-api-version | string | no | 7shifts API version |
| x-company-guid | string | no | Company GUID |
| company_id | integer | yes | Company ID |
| id | integer | yes | Log Book Comment ID |

### Delete Log Book Comment
`POST https://apizie.tech/v1/business:7-shifts/log-book-delete-comment` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| x-api-version | string | no | 7shifts API version |
| x-company-guid | string | no | Company GUID |
| company_id | integer | yes | Company ID |
| id | integer | yes | Log Book Comment ID |

### Retrieve Worked Hours & Wages
`GET https://apizie.tech/v1/business:7-shifts/reports-get-worked-hours-wages` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| x-api-version | string | no | 7shifts API version |
| x-company-guid | string | no | Company GUID |
| punches | boolean | yes | Whether or not to use the punch labour source |
| company_id | integer | yes | The company id to pull the report for. |
| from | string | yes | Starting date for which you want the report to start. |
| to | string | yes | Ending date for which you want the report to end. |
| location_id | integer | no | The location id for which you want the report for. |
| department_id | integer | no | The department id for the report. |
| role_id | integer | no | The role id for the report |
| user_id | integer | no | The user id the report should be fetched for - internal use only |

### Retrieve Daily Sales & Labor
`GET https://apizie.tech/v1/business:7-shifts/reports-get-daily-sales-and-labor` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| x-api-version | string | no | 7shifts API version |
| x-company-guid | string | no | Company GUID |
| start_date | string | yes | Starting date for which you want the daily sales and labor data for. |
| end_date | string | yes | Ending date for which you want the daily sales and labor data for. |
| location_id | integer | yes | Location ID |
| department_id | integer | no | Department ID |

### Retrieve Daily Stats
`GET https://apizie.tech/v1/business:7-shifts/reports-get-daily-stats` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| x-api-version | string | no | 7shifts API version |
| x-company-guid | string | no | Company GUID |
| company_id | integer | yes | Company ID |
| location_id | integer | yes | Location ID |
| department_id | integer | no | Department ID |
| date | string | yes | Date |
| include_future | boolean | no | include future |

### Create Daily Projected Forecast Override
`POST https://apizie.tech/v1/business:7-shifts/forecast-overrides-create-daily-projected-forecast-override` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| x-api-version | string | no | 7shifts API version |
| x-company-guid | string | no | Company GUID |
| company_id | integer | yes | Company ID |
| location_id | integer | yes | Location ID |
| body | object | no | JSON request body |

### Sync Daily Projected Forecast Override
`POST https://apizie.tech/v1/business:7-shifts/forecast-overrides-sync-projected-forecast-override` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| x-api-version | string | no | 7shifts API version |
| x-company-guid | string | no | Company GUID |
| company_id | integer | yes | Company ID |
| location_id | integer | yes | Location ID |
| body | object | no | JSON request body |

### Create Bulk Daily Projected Forecast Overrides
`POST https://apizie.tech/v1/business:7-shifts/forecast-overrides-bulk-create-projected-forecast-override` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| x-api-version | string | no | 7shifts API version |
| x-company-guid | string | no | Company GUID |
| company_id | integer | yes | Company ID |
| location_id | integer | yes | Location ID |
| body | object | yes | JSON request body |

### Create Interval Projected Forecast Override
`POST https://apizie.tech/v1/business:7-shifts/forecast-overrides-override-interval` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| x-api-version | string | no | 7shifts API version |
| x-company-guid | string | no | Company GUID |
| company_id | integer | yes | Company ID |
| location_id | integer | yes | Location ID |
| body | object | no | JSON request body |

### Sync Interval Projected Forecast Override
`POST https://apizie.tech/v1/business:7-shifts/forecast-overrides-sync-projected-sales-interval` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| x-api-version | string | no | 7shifts API version |
| x-company-guid | string | no | Company GUID |
| company_id | integer | yes | Company ID |
| location_id | integer | yes | Location ID |
| body | object | no | JSON request body |

### Create Bulk Daily Projected Forecast Overrides
`POST https://apizie.tech/v1/business:7-shifts/forecast-overrides-bulk-create-projected-sales-interval-over` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| x-api-version | string | no | 7shifts API version |
| x-company-guid | string | no | Company GUID |
| company_id | integer | yes | Company ID |
| location_id | integer | yes | Location ID |
| body | object | no | JSON request body |

### Gets tip pool settings for a company
`GET https://apizie.tech/v1/business:7-shifts/tip-pool-get-settings` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| x-api-version | string | no | 7shifts API version |
| x-company-guid | string | no | Company GUID |
| company_id | integer | yes | Company ID |

### Grabs manual entry tips for a tip pool
`GET https://apizie.tech/v1/business:7-shifts/tip-pool-get-manual-entry-tips` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| x-api-version | string | no | 7shifts API version |
| x-company-guid | string | no | Company GUID |
| company_id | integer | yes | The company ID for the target tip pool settings |
| tip_pool_settings_uuid | string | yes | The tip pool settings uuid |
| start_date | string | yes | The start date of the manual entry query range |
| end_date | string | yes | The end date of the manual entry query range |

### Saves manual entries for a tip pool
`POST https://apizie.tech/v1/business:7-shifts/tip-pool-save-manual-entry` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| x-api-version | string | no | 7shifts API version |
| x-company-guid | string | no | Company GUID |
| company_id | integer | yes | The company ID for the target tip pool settings |
| tip_pool_settings_uuid | string | yes | The tip pool settings uuid |
| body | object | yes | JSON request body |

### Retreive Tip Pool Summary Report
`GET https://apizie.tech/v1/business:7-shifts/tip-pool-get-summary-report` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| x-api-version | string | no | 7shifts API version |
| x-company-guid | string | no | Company GUID |
| company_id | integer | yes | Company ID |
| location_id | integer | yes | Location ID |
| tip_pool_uuid | string | no | The tip pool UUID, when omitted the report will return all tip pools |
| day_part_uuid | string | no | Daypart UUID, when omitted the report will return all dayparts |
| start_date | string | yes | The start date in YYYY-MM-DD format |
| end_date | string | yes | The end date in YYYY-MM-DD format |

### Retreive Tip Pool Detailed Report
`GET https://apizie.tech/v1/business:7-shifts/tip-pool-get-detailed-report` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| x-api-version | string | no | 7shifts API version |
| x-company-guid | string | no | Company GUID |
| company_id | integer | yes | Company ID |
| location_id | integer | yes | Location ID |
| tip_pool_uuid | string | no | The tip pool UUID, when omitted the report will return all tip pools |
| day_part_uuid | string | no | Daypart UUID, when omitted the report will return all dayparts |
| start_date | string | yes | The start date in YYYY-MM-DD format |
| end_date | string | yes | The end date in YYYY-MM-DD format |

### Retrieve day part settings
`GET https://apizie.tech/v1/business:7-shifts/day-part-get-settings` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| x-api-version | string | no | 7shifts API version |
| x-company-guid | string | no | Company GUID |
| company_id | integer | yes | Company ID |
| location_id | integer | no | Location ID - null will fetch all day parts for company |

### List Availabilities
`GET https://apizie.tech/v1/business:7-shifts/availability-list-availabilities` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| company_id | integer | yes | Company ID |
| cursor | string | no | Cursor for the next or previous page of results. |
| limit | integer | no | The number results desired per page. |
| location_id | integer | no | Location ID |
| user_id | integer | no | User ID |
| status | integer | no | Return availabilities for a specified status (pending = 0, approved = 1, declined = 2). |
| repeating | boolean | no | Return repeating or weekly availabilities. |
| week_gte | string | no | Return availabilities for a specific week. |
| week_to_include_repeating_gte | string | no | Return repeating availabilities that end before or on a specified week. |
| order_field | string | no | The field that availabilities will be sorted by. |
| order_dir | string | no | The direction that availabilities will be sorted by. |

### Create Availability
`POST https://apizie.tech/v1/business:7-shifts/availability-create-new` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| company_id | integer | yes | Company ID |
| body | object | yes | JSON request body |

### Retrieve Availability
`GET https://apizie.tech/v1/business:7-shifts/availability-get-by-id` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| company_id | integer | yes | Company ID |
| availability_id | integer | yes | Availability ID |

### Update Availability
`POST https://apizie.tech/v1/business:7-shifts/availability-update-by-id` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| company_id | integer | yes | Company ID |
| availability_id | integer | yes | Availability ID |
| body | object | yes | JSON request body |

### Delete Availability
`POST https://apizie.tech/v1/business:7-shifts/availability-remove-by-id` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| company_id | integer | yes | Company ID |
| availability_id | integer | yes | Availability ID |

### Update Availability Status
`POST https://apizie.tech/v1/business:7-shifts/availability-update-status` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| company_id | integer | yes | Company ID |
| availability_id | integer | yes | Availability ID |
| body | object | no | JSON request body |

### List Availability Reasons
`GET https://apizie.tech/v1/business:7-shifts/availability-list-reasons` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| x-api-version | string | no | 7shifts API version |
| x-company-guid | string | no | Company GUID |
| company_id | integer | yes | Company ID |
| cursor | string | no | Cursor for the next or previous page of results. |
| limit | integer | no | The number results desired per page. |

### Create Availability Reason
`POST https://apizie.tech/v1/business:7-shifts/availability-create-reason` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| x-api-version | string | no | 7shifts API version |
| x-company-guid | string | no | Company GUID |
| company_id | integer | yes | Company ID |
| body | object | yes | JSON request body |

### Update Availability Reason
`POST https://apizie.tech/v1/business:7-shifts/availability-update-reason-by-id` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| x-api-version | string | no | 7shifts API version |
| x-company-guid | string | no | Company GUID |
| company_id | integer | yes | Company ID |
| availability_reason_id | integer | yes | Availability Reason ID |
| body | object | yes | JSON request body |

### Delete Availability Reason
`POST https://apizie.tech/v1/business:7-shifts/availability-delete-reason` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| x-api-version | string | no | 7shifts API version |
| x-company-guid | string | no | Company GUID |
| company_id | integer | yes | Company ID |
| availability_reason_id | integer | yes | Availability Reason ID |

### List Time Off
`GET https://apizie.tech/v1/business:7-shifts/time-off-list` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| x-api-version | string | no | 7shifts API version |
| x-company-guid | string | no | Company GUID |
| company_id | integer | yes | Company ID |
| location_id | integer | no | Location ID |
| user_id | integer | no | User ID |
| status | integer | no | Status |
| category | string | no | Category |
| to_date_gte | string | no | Return time offs that end after a specified date. |
| sort_by | string | no | Sort by column |
| sort_dir | string | no | Sort by direction (asc, desc) |
| cursor | string | no | Cursor for the next or previous page of results. |
| limit | integer | no | The number of results desired per page. |

### Create time off
`POST https://apizie.tech/v1/business:7-shifts/time-off-create-request` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| x-api-version | string | no | 7shifts API version |
| x-company-guid | string | no | Company GUID |
| body | object | yes | JSON request body |

…and 18 more. See the OpenAPI spec.

## Example
```
curl "https://apizie.tech/v1/business:7-shifts/authentication-generate-oauth-token" \
  -H "x-api-key: $APIZIE_KEY" \
  -H "x-upstream-key: $PROVIDER_KEY"
```

## FAQ

### How do I call the 7shifts API API?
Create a free Apizie key, then send POST https://apizie.tech/v1/business:7-shifts/authentication-generate-oauth-token with the header x-api-key. Every endpoint returns { project, data, timestamp }.

### Is the 7shifts API API free on Apizie?
Yes. The Free plan includes 1,000 requests a month at 100 requests a minute, no credit card. 7shifts API itself also needs your own key from api.7shifts.com.

### Can AI agents use the 7shifts API API?
Yes. Add the Apizie MCP server (https://apizie.tech/mcp) to Claude, ChatGPT, Cursor or VS Code, then ask in plain language. The agent calls run_scraper with project key business:7-shifts.

### What is the status of the 7shifts API API?
Needs your own provider key (bring your own key)