Staff

GET /external/v1/staff

Returns team members (staff) for your company with optional filtering.

Query Parameters

Parameter	Type	Required	Description
`branchId`	string	No	Filter by assigned branch ID
`jobRoleId`	string	No	Filter by job role ID
`status`	number	No	Filter by status (defaults to `1` = active)

Response

[
  {
    "membershipId": "membership-uuid-1",
    "userId": "user-uuid-1",
    "branchId": "branch-uuid-1",
    "jobRoleId": "role-uuid-1",
    "privilege": 3,
    "status": 1
  },
  {
    "membershipId": "membership-uuid-2",
    "userId": "user-uuid-2",
    "branchId": "branch-uuid-1",
    "jobRoleId": "role-uuid-2",
    "privilege": 2,
    "status": 1
  }
]

Response Fields

Field	Type	Description
`membershipId`	string	Unique team membership ID
`userId`	string	The staff member's user ID
`branchId`	string \| null	Assigned branch/location ID
`jobRoleId`	string \| null	Assigned job role ID
`privilege`	number	Permission level: `1` = Super Admin, `2` = Admin, `3` = Member
`status`	number	Membership status: `1` = active

Example

curl -X GET "https://api.suprsync.com/external/v1/staff" \
  -H "x-api-key: api_your_client_id" \
  -H "x-api-secret: sec_your_client_secret"

Filter by branch and job role

curl -X GET "https://api.suprsync.com/external/v1/staff?branchId=branch-uuid&jobRoleId=role-uuid" \
  -H "x-api-key: api_your_client_id" \
  -H "x-api-secret: sec_your_client_secret"

Deactivate Staff Member

DELETE /external/v1/staff/:membershipId

Deactivates a staff member (sets status to 0). This does not delete the user account.

curl -X DELETE "https://api.suprsync.com/external/v1/staff/membership-uuid-1" \
  -H "x-api-key: api_your_client_id" \
  -H "x-api-secret: sec_your_client_secret"

Response

{
  "message": "Staff member deactivated"
}

Notes

Sensitive PII (name, email, phone) is stripped from the GET response.
Use userId to correlate staff with shifts and schedules from other endpoints.
Cross-reference with Job Roles and Locations for role titles and branch names.
To add staff in bulk, see Bulk Staff Creation.