Create Staff Member
Create a new staff member.
Endpointโ
POST /v1/staff
Authenticationโ
Requires an API key with the staff:write scope.
Request Bodyโ
| Field | Type | Required | Description |
|---|---|---|---|
first_name | string | Yes | First name (max 255 characters) |
last_name | string | Yes | Last name (max 255 characters) |
email | string | Yes | Email address |
phone | string | No | Phone number |
phone_country_code | string | No | Phone country code |
status | string | No | active, inactive (default: active) |
employment_type | string | No | full_time, part_time, contractor |
gender | string | No | male, female, other |
dob | string | No | Date of birth (YYYY-MM-DD) |
job_title | string | No | Job title (e.g., "Equipment Technician") |
hire_date | string | No | Hire date (YYYY-MM-DD) |
address_line_1 | string | No | Street address line 1 |
address_line_2 | string | No | Street address line 2 |
city | string | No | City |
state | string | No | State/province |
postcode | string | No | Postal/ZIP code |
country | string | No | Country code |
emergency_contact_name | string | No | Emergency contact name |
emergency_contact_phone | string | No | Emergency contact phone |
emergency_contact_country_code | string | No | Emergency contact country code |
add_in_roster | boolean | No | Include in staff roster (default: true) |
role_ids | array | No | Array of staff role IDs to assign |
main_location_id | integer | No | Primary location ID |
location_ids | array | No | Array of additional location IDs |
Example Requestโ
curl -X POST "https://app.equipdash.com/api/v1/staff" \
-H "Authorization: Bearer eqd_live_abc123xyz789..." \
-H "Content-Type: application/json" \
-d '{
"first_name": "Mike",
"last_name": "Johnson",
"email": "mike@company.com",
"phone": "0412000000",
"phone_country_code": "+61",
"employment_type": "full_time",
"job_title": "Equipment Technician",
"hire_date": "2026-01-15"
}'
Responseโ
Success (201 Created)โ
Returns the created staff member resource. See List Staff for response structure.
Errorsโ
| Status | Code | Description |
|---|---|---|
| 401 | authentication_required | No API key provided |
| 401 | invalid_api_key | Invalid API key |
| 403 | insufficient_scope | API key lacks staff:write scope |
| 422 | validation_error | Invalid request data |