API Reference

/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 both admin in Recruiting and hris_admin in Employee Management.

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
rolestringThe member's role. Possible values are admin, simple, reviewerand no_access
hris_rolestringThe member's hris role. Possible values are hris_admin and hris_employee and hris_no_access
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
Language
Credentials
Header
URL
Click Try It! to start a request and see the response here!