API Usage

Introduction
Authentication
Errors
Versioning
Pagination
API Status & Support
Postman Collection

7shifts API

Authentication
- Create OAuth Tokenpost
- Retrieve Identityget
Account
- Create Trial Accountpost
Companies
Locations
Departments
Roles
Users
User Wages
- List User Wagesget
- Create User Wagepost
User Assignments
Shifts
Schedule Enforcement
- List Scheduled Shiftsget
Time Punches
Receipts
External User Mappings
Schedule Events
Task Management
Log Book
Reports
Forecast Overrides
Tip Pool
Day Part
- Retrieve day part settingsget
Availability
Time Off
Shift Feedback
- List Shift Feedbackget
Engage
- Retrieve Engagement Overviewget
Webhooks
Integration Mappings

Webhooks

Introduction
Configure Company Level Webhooks
payroll_period.closed
schedule.published
time_punch.created
time_punch.edited
time_punch.deleted
user.created
user.modified
user.deactivated
user.reactivated
department.created
department.modified
department.deleted
location.created
location.modified
location.deleted
role.created
role.modified
role.deleted
authorization.revoked

API Usage

Introduction
Authentication
Errors
Versioning
Pagination
API Status & Support
Postman Collection

7shifts API

Authentication
- Create OAuth Tokenpost
- Retrieve Identityget
Account
- Create Trial Accountpost
Companies
Locations
Departments
Roles
Users
User Wages
- List User Wagesget
- Create User Wagepost
User Assignments
Shifts
Schedule Enforcement
- List Scheduled Shiftsget
Time Punches
Receipts
External User Mappings
Schedule Events
Task Management
Log Book
Reports
Forecast Overrides
Tip Pool
Day Part
- Retrieve day part settingsget
Availability
Time Off
Shift Feedback
- List Shift Feedbackget
Engage
- Retrieve Engagement Overviewget
Webhooks
Integration Mappings

Webhooks

Introduction
Configure Company Level Webhooks
payroll_period.closed
schedule.published
time_punch.created
time_punch.edited
time_punch.deleted
user.created
user.modified
user.deactivated
user.reactivated
department.created
department.modified
department.deleted
location.created
location.modified
location.deleted
role.created
role.modified
role.deleted
authorization.revoked

Retrieve Engagement Overview

get https://api.7shifts.com/v2/company/{company_id}/locations/{location_id}/engage_overview

Beta

URL Expired

The URL for this request expired after 30 days.

Path Params

company_id

int64

required

Company ID

location_id

int64

required

Location ID

Query Params

date

string

required

A date with YYYY-MM-DD format

frequency

string

Length of the engage data set

user_type

string

select user type for engage data

Headers

x-api-version

string

7shifts API version

x-company-guid

string

Company GUID

Responses

Response body

object

string

required

engage_overview

data

object

required

location_stats

object

required

employee_stats

object

required

engagement_scores

object

required

shift_feedback

object

required

tenure

object

required

Response body

object

type

string

required

The primary identifier for the problem type (URI reference).

title

string

required

A short, human-readable summary of the problem type. It SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization.

status

integer

required

The HTTP status code.

detail

string

required

A human-readable explanation specific to this occurrence of the problem.

code

integer

The error code can be used to look up the reason why the request failed.

param

string

The request parameter that this error is related to.

Response body

object

type

string

required

The primary identifier for the problem type (URI reference).

title

string

required

A short, human-readable summary of the problem type. It SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization.

status

integer

required

The HTTP status code.

detail

string

required

A human-readable explanation specific to this occurrence of the problem.

code

integer

The error code can be used to look up the reason why the request failed.

param

string

The request parameter that this error is related to.

Response body

object

type

string

required

The primary identifier for the problem type (URI reference).

title

string

required

A short, human-readable summary of the problem type. It SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization.

status

integer

required

The HTTP status code.

detail

string

required

A human-readable explanation specific to this occurrence of the problem.

code

integer

The error code can be used to look up the reason why the request failed.

param

string

The request parameter that this error is related to.

Response body

object

type

string

required

The primary identifier for the problem type (URI reference).

title

string

required

A short, human-readable summary of the problem type. It SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization.

status

integer

required

The HTTP status code.

detail

string

required

A human-readable explanation specific to this occurrence of the problem.

code

integer

The error code can be used to look up the reason why the request failed.

param

string

The request parameter that this error is related to.

Updated over 1 year ago

List Shift Feedback

Webhooks

Did this page help you?

Language

Credentials

Bearer


xxxxxxxxxx
1
curl --request GET \
2
     --url https://api.7shifts.com/v2/company/company_id/locations/location_id/engage_overview \
3
     --header 'accept: application/json'

Click Try It! to start a request and see the response here! Or choose an example:

application/json

application/problem+json

Updated over 1 year ago

List Shift Feedback

