API Reference
Start typing to search…

/members

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.

Log in to see full request history

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
Query Params
int32
Defaults to 50

Specifies the number of members to try and retrieve per page. (optional)

string

Returns results with an ID greater than or equal to the specified ID. (optional)

string

Returns results with an ID less than or equal to the specified ID. (optional)

string

Filters for members of the specified role. Can be simple, admin or reviewer.

string

Filters for a specific job, only collaborators will be returned.

string

Filters for members of the specified email.

string

Filters for members of the specified full name (exact match).

string
Defaults to active

Filters for members based on the status. Possible values: active, inactive and all

Responses

Updated about 2 months ago

Did this page help you?
Language
Credentials
URL
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated about 2 months ago

Did this page help you?