get https://{subdomain}.workable.com/spi/v3/members
Returns a collection of your account members. Required scope: r_jobs
. Accessible with account tokens and user tokens.
Results
Calling the /members
endpoint will return a collection of the defined members
Recruiting Role mapping:
admin
- All Access
simple
- Standard Access
reviewer
- Limited Access / Reviewer
no_access
- No Access in Recruiting
Employee Management Role mapping:
hris_admin
- All Access
hris_employee
- Standard Access
hris_no_access
- No Access in Employee Management
super_admin
role is an implied role. You need to be bothadmin
in Recruiting andhris_admin
in Employee Management.
Each member
will have the following keys:
key | type | description |
---|---|---|
id | string | The member identifier |
name | string | The full name of the member |
headline | string | The headline of the member |
string | The email address of the member | |
role | string | The member's role. Possible values are admin , simple , reviewer and no_access |
hris_role | string | The member's hris role. Possible values are hris_admin and hris_employee and hris_no_access |
active | boolean | The member's status. true if active, false if inactive. |
collaboration_rules | Array | An array of the collaboration rules the member has. Each rule contains the role of the member in the collaboration, an array of departments and an array of locations that this collaborations is applicable for. More info here |