Webhooks

Did this page help you?

API Usage
Introduction
Authentication
Errors
Versioning
Pagination
API Status & Support
Postman Collection

7shifts API
Authentication
Retrieve Identityget
Create OAuth Tokenpost
Account
Create Trial Accountpost
Companies
List Inactive Reasonsget
Retrieve Labor Settingsget
Update Companypatch
Retrieve Companyget
List Companiesget
Locations
Delete Locationdelete
Update Locationput
Retrieve Locationget
Create Locationpost
List Locationsget
Departments
Delete Departmentdelete
Update Departmentput
Retrieve Departmentget
Create Departmentpost
List Departmentsget
Roles
Delete Roledelete
Update Roleput
Retrieve Roleget
Create Rolepost
List Rolesget
Users
Deactivate Userdelete
Update Userput
Retrieve Userget
Create Many Userspost
Create Userpost
List Usersget
User Wages
Create User Wagepost
List User Wagesget
User Assignments
Delete Role Assignmentdelete
Create Role Assignmentpost
List Role Assignmentsget
Delete Department Assignmentdelete
Create Department Assignmentpost
List Department Assignmentsget
Delete Location Assignmentdelete
Create Location Assignmentspost
List Location Assignmentsget
List Assignmentsget
Shifts
Delete Shiftdelete
Update Shiftput
Retrieve Shiftget
Create Shiftpost
List Shiftsget
Schedule Enforcement
List Scheduled Shiftsget
Time Punches
Delete Time Punchdelete
Update Time Punchput
Retrieve Time Punchget
Create Time Punchpost
List Time Punchesget
Receipts
Retrieve Receipts Summaryget
Update Receiptput
Retrieve Receiptget
Create Receiptpost
List Receiptsget
External User Mappings
Create User External Mappingspost
Create External User Mappingpost
List External User Mappingget
Delete External User Mappingdelete
Update External User Mappingsput
Retrieve User External Mappingget
Schedule Events
Delete Eventdelete
Update Eventpatch
Retrieve Eventget
Create Eventpost
List Eventsget
Task Management
List Task Lists Summaryget
Complete Taskpost
Clear taskpost
Retrieve Task Listget
List Task Listsget
edit task list templateput
Delete Task List Templatedelete
Retrieve Task List Templateget
Create Task List Templatepost
Get task list templatesget
Delete Task Tagsdelete
Create Task Tagspost
Gets task management settings for a companyget
Log Book
Delete Log Book Commentdelete
Retrieve Log Book Commentget
Create Log Book Commentpost
List Log Book Commentsget
Delete Log Book Postdelete
Retrieve Log Book Postget
Create Log Book Postpost
List Log Book Postsget
Update Log Book Categorypatch
Delete Log Book Categorydelete
Create Log Book Categorypost
List Log Book Categoriesget
Reports
Retrieve Daily Statsget
Retrieve Daily Sales & Laborget
Retrieve Worked Hours & Wagesget
Forecast Overrides
Create Bulk Daily Projected Forecast Overridespost
Sync Interval Projected Forecast Overridedelete
Create Interval Projected Forecast Overridepost
Create Bulk Daily Projected Forecast Overridespost
Sync Daily Projected Forecast Overridedelete
Create Daily Projected Forecast Overridepost
Tip Pool
Retreive Tip Pool Detailed Reportget
Retreive Tip Pool Summary Reportget
Saves manual entries for a tip poolput
Grabs manual entry tips for a tip poolget
Gets tip pool settings for a companyget
Day Part
Retrieve day part settingsget
Availability
Delete Availability Reasondelete
Update Availability Reasonput
Create Availability Reasonpost
List Availability Reasonsget
Update Availability Statusput
Delete Availabilitydelete
Update Availabilityput
Retrieve Availabilityget
Create Availabilitypost
List Availabilitiesget
Time Off
Create Time Off Settingspost
Retrieve Time Off Settingsget
Retrieve Time Off Hoursget
Decline Time Off Requestpost
Approve Time Off Requestpost
Update Time Offpatch
Delete Time Offdelete
Retrieve Time Offget
Create time offpost
List Time Offget
Shift Feedback
List Shift Feedbackget
Engage
Retrieve Engagement Overviewget
Webhooks
Test Webhookget
Delete Webhookdelete
Update Webhookput
Create Webhookpost
List Webhooksget
Integration Mappings
Delete Sales Category Mappingsdelete
Create Sales Category Mappingspost
List Sales Category Mappingsget

Webhooks
Introduction
Configure Company Level Webhooks
payroll_period.closed
schedule.published
time_punch.created
time_punch.edited
time_punch.deleted
user.created
user.modified
user.deactivated
user.reactivated
department.created
department.modified
department.deleted
location.created
location.modified
location.deleted
role.created
role.modified
role.deleted
authorization.revoked

