Easyteam Embedded
GuidesAPIWhite-Label UIs
GuidesAPIWhite-Label UIs
  1. Staff members
  • Getting started
    • Authentication
      • Authentication Quick Start
      • Exchange Token
    • Permissions
      • Create Access Role
      • List Access Roles
      • Get Access Role
      • Update Access Role
      • Delete Access Role
  • Organizations
    • List Organizations
    • Get Organization
    • Get Organization by External ID
    • Create Organization
    • Create Organization With Defaults
    • Sync Locations
    • Update Organization
    • Delete Organization
    • Delete Organization by External ID
  • Locations
    • Retrieve all locations
    • Retrieve a specific location
    • Retrieve a specific location by external ID
    • Create a new location
    • Update a specific location
    • Delete a specific location
    • Retrieve timesheets for a specific location
    • Retrieve staff members for a specific location
  • Staff members
    • Retrieve all staff members
      GET
    • Retrieve a specific staff member
      GET
    • Retrieve a staff member by external ID
      GET
    • Retrieve staff member locations
      GET
    • Create a new staff member
      POST
    • Synchronize staff members
      POST
    • Update a specific staff member
      PATCH
    • Delete a specific staff member
      DELETE
  • Roles
    • Create a new role
    • Retrieve all roles
    • Retrieve a specific role
    • Update a specific role
    • Delete a specific role
  • Time Tracking
    • Retrieve staff member shift state
    • Clock in a staff member
    • Clock out a staff member
  • Breaks
    • Retrieve break types for a specific location
    • Create a new break type for a location
    • Update a specific break type
    • Delete a specific break type
  • Timesheets
    • Retrieve all shifts
    • Retrieve a specific shift
    • Export shifts
    • Generate per-employee shift reports
    • Generate shift reports
    • Create a new shift
    • Update a specific shift
    • Delete a specific shift
    • Delete all shifts on a specific date
  • Time Off
    • Retrieve all time off policies
    • Retrieve a policy
    • List all policy types
    • Create Policy
    • Update Policy
    • Activate Policy
    • Deactivate Policy
    • Get Worker Policies
    • List all worker policies
  • Requests and Approval
    • Get Time-Off Request
    • List Time-Offs
    • Create a time off request
    • Update Time-Off Request
    • Delete Time-Off Request
    • Approve Time-Off Request
    • Decline Time-Off Request
  • Shift Notes
    • Working with shift notes
    • List shift notes from current shift
    • Create shift note on current shift
  • Schedules
    • List all schedule entries
    • Get details for a schedule
    • Create schedule entry
    • Bulk copy schedule shifts
    • Update schedule entry
    • Remove schedule entry
    • List all draft schedule entries
    • Get details for a draft entry
    • Create draft schedule entry
    • Update draft entry
    • Remove draft schedule entry
    • Publish draft schedule
    • List open shifts
    • Get details for an open shift
    • Create open shift
    • Update open shift
    • Remove open shift
    • Claim open shift
    • Retract open shift submission
    • Create open shift preference
    • Retract open shift preference
    • Update open shift preference
    • Remove open shift preference
    • Assign or accept open shift preference
    • Bulk assign or accept open shift preferences
  • Settings
    • Retrieve organization time off settings
    • Update organization time off settings
  • Notifications
    • Coming soon
  1. Staff members

Create a new staff member

POST
/api/organizations/{organization_id}/staffmembers
Creates a new staff member within the specified organization.

Request

Path Params

Body Params application/json

Examples

Responses

🟢200OK
application/json
Staff member created successfully.
Body

đźź 400Bad Request
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request POST '/api/organizations//staffmembers' \
--header 'Content-Type: application/json' \
--data-raw '{
    "name": "John Doe",
    "email": "john.doe@example.com",
    "phoneNumber": "+15551234567",
    "employmentType": "full_time",
    "wageType": "hourly",
    "hourlyWage": 20,
    "birthDate": "1990-01-01",
    "externalId": "ext_emp_001",
    "accessRoleName": "Employee",
    "currencyCode": "USD",
    "roleIds": [
        "role_001"
    ],
    "currentLocation": "loc_001"
}'
Response Response Example
200 - Success
{
    "id": "emp_001",
    "name": "John Doe",
    "email": "john.doe@example.com",
    "phoneNumber": "+15551234567",
    "organizationId": "org_12345",
    "externalId": "ext_emp_001",
    "externalPayrollId": "payroll_ext_001",
    "accessRoleId": "role_001",
    "active": true,
    "hourlyWage": 20,
    "wageType": "hourly",
    "employmentType": "full_time",
    "currencyCode": "USD",
    "birthDate": "1990-01-01T00:00:00Z",
    "createdAt": "2023-10-27T09:00:00Z",
    "updatedAt": "2023-10-27T09:00:00Z",
    "deletedAt": null
}
Modified at 2025-01-05 15:45:21
Previous
Retrieve staff member locations
Next
Synchronize staff members