GRgreenhouse
Users

Create user

Create a new Greenhouse user in your organization. first_name, last_name, and primary_email are required; the user is created with the Basic permission level and no job assignments. Set send_email_invite=true to email the new user an invitation; leave it false (the default) when an HRIS sync is provisioning accounts ahead of the user's start date. Provide employee_id to link the new user to an HRIS record so subsequent calls can look the user up via employee_ids. Use POST /v3/user_job_permissions or POST /v3/future_job_permissions afterwards to grant the user Job Admin access on specific jobs or scopes.

post/v3/users

Request

  • Base URL
    https://harvest.greenhouse.io
  • URL
    https://harvest.greenhouse.io/v3/users
  • Auth
    • OAuth 2
      Authorization code: https://auth.greenhouse.io/authorize
      Client credentials
      Token URL: https://auth.greenhouse.io/token scopes: harvest:users:create
    • or HTTP bearer

Request body

send_email_inviteboolean

If true, Greenhouse sends the new user an invitation email so they can set a password and sign in. Defaults to false — useful when an HRIS sync provisions accounts ahead of the user's actual hire date.

first_namestring required
last_namestring required
primary_emailstring email required

Primary email address for the new user. Sign-in identifier and the address Greenhouse uses for invitation and notification mail. Must be unique within the organization.

job_titlestring

Free-form job title to set on the user's Greenhouse profile (e.g. Senior Recruiter).

employee_idstring

Partner-supplied external employee identifier — typically the user's HRIS or payroll id. Recommended for HRIS-driven user sync so the user can be looked up later via employee_ids.

office_idsinteger[]

Greenhouse office ids to pin the user to. Used for future job permission scoping. Mutually exclusive with external_office_ids.

external_office_idsstring[]

External office identifiers (the offices' external_id) to pin the user to. Use this when the partner only has external office identifiers. Mutually exclusive with office_ids.

department_idsinteger[]

Greenhouse department ids to pin the user to. Used for future job permission scoping. Mutually exclusive with external_department_ids.

external_department_idsstring[]

External department identifiers (the departments' external_id) to pin the user to. Use this when the partner only has external department identifiers. Mutually exclusive with department_ids.

interviewer_tag_idsinteger[]

Ids of interviewer tags to apply to the user, marking them as a qualified interviewer for those skill or panel groupings.

Response

Successful

idinteger
created_atstring date-time
updated_atstring date-time
first_namestring nullable
last_namestring nullable
primary_emailstring

Primary email address on the user's account. Sign-in identifier and the address Greenhouse uses for outbound mail; additional verified addresses are not surfaced here. Service accounts (integration/ISU users) have no email and are excluded from this endpoint by default; when included via show_service_accounts=true, their primary_email is an empty string.

job_titlestring nullable

Free-form job title set on the user's Greenhouse profile (e.g. Senior Recruiter). Not synchronized with any HRIS title.

agency_idinteger nullable

Id of the staffing agency this user belongs to, when the user is an external agency recruiter rather than an employee of your organization. null for in-house users.

namestring nullable

Concatenation of first_name and last_name rendered as a single display string. Provided for convenience; partners that need either component should read first_name/last_name directly.

deactivatedboolean

Whether the user has been deactivated. Deactivated users cannot sign in or be assigned to new jobs, but their historical activity (notes, scorecards, emails) is preserved. Toggle via POST /v3/users/{id}/deactivate and POST /v3/users/{id}/activate.

site_adminboolean

Whether the user holds the Site Admin role. Site admins have unrestricted access to every non-confidential job and to organization-level settings. Demote a site admin to a Basic user with POST /v3/users/{id}/revoke_permissions.

employee_idstring nullable

Partner-supplied external employee identifier, typically the user's HRIS or payroll id. Free-form string; not unique across organizations and null when no employee id has been set.

linked_candidate_idsinteger[]

Ids of candidate records linked to this user. Populated when an employee is represented by both a user record (for Greenhouse access) and a candidate record (for past or internal applications).

office_idsinteger[]

Ids of the offices this user is assigned to. Used to scope future job permissions and to filter the user list by office. Empty when the user is not pinned to any office.

department_idsinteger[]

Ids of the departments this user is assigned to. Used to scope future job permissions and to filter the user list by department. Empty when the user is not pinned to any department.

external_office_idsstring[]

external_ids of the offices this user is assigned to, for partners that reconcile office assignments against an HRIS by external id. Mirrors the external_office_ids accepted on create and update. Offices with no external id set are omitted, so this can be shorter than office_ids.

external_department_idsstring[]

external_ids of the departments this user is assigned to, for partners that reconcile department assignments against an HRIS by external id. Mirrors the external_department_ids accepted on create and update. Departments with no external id set are omitted, so this can be shorter than department_ids.

emailsstring[]

All email addresses on the user's account, including the primary address and any additional verified addresses.

custom_fieldsobject nullable

Changes

No recorded changes to this operation across all 1 revision of this API.