Sign in

v1

latestOpenAPI 3.1.02026-07-261770816.7 KB
Job Notes

List job notes

Job notes are free-form, organization-internal notes attached to a job (the requisition). They capture hiring-team context about the role itself and are distinct from candidate notes, which are attached to a candidate or application. Each note has a visibility that controls whether it is readable by Job Admins on the job or further restricted to users with the "view and create private job notes" permission.

get/v3/job_notes

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 notes attached to these job (hiring plan) ids.

user_idsinteger[]

Return only notes authored by these Greenhouse user ids.

fieldsstring[]

Comma separated list of fields to return

visibility'admin_only_visible' | 'privately_visible'

Filter by note visibility. admin_only_visible returns notes visible to Job Admins on the job; privately_visible returns notes restricted to users with the "view and create private job notes" permission.

Response

Successful

idinteger
created_atstring date-time
updated_atstring date-time
job_idinteger

Id of the job this note is attached to. Job notes are always anchored to a single job and are not shared across jobs.

user_idinteger

Id of the Greenhouse user who authored the note.

bodystring nullable

Free-text body of the note. Newline characters are stored verbatim and rendered as line breaks in the Greenhouse UI.

visibility'admin_only_visible' | 'privately_visible' | 'null' nullable

Who can see this note. admin_only_visible is restricted to users with Job Admin or higher access on the job; privately_visible is further restricted to users with the "view and create private job notes" permission on the job.