Staff API

The Staff API lets you manage your team members, including employees, contractors, and guides.

What is a Staff Member?

A staff record represents someone who works for your business. Staff members can be:

• Employees: Full-time or part-time team members
• Contractors: Freelance guides or instructors
• Administrators: Users with system access

Staff Structure

Staff Member
├── Personal Info (name, contact, DOB)
├── Employment Details (type, hire date, title)
├── Address
├── Emergency Contact
├── Roles[] (Guide, Instructor, Manager)
├── Locations[] (assigned work locations)
└── Portal Access (if has user account)

Employment Types

Type	Description
full_time	Regular full-time employee
part_time	Part-time employee
contractor	Freelance or contract worker

Staff Status

Status	Description
active	Currently employed/engaged
inactive	No longer active (terminated, on leave)

API Endpoints

Staff Members

Method	Endpoint	Description	Scope Required
GET	/v1/staff	List all staff members	staff:read
GET	/v1/staff/{id}	Get a single staff member	staff:read
POST	/v1/staff	Create a new staff member	staff:write
PATCH	/v1/staff/{id}	Update staff details	staff:write
DELETE	/v1/staff/{id}	Delete a staff record	staff:write

Staff Roles

Method	Endpoint	Description	Scope Required
GET	/v1/staff/roles	List all roles	staff:read
POST	/v1/staff/roles	Create a new role	staff:write
PATCH	/v1/staff/roles/{id}	Update a role	staff:write
DELETE	/v1/staff/roles/{id}	Delete a role	staff:write

Staff Shifts

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

Staff Availability

Method	Endpoint	Description	Scope Required
GET	/v1/staff/{staffId}/availability	Get a staff member's usual week and date answers	staff:read
PUT	/v1/staff/{staffId}/availability	Set their usual week, specific dates, or both	staff:write
POST	/v1/staff/{staffId}/availability-link	Send one staff member their link	staff:write
POST	/v1/staff/availability-requests	Ask several staff members at once	staff:write

Common Use Cases

Syncing with HR Systems

Export staff data to your HR platform:

curl "https://app.equipdash.com/api/v1/staff?status=active" \
  -H "Authorization: Bearer YOUR_API_KEY"

Adding New Team Members

Create staff records for new hires:

curl -X POST "https://app.equipdash.com/api/v1/staff" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "first_name": "Mike",
    "last_name": "Johnson",
    "email": "mike@company.com",
    "employment_type": "full_time",
    "job_title": "Tour Guide",
    "hire_date": "2026-02-01"
  }'

Related Resources

• Settings - Business locations for staff assignments
• Webhooks - Get notified on staff changes