POST
/
members

Authorizations

​
Authorization
string
header
required

API Key authentication with required prefix "Bearer"

Body

​
address
object
required
​
dob
string
required
​
employer
string
required
​
first_name
string
required
Maximum length: 255
​
hire_date
string
required
​
last_name
string
required
Maximum length: 255
​
biological_sex
  • male - Male
  • female - Female
Available options:
male,
female
​
email
string | null
Maximum length: 254
​
employment_status
enum<string>
  • full_time - Full Time
  • part_time - Part Time
Available options:
full_time,
part_time
​
hours_worked
string
​
pay_frequency
enum<string>
  • weekly - Weekly
  • biweekly - Biweekly
  • semimonthly - Semimonthly
  • monthly - Monthly
Available options:
weekly,
biweekly,
semimonthly,
monthly
​
payroll_provider_external_id
string | null
Maximum length: 255
​
phone_number
string | null
Maximum length: 10
​
ssn
string
​
subclasses
string[]
​
termination_date
string | null

Response

201 - application/json
​
address
object
required
​
dob
string
required
​
employer
string
required
​
first_name
string
required
Maximum length: 255
​
hire_date
string
required
​
id
string
required
​
last_name
string
required
Maximum length: 255
​
biological_sex
  • male - Male
  • female - Female
Available options:
male,
female
​
email
string | null
Maximum length: 254
​
employment_status
enum<string>
  • full_time - Full Time
  • part_time - Part Time
Available options:
full_time,
part_time
​
enrollments
string[]
​
hours_worked
string
​
pay_frequency
enum<string>
  • weekly - Weekly
  • biweekly - Biweekly
  • semimonthly - Semimonthly
  • monthly - Monthly
Available options:
weekly,
biweekly,
semimonthly,
monthly
​
payroll_provider_external_id
string | null
Maximum length: 255
​
phone_number
string | null
Maximum length: 10
​
ssn_last_four
string
​
subclasses
string[]
​
termination_date
string | null
List MembersRetrieve Member