Sign in

v1

latestOpenAPI 3.1.02026-07-261770816.7 KB
Job Boards

List job boards

A job board is a destination an organization publishes job posts to — either the organization's single internal board (visible only to signed-in employees) or one of its external boards (public careers site, embedded iFrame, or syndicated integration). Each job_post belongs to exactly one board, and board-level fields like introduction, conclusion, and company_name are applied to every post on the board. Only boards whose status is live serve public traffic at https://job-boards.greenhouse.io/{url_token}.

get/v3/job_boards

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

Comma separated list of fields to return

internalboolean

Restrict results by audience. Pass true to return only the organization's internal job board, or false to return external (public-facing) boards. Omit to return both.

liveboolean

Restrict results by publication state. Pass true to return only boards currently published at https://job-boards.greenhouse.io/{url_token}, or false to return draft (unpublished) boards. Omit to return both.

Response

Successful

idinteger
created_atstring date-time
updated_atstring date-time
company_namestring nullable

Display name shown to candidates at the top of this board's careers page (e.g. Acme, Inc.). Edited per board, so an organization with multiple boards can present a different brand on each.

url_tokenstring nullable

Globally unique slug that identifies this board in public URLs (e.g. acme in https://job-boards.greenhouse.io/acme). Tokens are reserved across all Greenhouse customers — a token freed by a deactivated organization is not automatically reusable. Always internal for the organization's internal board.

internalboolean

If true, this is the organization's internal job board — accessible only to signed-in employees and rendered through the internal-board iFrame. If false, the board is external (public careers site or syndicated integration). Every organization has exactly one internal board and may have many external boards.

status'draft' | 'live'

Publication state of the board. draft covers newly created and unpublished boards; their posts are not publicly viewable. live boards are published — only live boards serve traffic at https://job-boards.greenhouse.io/{url_token}, and a post on a non-live board returns 404 regardless of the post's own live flag.

aboutstring nullable

Sanitized HTML company description shown on the board's landing page above the list of open posts. Rendered with a limited element/attribute allowlist. null when unset.

introductionstring nullable

Sanitized HTML prepended to every job and prospect post on this board (the board's standardized post introduction). Use this to surface a board-wide company overview without editing each post. null when unset; included in V3 job_post.content responses by default.

conclusionstring nullable

Sanitized HTML appended to every job and prospect post on this board (the board's standardized post conclusion). Typically used for benefits, EEO statements, or apply-process notes. null when unset; included in V3 job_post.content responses by default.