GRgreenhouse
Referrers

Create referrer

Create a referrer that has no Greenhouse user account, such as an outside referrer, so applications can be credited to them. Pass the returned id as referrer_id when creating or updating an application. name is matched case-insensitively against the organization's existing outside referrers (those not linked to a user, agency recruiter, or LinkedIn recruiter); when a match exists, that referrer is returned with a 200 instead of creating a duplicate. Requires the user to be able to manage the organization's custom options.

post/v3/referrers

Request

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

Request body

namestring required

Display name of the referrer, e.g. an outside referrer who has no Greenhouse account. Matched case-insensitively against the organization's existing outside referrers (those not linked to a user, agency recruiter, or LinkedIn recruiter); when a match exists, that referrer is returned instead of creating a duplicate.

Response

Existing referrer with a matching name

idinteger
created_atstring date-time
updated_atstring date-time
user_idinteger nullable

Id of the Greenhouse user this referrer maps to, when the referrer is an internal employee. null for referrers that are not Greenhouse users (e.g. external agency recruiters, social-share visitors, LinkedIn referrers) and for referrers whose underlying user has since been removed. This is not the same id space as applications.referrer_id — applications point at this referrer's id, not at user_id.

namestring

Display name of the referrer as it appears on the candidate's application under "Source & referrer" (the "Who Gets Credit" label). For employee referrals this is typically the referring user's name; for non-user referrers it is the name captured at referral time.

Changes

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