API Reference
API Reference

/members

Updates a member. Required scope: w_members. Accessible with all token types.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…

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:

keytypedescription
idstringThe member identifier
namestringThe full name of the member
headlinestringThe headline of the member
emailstringThe email address of the member
rolesstring[]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
activebooleanThe member's status. trueif active, false if inactive.
collaboration_rulesArrayAn 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
Path Params
string
required

The account subdomain

Body Params
string
required

The identifier of the member to be updated

roles
array of strings
required

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.

roles*
collaboration_rules
array of objects

The collaboration rules that will be set for this member

collaboration_rules
Responses

Language
Credentials
Header
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json