Staff

idstringrequired

Staff profile ID used in API request paths.

external_idstringnullablerequired

Client-owned identifier for the staff member.

employee_numberintegerrequired

Workstaff-assigned staff number, unique within the company. This is not the API resource ID.

first_namestringnullablerequired

The first name resolved for this company. This can be a company-specific override when the staff member has claimed their profile.

last_namestringnullablerequired

The last name resolved for this company. This can be a company-specific override when the staff member has claimed their profile.

emailstring<email>nullablerequired

phonestringnullablerequired

skillsstring[]required

languageLanguageEnumrequired

• en - English
• fr - French
• es - Spanish

Possible values: [en, fr, es]

work_eligibility_period objectrequired

Date range defining when the staff member is allowed to work. It provides visual warnings but does not block work outside the range.

startstring<date-time>nullable

UTC timestamp with exactly three fractional-second digits, for example 2026-01-01T00:00:00.000Z.

endstring<date-time>nullable

UTC timestamp with exactly three fractional-second digits, for example 2026-04-01T00:00:00.000Z.

home_location objectnullablerequired

The staff member's home location, used mainly for distance filters.

citystringnullablerequired

statestringnullablerequired

countrystringnullablerequired

zipcodestringnullablerequired

addressstringnullablerequired

Staff

{
  "id": "string",
  "external_id": "string",
  "employee_number": 0,
  "first_name": "string",
  "last_name": "string",
  "email": "user@example.com",
  "phone": "string",
  "skills": [
    "string"
  ],
  "language": "en",
  "work_eligibility_period": {
    "start": "2024-07-29T15:51:28.071Z",
    "end": "2024-07-29T15:51:28.071Z"
  },
  "home_location": {
    "city": "string",
    "state": "string",
    "country": "string",
    "zipcode": "string",
    "address": "string"
  }
}