Sign in

v1

latestOpenAPI 3.1.02026-07-261770816.7 KB
Notes

List notes

Notes are free-form entries on a candidate's profile — candidate notes, logged emails, system activity, interview feedback, and other entries that appear in the candidate activity feed. Each note is anchored to a candidate and optionally to a specific application. This endpoint returns every note type, including read-only entries (interview notes, scorecard-linked feedback, LinkedIn messages, touchpoints) that cannot be created through POST /v3/notes. For interview feedback and scorecard takeaways, use the Scorecards endpoints instead — they expose the structured form data, while this endpoint only exposes the underlying note body.

get/v3/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
candidate_idsinteger[]

Comma separated list

user_idsinteger[]

Return only notes authored by these Greenhouse user ids.

application_idsinteger[]

Comma separated list

fieldsstring[]

Comma separated list of fields to return

type'NOTE' | 'ACTIVITY' | 'INTERVIEW' | 'EMAIL' | 'FOLLOW_UP' | 'TAKE_HOME_TEST' | 'LINKEDIN_NOTE' | 'LINKEDIN_INMAIL' | 'AVAILABILITY_REQUEST' | 'MIGRATION_ERROR' | 'TOUCHPOINT' | 'FORM' | 'FEEDBACK'

Filter by note type. Matches the type field on the response (for example NOTE, EMAIL, ACTIVITY, INTERVIEW, FEEDBACK).

visibility'admin_only_visible' | 'privately_visible' | 'publicly_visible'

Filter by note visibility. publicly_visible is visible to anyone with access to the candidate, privately_visible requires the "see private notes" permission, and admin_only_visible is restricted to Job Admins and Site Admins.

Response

Successful

idinteger
created_atstring date-time
updated_atstring date-time
candidate_idinteger nullable

Id of the candidate this note is attached to. Notes are always anchored to a candidate; application_id is an optional second anchor for application-scoped notes.

application_idinteger nullable

Id of the application this note is attached to, when the note was authored against a specific application (for example a stage transition or a feedback note). null for candidate-level notes that are not tied to any single application.

bodystring nullable

Free-text body of the note. @-mentions are rendered as plain user names; use body_with_tags for the version that preserves mention markup. Newline characters are stored verbatim and rendered as line breaks in the Greenhouse UI.

subjectstring nullable

Subject line on the note. Always populated for EMAIL notes; usually null for other types.

type'NOTE' | 'ACTIVITY' | 'INTERVIEW' | 'EMAIL' | 'FOLLOW_UP' | 'TAKE_HOME_TEST' | 'LINKEDIN_NOTE' | 'LINKEDIN_INMAIL' | 'AVAILABILITY_REQUEST' | 'MIGRATION_ERROR' | 'TOUCHPOINT' | 'FORM' | 'FEEDBACK'

Note classification. NOTE and EMAIL are user-authored candidate notes and logged emails; ACTIVITY covers system-generated activity feed entries plus partner-logged activities. Other values (INTERVIEW, FEEDBACK, TOUCHPOINT, FOLLOW_UP, TAKE_HOME_TEST, LINKEDIN_NOTE, LINKEDIN_INMAIL, AVAILABILITY_REQUEST, FORM, MIGRATION_ERROR) identify notes produced by specific Greenhouse features and are read-only via this API.

user_idinteger nullable

Id of the Greenhouse user who authored the note. null for notes generated by the system rather than a specific user.

email_fromstring nullable

Comma-separated list of From addresses on the logged email. Only populated when type is EMAIL.

email_tostring nullable

Comma-separated list of To addresses on the logged email. Only populated when type is EMAIL.

email_ccstring[] nullable

Cc addresses on the logged email, one entry per recipient. Only populated when type is EMAIL.

import_hashstring nullable

Stable de-duplication key set when the note was created by a bulk import or migration. null for notes authored through the UI or Harvest. Use it to detect re-runs of the same import.

body_with_tagsstring nullable

body with @-mentions rendered as embedded user tags (e.g. @[User Name](user:123)) instead of plain user names, for partners that need to resolve mentioned users.

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

Who can see this note. publicly_visible is visible to anyone with access to the candidate, privately_visible is restricted to users with the "see private notes" permission, and admin_only_visible is restricted to Job Admins and Site Admins. Defaults to admin_only_visible on create.

email_attachment_file_namesstring nullable

File names of attachments on the logged email, when the source captured them. Only populated when type is EMAIL.