get_notes
Read canonical notes and note_created events for one Bullhorn record by target type and id, or by candidate, job, contact, placement, or submission id.
Instructions
Read canonical notes (and their note_created events) for one record.
Exactly one primary scope is required: target_type + target_id, or one of candidate_id, job_id, client_corporation_id, client_contact_id, placement_id, submission_id. Only verified Bullhorn mechanisms are used; a scope or filter without one returns status "unsupported_filter" with the supported filters (it is never approximated).
Args: target_type: "candidate", "job", "client_contact", "client_corporation", "placement" or "submission". target_id: The record id for target_type. candidate_id: Primary scope: a candidate id. job_id: Primary scope: a job id. client_corporation_id: Primary scope: a client corporation id. client_contact_id: Primary scope: a client contact id. placement_id: Primary scope: a placement id. submission_id: Primary scope: a submission id. action_type: A tenant note action value (validated; never substituted). author: A Bullhorn user id or name. date_from: Inclusive ISO-8601 date or datetime with offset (a date means midnight in the reporting timezone). date_to: Exclusive ISO-8601 date or datetime with offset. include_deleted: Include deleted notes (default false). limit: Page size, 1 to 50 (default 20). start: Offset of the page (default 0).
Returns: JSON with status, notes, events, next_start, truncated and warnings.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| limit | No | ||
| start | No | ||
| author | No | ||
| job_id | No | ||
| date_to | No | ||
| date_from | No | ||
| target_id | No | ||
| action_type | No | ||
| target_type | No | ||
| candidate_id | No | ||
| placement_id | No | ||
| submission_id | No | ||
| include_deleted | No | ||
| client_contact_id | No | ||
| client_corporation_id | No |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| result | Yes |