Sign in

v1

latestOpenAPI 3.1.02026-07-261770816.7 KB
Tracking Links

List tracking links

Tracking links are unique short URLs (e.g. https://grnh.se/<token>) that an organization shares to attribute candidates to a source — campaign URLs, referral links, employee outreach, social posts, and third-party board placements. When a candidate applies through a tracking link, the application inherits the link's source_id and any related attribution (referrer, related post). Each link belongs to exactly one organization and is scoped to a job, job board, or job post.

get/v3/tracking_links

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

Return only tracking links attached to these job (hiring plan) ids. A tracking link points at the careers page or a specific job post for these jobs.

source_idsinteger[]

Comma separated list

referrer_idsinteger[]

Return only tracking links attributed to these referrer ids. A referrer is the Greenhouse Referrer record (see GET /v3/referrers) — not a user id. Look up the referrer id for a user via that endpoint first.

job_board_idsinteger[]

Comma separated list

job_post_idsinteger[]

Comma separated list

related_post_idsinteger[]

Return only tracking links generated for these related_post ids — the external post the link was distributed on (e.g. a tweet, LinkedIn post, or ProgrammaticSourcing::AppcastJobAd). Pair with related_post_type to disambiguate, since related_post is polymorphic.

fieldsstring[]

Comma separated list of fields to return

tokenstring

Return the tracking link with this exact short-URL token (the gh_src value). Useful for resolving an incoming application's gh_src back to the link that generated it.

related_post_typestring

Filter by the polymorphic related_post class name (e.g. Application, ProgrammaticSourcing::AppcastJobAd). Combine with related_post_ids to narrow to a specific record of that type.

Response

Successful

idinteger
created_atstring date-time
updated_atstring date-time
job_idinteger nullable

Id of the job this tracking link is scoped to. null when the link targets a job board or a job post rather than a specific job.

tokenstring

Unique short-URL token appended to the link as gh_src=<token>. Resolves to the full URL https://grnh.se/<token> and is the value Greenhouse uses to attribute incoming applications back to this link.

source_idinteger nullable

Id of the source credited when a candidate applies through this link. Applications submitted via the link inherit this source_id. null for links created before a source was selected.

related_post_idinteger nullable

Id of the polymorphic record the link is associated with (e.g. a programmatic job ad, a social media post). Use together with related_post_type to resolve the referenced record. null for links not tied to a related post.

related_post_typestring nullable

Class name of the polymorphic related_post record (e.g. Application, ProgrammaticSourcing::AppcastJobAd). null for links not tied to a related post.

referrer_idinteger nullable

Id of the referring user credited with surfacing the candidate. Populated for employee-referral links so the referring user is attributed when the candidate applies. null when the link is not a referral link.

job_board_idinteger nullable

Id of the job_board this link targets. Set when the link points at an entire board rather than a specific job or post. null when the link is scoped to a job or job post.

job_post_idinteger nullable

Id of the job_post this link targets. Set when the link points at a specific public-facing post. null when the link is scoped to a job or job board.