Create user

post

https://harvest.greenhouse.io/v3/users

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.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

send_email_invite

boolean

Defaults to false

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_name

string

required

length ≤ 255

last_name

string

required

length ≤ 255

primary_email

string

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_title

string

length ≤ 255

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

employee_id

string

length ≤ 255

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_ids

array of integers

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

office_ids

external_office_ids

array of strings

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.

external_office_ids

department_ids

array of integers

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

department_ids

external_department_ids

array of strings

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.

external_department_ids

interviewer_tag_ids

array of integers

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

interviewer_tag_ids

custom_fields

array of objects

custom_fields

Responses

401

Unauthorized

403

Forbidden

422

Unprocessable Content

Language

Credentials

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

201Successful