API Usage

Introduction
Authentication
Errors
Versioning
Pagination
API Status
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
- Retrieve Worked Hours & Wagesget
- Retrieve Daily Sales & Laborget
Forecast Overrides
Tip Pool
Day Part
- Retrieve day part settingsget
Availability
Time Off
Shift Feedback
- List Shift Feedbackget
Engage
- Retrieve Engagement Overviewget
Webhooks

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
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
- Retrieve Worked Hours & Wagesget
- Retrieve Daily Sales & Laborget
Forecast Overrides
Tip Pool
Day Part
- Retrieve day part settingsget
Availability
Time Off
Shift Feedback
- List Shift Feedbackget
Engage
- Retrieve Engagement Overviewget
Webhooks

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 Event

get https://api.7shifts.com/v2/company/{company_id}/events/{event_id}

URL Expired

The URL for this request expired after 30 days.

Minimum Plan Required: The Works

Sample Response

{
    "data": {
        "id": 2369552,
        "location_ids": [
            7890
        ],
        "color": "ED6337",
        "start_date": "2022-07-07",
        "start_time": "12:00:00",
        "end_time": "12:05:00",
        "end_date": "2022-07-07",
        "title": "Take out trash",
        "description": "",
        "is_multi_day": false,
        "event_type": "general",
        "recurrence": "DTSTART:20220707T120000Z\nRRULE:FREQ=DAILY"
    },
    "object": "event"
}

Path Params

company_id

int64

required

Company ID

event_id

int64

required

Event ID

Headers

x-api-version

string

7shifts API version

x-company-guid

uuid

Company GUID

Responses

Response body

object

string

required

event

data

object

required

integer

required

event_type

string

required

general birthday work_anniversary

location_ids

array of integers

required

The list of locations where this event occurs

location_ids*

start

array of objects

The events start date-time for each locations timezone

start

object

location_id

integer

required

Location ID

date_time

string

required

The events start date-time for the locations timezone

start_date

string

required

Start date

start_time

string

required

Start time

end

array of objects

The events end date-time for each locations timezone

end

object

location_id

integer

required

Location ID

date_time

string

required

The events end date-time for the locations timezone

end_date

string

required

End date for multi-day events

end_time

string

required

End time

title

string

required

length ≤ 100

The name of the event

description

string | null

Description for event

color

string | null

A hex number representing the color

is_multi_day

boolean

required

If true, the event is a multi-day event

recurrence

string | null

Recurrence rules as defined by the RFC 5545 spec

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 2 years ago

Create Event

Update Event

Did this page help you?

Language

Credentials

Bearer


xxxxxxxxxx
1
curl --request GET \
2
     --url https://api.7shifts.com/v2/company/company_id/events/event_id \
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 2 years ago

Create Event

Update Event

Did this page help you?

API Usage
Introduction
Authentication
Errors
Versioning
Pagination
API Status
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 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 External User Mappingspost
Create External User Mappingpost
List External User Mappingget
Delete External User Mappingdelete
Update External User Mappingput
Retrieve External User 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
Update Task List Templateput
Delete Task List Templatedelete
Retrieve Task List Templateget
Create Task List Templatepost
List Task List Templatesget
Delete Task Tagsdelete
Create Task Tagspost
List Task Management Settingsget
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 Sales & Laborget
Retrieve Worked Hours & Wagesget
Forecast Overrides
Create 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
List Time Off Conflictsget
Retrieve Time Off Settingsget
Retrieve Time Off Hoursget
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

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
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 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 External User Mappingspost
Create External User Mappingpost
List External User Mappingget
Delete External User Mappingdelete
Update External User Mappingput
Retrieve External User 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
Update Task List Templateput
Delete Task List Templatedelete
Retrieve Task List Templateget
Create Task List Templatepost
List Task List Templatesget
Delete Task Tagsdelete
Create Task Tagspost
List Task Management Settingsget
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 Sales & Laborget
Retrieve Worked Hours & Wagesget
Forecast Overrides
Create 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
List Time Off Conflictsget
Retrieve Time Off Settingsget
Retrieve Time Off Hoursget
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

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

Sample Response

200OK

401Unauthorized

403Forbidden

404Not found

500Server Error