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.
Recent Requests
Log in to see full request history
| Time | Status | User Agent | |
|---|---|---|---|
Retrieving recent requests… | |||
Loading…
Results
Calling the /members endpoint will return a collection of the defined members
Recruiting Role mapping:
ats.admin - All Access
ats.simple - Standard Access
ats.reviewer - Limited Access / Reviewer
Employee Management Role mapping:
hris.admin - All Access
hris.employee - Standard Access
hris.limited - Limited Access
If a member has full access to all account settings, data and user permissions across Recruiting (and HR, if enabled) then the member will also have the workable.superadmin role.
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 | |
| roles | string[] | The member's roles in an array. Possible values are ats.admin, ats.simple, ats.reviewer, hris.admin, hris.employee, hris.limited, workable.superadmin plus any permission sets assigned to the member. You can find more info regarding permission sets here and the endpoint to get the permission sets currently created in the account here |
| active | boolean | The member's status. trueif 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 |