API Usage
Introduction
Authentication
Errors
Versioning
Pagination
API Status & Support
Postman Collection

7shifts API
Authentication
Retrieve Identityget
Create OAuth Tokenpost
Account
Create Trial Accountpost
Companies
List Inactive Reasonsget
Retrieve Labor Settingsget
Update Companypatch
Retrieve Companyget
List Companiesget
Locations
Delete Locationdelete
Update Locationput
Retrieve Locationget
Create Locationpost
List Locationsget
Departments
Delete Departmentdelete
Update Departmentput
Retrieve Departmentget
Create Departmentpost
List Departmentsget
Roles
Delete Roledelete
Update Roleput
Retrieve Roleget
Create Rolepost
List Rolesget
Users
Deactivate Userdelete
Update Userput
Retrieve Userget
Create Many Userspost
Create Userpost
List Usersget
User Wages
Create User Wagepost
List User Wagesget
User Assignments
Delete Role Assignmentdelete
Create Role Assignmentpost
List Role Assignmentsget
Delete Department Assignmentdelete
Create Department Assignmentpost
List Department Assignmentsget
Delete Location Assignmentdelete
Create Location Assignmentspost
List Location Assignmentsget
List Assignmentsget
Shifts
Delete Shiftdelete
Update Shiftput
Retrieve Shiftget
Create Shiftpost
List Shiftsget
Schedule Enforcement
List Scheduled Shiftsget
Time Punches
Delete Time Punchdelete
Update Time Punchput
Retrieve Time Punchget
Create Time Punchpost
List Time Punchesget
Receipts
Retrieve Receipts Summaryget
Update Receiptput
Retrieve Receiptget
Create Receiptpost
List Receiptsget
External User Mappings
Create User External Mappingspost
Create External User Mappingpost
List External User Mappingget
Delete External User Mappingdelete
Update External User Mappingsput
Retrieve User External Mappingget
Schedule Events
Delete Eventdelete
Update Eventpatch
Retrieve Eventget
Create Eventpost
List Eventsget
Task Management
List Task Lists Summaryget
Complete Taskpost
Clear taskpost
Retrieve Task Listget
List Task Listsget
edit task list templateput
Delete Task List Templatedelete
Retrieve Task List Templateget
Create Task List Templatepost
Get task list templatesget
Delete Task Tagsdelete
Create Task Tagspost
Gets task management settings for a companyget
Log Book
Delete Log Book Commentdelete
Retrieve Log Book Commentget
Create Log Book Commentpost
List Log Book Commentsget
Delete Log Book Postdelete
Retrieve Log Book Postget
Create Log Book Postpost
List Log Book Postsget
Update Log Book Categorypatch
Delete Log Book Categorydelete
Create Log Book Categorypost
List Log Book Categoriesget
Reports
Retrieve Daily Statsget
Retrieve Daily Sales & Laborget
Retrieve Worked Hours & Wagesget
Forecast Overrides
Create Bulk Daily Projected Forecast Overridespost
Sync Interval Projected Forecast Overridedelete
Create Interval Projected Forecast Overridepost
Create Bulk Daily Projected Forecast Overridespost
Sync Daily Projected Forecast Overridedelete
Create Daily Projected Forecast Overridepost
Tip Pool
Retreive Tip Pool Detailed Reportget
Retreive Tip Pool Summary Reportget
Saves manual entries for a tip poolput
Grabs manual entry tips for a tip poolget
Gets tip pool settings for a companyget
Day Part
Retrieve day part settingsget
Availability
Delete Availability Reasondelete
Update Availability Reasonput
Create Availability Reasonpost
List Availability Reasonsget
Update Availability Statusput
Delete Availabilitydelete
Update Availabilityput
Retrieve Availabilityget
Create Availabilitypost
List Availabilitiesget
Time Off
Create Time Off Settingspost
Retrieve Time Off Settingsget
Retrieve Time Off Hoursget
Decline Time Off Requestpost
Approve Time Off Requestpost
Update Time Offpatch
Delete Time Offdelete
Retrieve Time Offget
Create time offpost
List Time Offget
Shift Feedback
List Shift Feedbackget
Engage
Retrieve Engagement Overviewget
Webhooks
Test Webhookget
Delete Webhookdelete
Update Webhookput
Create Webhookpost
List Webhooksget
Integration Mappings
Delete Sales Category Mappingsdelete
Create Sales Category Mappingspost
List Sales Category Mappingsget

Webhooks
Introduction
Configure Company Level Webhooks
payroll_period.closed
schedule.published
time_punch.created
time_punch.edited
time_punch.deleted
user.created
user.modified
user.deactivated
user.reactivated
department.created
department.modified
department.deleted
location.created
location.modified
location.deleted
role.created
role.modified
role.deleted
authorization.revoked

200OK

400Not found

401Unauthorized

403Forbidden

500Server Error