Staff Shifts API
The Staff Shifts API lets you manage scheduling shifts for your team members.
What is a Staff Shift?โ
A shift represents a scheduled work period for a staff member at a specific location. Shifts can be:
- Assigned โ linked to a specific staff member
- Open โ unassigned and available for pickup
Shift Structureโ
Staff Shift
โโโ Date & Time (shift_date, start_time, end_time)
โโโ Staff Member (optional assignment)
โโโ Location (optional)
โโโ Break Settings (type, time, payment)
โโโ Notes
โโโ Status (Open, Unpublished, Published, Updated, etc.)
Shift Statusesโ
| Status | Description |
|---|---|
Open | Unassigned shift, available for pickup |
Unpublished | Assigned to staff but not yet published |
Published | Published and visible to staff |
Updated | Modified after initial creation |
Active | Currently in progress |
Inactive | No longer active |
API Endpointsโ
| Method | Endpoint | Description | Scope Required |
|---|---|---|---|
GET | /v1/staff/shifts | List all shifts | staff:read |
GET | /v1/staff/shifts/{id} | Get a single shift | staff:read |
POST | /v1/staff/shifts | Create a new shift | staff:write |
PATCH | /v1/staff/shifts/{id} | Update a shift | staff:write |
DELETE | /v1/staff/shifts/{id} | Delete a shift | staff:write |
Common Use Casesโ
List Today's Shiftsโ
curl "https://app.equipdash.com/api/v1/staff/shifts?date=2026-03-09" \
-H "Authorization: Bearer YOUR_API_KEY"
Create a Shift for a Staff Memberโ
curl -X POST "https://app.equipdash.com/api/v1/staff/shifts" \
-H "Authorization: Bearer YOUR_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"staff_id": 5,
"shift_date": "2026-03-15",
"start_time": "09:00",
"end_time": "17:00"
}'
Related Resourcesโ
- Staff Members - Manage team members assigned to shifts
- Webhooks - Get notified on shift changes (
shift.created,shift.updated,shift.deleted)