Sign in

v1

latestOpenAPI 3.1.02026-07-261770816.7 KB
Referrers

List referrers

Referrers are the people credited with bringing a candidate into the pipeline — typically employees making referrals, but also agency recruiters, LinkedIn recruiters, or any other party captured under "Who Gets Credit" on a candidate's application. Each row is one referrer in the organization; resolve a referrer for an application by joining applications.referrer_id to this resource's id. A referrer is distinct from a Greenhouse user and from a source: user_id may link a referrer to a user when one exists but is often null, and the Referral source on an application tells you the channel while the referrer tells you the specific person credited. Filter to a single user's referrer records with user_ids. This endpoint is read-only; referrers are created and edited through the Greenhouse UI, not the Harvest API.

get/v3/referrers

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
user_idsinteger[]

Return only referrer records made by these Greenhouse user ids. The user here is the Greenhouse user who made the referral; the resulting Referrer record is a separate entity (with its own id) attributed to that user.

fieldsstring[]

Comma separated list of fields to return

Response

Successful

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.