Skip to content
ShiftSync Developers

Overview

ShiftSync API 1.0

Section titled “ShiftSync API 1.0”

ShiftSync API.

Information

  • OpenAPI version: 3.0.0

Operations

Section titled “Operations”
GET
/v1/user
POST
/v1/user/update
GET
/v1/user/notification-settings
POST
/v1/user/notification-settings
GET
/v1/templates
POST
/v1/templates
POST
/v1/templates/{id}
DELETE
/v1/templates/{id}
GET
/v1/shifts
POST
/v1/shifts
GET
/v1/shifts/series/{seriesId}
GET
/v1/shifts/{id}
POST
/v1/shifts/{id}
DELETE
/v1/shifts/{id}
POST
/v1/shifts/{id}/recurrence
DELETE
/v1/shifts/{id}/recurrence
GET
/v1/friends
POST
/v1/friends/respond
DELETE
/v1/friends/{friendshipId}
GET
/v1/friends/shifts
GET
/v1/invites
POST
/v1/invites
GET
/v1/invites/{inviteCode}
POST
/v1/invites/seen
GET
/v1/reports/hours-worked
GET
/v1/reports/expected-pay
GET
/v1/pay/settings
POST
/v1/pay/settings
GET
/v1/pay/rules
POST
/v1/pay/rules
POST
/v1/pay/rules/{ruleId}
DELETE
/v1/pay/rules/{ruleId}
GET
/v1/groups
POST
/v1/groups
POST
/v1/groups/{groupId}
DELETE
/v1/groups/{groupId}

Authentication

Section titled “Authentication”

bearer

Section titled “bearer”

Security scheme type: http

Bearer format: JWT

Section titled “cookie”

Security scheme type: apiKey

Cookie parameter name: ss_at

oauth2

Section titled “oauth2”

Security scheme type: oauth2

Flow type: authorizationCode

Authorization URL: https://api.shiftsync.app/oauth/authorize

Token URL: https://api.shiftsync.app/oauth/token

Refresh URL: https://api.shiftsync.app/oauth/token

Scopes:

  • user:read - Read user
  • user:write - Read and write user
  • shifts:read - Read shifts
  • shifts:write - Read and write shifts
  • templates:read - Read templates
  • templates:write - Read and write templates
  • groups:read - Read groups
  • groups:write - Read and write groups
  • friends:read - Read friends
  • friends:write - Read and write friends
  • invites:read - Read invites
  • invites:write - Read and write invites
  • pay:read - Read pay
  • pay:write - Read and write pay