get
https://{subdomain}.workable.com/spi/v3/collaboration_permissions
Returns the effective collaboration permissions configuration. Required scope: r_jobs. Accessible with all token types.
Recent Requests
Log in to see full request history
| Time | Status | User Agent | |
|---|---|---|---|
Retrieving recent requests… | |||
Loading…
Results
Calling the /collaboration_permissions endpoint will return a collection of collaboration permissions. Each permission includes the list of roles that are granted access.
Included permissions:
| key | type | description |
|---|---|---|
| ats:collab:candidates:access_ai_recruiter | array(string) | Use Search with AI |
| ats:collab:candidates:approve_reject_offer | array(string) | Approve or reject offer |
| ats:collab:candidates:block | array(string) | Block candidate |
| ats:collab:candidates:bookmark | array(string) | Save candidate |
| ats:collab:candidates:cancel_automation | array(string) | Cancel automated actions |
| ats:collab:candidates:comment | array(string) | Add comments to candidate profile |
| ats:collab:candidates:copy | array(string) | Copy or move candidate to another job |
| ats:collab:candidates:create | array(string) | Create candidate |
| ats:collab:candidates:create_tag | array(string) | Create new profile tags |
| ats:collab:candidates:delete | array(string) | Delete candidate |
| ats:collab:candidates:disqualify | array(string) | Disqualify candidate |
| ats:collab:candidates:download | array(string) | Download or print candidate resume |
| ats:collab:candidates:edit_any_event | array(string) | Edit or destroy event |
| ats:collab:candidates:edit_any_message | array(string) | Edit or destroy message |
| ats:collab:candidates:edit_any_visibility | array(string) | Edit visibility of team messages and comments |
| ats:collab:candidates:evaluate | array(string) | Add candidate evaluation |
| ats:collab:candidates:export_to_hris | array(string) | Export to HRIS |
| ats:collab:candidates:manage_offer | array(string) | Send or cancel offer |
| ats:collab:candidates:manage_whitelist | array(string) | Manage whitelist |
| ats:collab:candidates:message | array(string) | Send and reply to candidate messages |
| ats:collab:candidates:move | array(string) | Move candidate to pipeline stage |
| ats:collab:candidates:print | array(string) | Print candidate profile |
| ats:collab:candidates:read | array(string) | View candidate profile |
| ats:collab:candidates:revert | array(string) | Revert or unblock candidate |
| ats:collab:candidates:save_template | array(string) | Save event or message templates |
| ats:collab:candidates:schedule_event | array(string) | Send event invitations |
| ats:collab:candidates:send_assessment | array(string) | Send video interviews or assessments |
| ats:collab:candidates:send_bg_check | array(string) | Request background or reference checks |
| ats:collab:candidates:send_e_signature | array(string) | Send e-signature |
| ats:collab:candidates:send_survey | array(string) | Send candidate surveys |
| ats:collab:candidates:share | array(string) | Share candidate externally |
| ats:collab:candidates:snooze | array(string) | Snooze candidate |
| ats:collab:candidates:tag | array(string) | Apply existing profile tags |
| ats:collab:candidates:update | array(string) | Edit candidate profile |
| ats:collab:candidates:view_assessment_results | array(string) | View video interview and assessment results |
| ats:collab:candidates:view_bg_check_results | array(string) | View background check results |
| ats:collab:candidates:view_e_signature | array(string) | View e-signature details |
| ats:collab:candidates:view_offer | array(string) | View offer details |
| ats:collab:candidates:view_other_evaluations | array(string) | View candidate evaluations |
| ats:collab:candidates:view_ref_check_results | array(string) | View reference check results |
| ats:collab:candidates:view_siblings | array(string) | View other jobs a candidate has applied to |
| ats:collab:collaboration:update | array(string) | Update collaboration |
| ats:collab:custom_fields:toggle | array(string) | Enable or disable custom fields |
| ats:collab:jobs:archive | array(string) | Archive job |
| ats:collab:jobs:delete | array(string) | Delete job |
| ats:collab:jobs:duplicate | array(string) | Duplicate job |
| ats:collab:jobs:edit | array(string) | Edit job |
| ats:collab:jobs:leave_hiring_team | array(string) | Edit hiring team role |
| ats:collab:jobs:publish | array(string) | Publish or mark job as confidential |
| ats:collab:jobs:show | array(string) | View job listings |
| ats:collab:jobs:unarchive | array(string) | Unarchive job |
| ats:collab:jobs:unpublish | array(string) | Unpublish or use job internally |
| ats:collab:members:invite | array(string) | Invite team members to job |
| ats:collab:premium_postings:manage | array(string) | Manage premium job postings |
| ats:collab:premium_postings:purchase | array(string) | Purchase premium job ads |
| ats:collab:referrals:request | array(string) | Request job referrals from coworkers |
| ats:collab:requisitions:create | array(string) | Create a requisition |
| ats:collab:requisitions:edit_status | array(string) | Open, put on hold or resume a requisition |
| ats:collab:requisitions:manage | array(string) | View and manage a requisition |
Note: The View job listings and View candidate profile permissions are set by default to all roles and can't be changed.
Roles
Possible values in roles array include admin, hiring_manager,recruiter,recruiting_admin,reviewer,simple. Each role represents a different level of access and responsibility within the system. For more details about each role, refer to the Collaboration Rules.