Sign in

v1

latestOpenAPI 3.1.02026-07-261770816.7 KB
User Roles

List user roles

User roles are the organization-wide dictionary of access levels a user can hold — the categories themselves, not the per-user assignments. Each role has a role_type of job_admin or site_admin and a display name; built-in roles ship as Standard, Private, and Site Admin, and customers may configure additional job_admin roles through the Greenhouse admin UI. The id returned here is the user_role_id used when assigning a user to a job through user_job_permissions (per-job grant) or future_job_permissions (office/department-scoped grant for jobs created later).

get/v3/user_roles

Query parameters

cursorstring

Cursor link for pagination from previous page response header. Do not use any other parameters when using this.

per_pageinteger

Number of results per page

idsinteger[]

Comma separated list

gtestring date-time
ltestring date-time
gtstring date-time
ltstring date-time
gtestring date-time
ltestring date-time
gtstring date-time
ltstring date-time
fieldsstring[]

Comma separated list of fields to return

Response

Successful

idinteger
created_atstring date-time
updated_atstring date-time
role_type'deprecated_interviewer' | 'job_admin' | 'site_admin'

Category of access this role grants. job_admin roles are assigned per job through user_job_permissions and future_job_permissions; site_admin is org-wide and bypasses per-job assignment. deprecated_interviewer is retained for historical records and is no longer assignable.

namestring

Display label for the role, unique within the organization. Built-in job_admin roles ship as Standard and Private; the built-in site_admin role is Site Admin. Customers may configure additional job_admin roles (e.g. Recruiter, Coordinator) in the Greenhouse admin UI — those custom names appear here alongside the defaults.