Sign in

v1

latestOpenAPI 3.1.02026-07-261770816.7 KB
Job Posts

List job posts

Job posts are the candidate-facing listings of a job. A single job can have multiple posts — typically one per locale, geography, or audience — each published to either an external job_board (a public careers site or syndicated board like LinkedIn) or the organization's internal job board. Posts carry their own public title, HTML description, application form questions, and live state independent of the parent job.

get/v3/job_posts

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 posts belonging to these job (hiring plan) ids. Each job post is published against a single job.

job_board_idsinteger[]

Comma separated list

fieldsstring[]

Comma separated list of fields to return

activeboolean

Filter by whether the post is active (not deleted). Defaults to true; pass false to retrieve soft-deleted posts.

featuredboolean

Filter by featured status on the organization's internal job board. Only internal posts can be featured.

liveboolean

When true, return only posts that are published and whose job board is also live — equivalent to posts whose public_url is reachable. When false, return posts that are not published or whose board is not live.

internalboolean

Filter by post visibility. true returns posts on internal job boards (visible to employees); false returns external posts on public job boards. Omit to return both.

Response

Successful

idinteger
created_atstring date-time
updated_atstring date-time
titlestring

Public-facing title shown to candidates on the job board (e.g. Senior Backend Engineer, Remote). Distinct from the internal job.name — a single job can have several posts with different titles, one per board, language, or geography.

internalboolean

If true, the post lives on an internal job board and is visible only to existing employees signed in to the internal board. If false, the post is external and lives on a public-facing job_board. Set by the board the post is associated with at create time.

activeboolean

If true, the post has not been deleted. Deleted posts are excluded by default; pass active=false on the list endpoint to retrieve them.

liveboolean

If true, the post is published (job_application_status is live) and its job board is also live. A post on an unpublished board is not live — its public_url returns a 404 until the board is enabled.

featuredboolean

If true, the post is currently featured on the organization's internal job board and surfaces in the weekly internal-jobs email. Only internal posts can be featured, and at most three can be featured at a time.

first_published_atstring date-time nullable

Timestamp the post first transitioned to live, in ISO 8601. null for posts that have never been published.

contentstring nullable

HTML body of the post shown to candidates on the job board. For internal posts this returns the internal_content instead. Sanitized server-side — only a limited element/attribute allowlist (including iframe, video, source) survives. null while the post is still being scaffolded.

internal_contentstring nullable

HTML body shown on the internal job board when the post is also configured as internal. null for external-only posts. Same sanitization rules as content.

language'en' | 'zh' | 'zhHant' | 'nl' | 'fi' | 'fr' | 'de' | 'iw' | 'it' | 'ja' | 'ko' | 'no' | 'pl' | 'pt' | 'ru' | 'es' | 'se' | 'tg' | 'th' nullable

ISO 639-1 locale of the post, used to render the candidate-facing application form in the matching language (e.g. en, fr, ja). null when no locale has been chosen.

public_urlstring uri nullable

Canonical public URL of the post on its job board, including the gh_jid tracking parameter. null when the post has no associated job board or the board has no public URL configured.

demographic_question_set_idinteger nullable

Id of the demographic question set surfaced to candidates on this post for diversity, equity, and inclusion (DE&I) reporting. null when the post does not collect demographic data.

job_idinteger

Id of the parent job (requisition) this post belongs to. A single job can have multiple posts; the job is the source of truth for the hiring team, openings, and interview plan.

job_board_idinteger

Id of the job_board this post is published to. Resolves to either an external (careers site, syndicated board) or internal job board depending on internal. Each post belongs to exactly one board at a time.