SuprSync
Developer Portal
Sign In

SuprSync External API

The SuprSync External API provides scoped access to supported workforce resources. Access is limited by each credential's scopes; it is not a general-purpose or full-access API.

Base URL

${SUPRSYNC_API_BASE}/external/v1

Quick Start

  1. Get API credentials - Sign in on the Dashboard to create API keys, or contact your SuprSync admin.
  2. Authenticate - Include your x-api-key and x-api-secret headers in every request.
  3. Make requests - Call any endpoint to retrieve your workforce data.

Example Request

curl -X GET "${SUPRSYNC_API_BASE}/external/v1/locations" \
  -H "x-api-key: api_your_client_id" \
  -H "x-api-secret: sec_your_client_secret"

Example Response

[
  {
    "id": "a1b2c3d4-...",
    "name": "Downtown Office",
    "city": "Lagos",
    "state": "Lagos",
    "latitude": 6.5244,
    "longitude": 3.3792,
    "hexcode": "#00AD57",
    "symbol": "DO",
    "locationDetectionEnabled": true
  }
]

Available Endpoints

MethodEndpointDescription
GET/hoursHours worked per day over a date range
GET/overtimeApproved overtime by employee
GET/schedulesShift schedules with filtering
GET/shiftsShift slots/templates, or a single shift by ID
POST/shifts/slotsCreate a shift slot
POST/shifts/bookBook staff into a shift slot
DELETE/shifts/:idCancel a shift
GET/locationsCompany branches/locations
POST/locationsCreate a new location
PATCH/locations/:idUpdate a location
GET/job-rolesJob roles
POST/job-rolesCreate a job role
PATCH/job-roles/:idUpdate a job role
DELETE/job-roles/:idDelete a job role
GET/staffStaff/team member list
GET/workforce/resourcesVersioned workforce supply resources and tombstones
POST/staff/bulkBulk create staff members
DELETE/staff/:idDeactivate a staff member
POST/auth/signinSign in (returns JWT)
GET/auth/keysList API keys (JWT auth)
POST/auth/keysCreate API key (JWT auth)

Your SuprSync onboarding contact supplies the API origin. Set it as SUPRSYNC_API_BASE; do not assume a public api.suprsync.com host.

Next Steps