---
updatedAt: 2025-12-11T11:34:56.000Z
agentTools:
projectIndex: https://workable.readme.io/llms.txt
---
# /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](http://www.workable.com/backend/account/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 |
| email | `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. `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](https://workable.readme.io/reference/collaboration-rules) |
# OpenAPI definition
```json
{
"openapi": "3.1.0",
"info": {
"title": "account-root",
"version": "3.16.2"
},
"servers": [
{
"url": "https://{subdomain}.workable.com/spi/v3",
"variables": {
"subdomain": {
"default": "subdomain"
}
}
}
],
"components": {
"securitySchemes": {
"sec0": {
"type": "apiKey",
"in": "header",
"name": "Authorization",
"x-bearer-format": "",
"x-default": "Bearer"
}
}
},
"security": [
{
"sec0": []
}
],
"paths": {
"/members": {
"get": {
"summary": "/members",
"description": "Returns a collection of your account members. Required scope: `r_jobs`. Accessible with account tokens and user tokens.",
"operationId": "members",
"parameters": [
{
"name": "limit",
"in": "query",
"description": "Specifies the number of members to try and retrieve per page. (optional)",
"schema": {
"type": "integer",
"format": "int32",
"default": 50
}
},
{
"name": "since_id",
"in": "query",
"description": "Returns results with an ID greater than or equal to the specified ID. (optional)",
"schema": {
"type": "string"
}
},
{
"name": "max_id",
"in": "query",
"description": "Returns results with an ID less than or equal to the specified ID. (optional)",
"schema": {
"type": "string"
}
},
{
"name": "role",
"in": "query",
"description": "Filters for members of the specified recruiting role. Can be `simple`, `admin` or `reviewer`.",
"schema": {
"type": "string"
}
},
{
"name": "shortcode",
"in": "query",
"description": "Filters for a specific job, only collaborators will be returned.",
"schema": {
"type": "string"
}
},
{
"name": "email",
"in": "query",
"description": "Filters for members of the specified email.",
"schema": {
"type": "string"
}
},
{
"name": "name",
"in": "query",
"description": "Filters for members of the specified full name (exact match).",
"schema": {
"type": "string"
}
},
{
"name": "status",
"in": "query",
"description": "Filters for members based on the status. Possible values: active, inactive and all",
"schema": {
"type": "string",
"default": "active"
}
}
],
"responses": {
"200": {
"description": "200",
"content": {
"application/json": {
"examples": {
"Result": {
"value": "{\n \"members\": [\n {\n \"id\": \"3dae6411\",\n \"name\": \"John Doe\",\n \"headline\": null,\n \"email\": \"john.doe@workable.com\",\n \"role\": \"admin\",\n \"hris_role\": \"hris_admin\",\n \"active\": false,\n \t\"collaboration_rules\": []\n }\n ]\n}"
}
},
"schema": {
"type": "object",
"properties": {
"members": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"example": "3dae6411"
},
"name": {
"type": "string",
"example": "John Doe"
},
"headline": {},
"email": {
"type": "string",
"example": "john.doe@workable.com"
},
"roles": {
"type": "array",
"example": "hris_admin",
"items": {
"type": "string"
}
},
"active": {
"type": "boolean",
"example": false,
"default": true
},
"collaboration_rules": {
"type": "array"
}
}
}
}
}
}
}
}
},
"401": {
"description": "401",
"content": {
"application/json": {
"examples": {
"Result": {
"value": "{\n \"error\":\"Not authorized\"\n}"
}
},
"schema": {
"type": "object",
"properties": {
"error": {
"type": "string",
"example": "Not authorized"
}
}
}
}
}
},
"403": {
"description": "403",
"content": {
"application/json": {
"examples": {
"Result": {
"value": "{\n \"error\":\"Forbidden\"\n}"
}
},
"schema": {
"type": "object",
"properties": {
"error": {
"type": "string",
"example": "Forbidden"
}
}
}
}
}
}
},
"deprecated": false
}
}
},
"x-readme": {
"headers": [],
"explorer-enabled": true,
"proxy-enabled": true
},
"x-readme-fauxas": true
}
```