Skip to main content

Create Staff Member

Create a new staff member.

Endpointโ€‹

POST /v1/staff

Authenticationโ€‹

Requires an API key with the staff:write scope.

Request Bodyโ€‹

FieldTypeRequiredDescription
first_namestringYesFirst name (max 255 characters)
last_namestringYesLast name (max 255 characters)
emailstringYesEmail address
phonestringNoPhone number
phone_country_codestringNoPhone country code
statusstringNoactive, inactive (default: active)
employment_typestringNofull_time, part_time, contractor
genderstringNomale, female, other
dobstringNoDate of birth (YYYY-MM-DD)
job_titlestringNoJob title (e.g., "Equipment Technician")
hire_datestringNoHire date (YYYY-MM-DD)
address_line_1stringNoStreet address line 1
address_line_2stringNoStreet address line 2
citystringNoCity
statestringNoState/province
postcodestringNoPostal/ZIP code
countrystringNoCountry code
emergency_contact_namestringNoEmergency contact name
emergency_contact_phonestringNoEmergency contact phone
emergency_contact_country_codestringNoEmergency contact country code
add_in_rosterbooleanNoInclude in staff roster (default: true)
role_idsarrayNoArray of staff role IDs to assign
main_location_idintegerNoPrimary location ID
location_idsarrayNoArray 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โ€‹

StatusCodeDescription
401authentication_requiredNo API key provided
401invalid_api_keyInvalid API key
403insufficient_scopeAPI key lacks staff:write scope
422validation_errorInvalid request data