Actions87
- Appointment Actions
- Candidate Actions
- Company Actions
- Contact Actions
- File Actions
- Job Actions
- Job Submission Actions
- Lead Actions
- Note Actions
- Opportunity Actions
- Placement Actions
- Sendout Actions
- Task Actions
- Tearsheet Actions
Appointment → Query
AI-generatedSummary
Query Appointment entities in Bullhorn using a JPQL WHERE clause with optional field selection and result limiting.
Inputs
- Authentication (required) — Choose between User Credentials (Email & Password) or Enterprise Credentials (API Key) for authentication.
- Where Clause (required) — JPQL WHERE clause to filter Appointment records, e.g., "id > 0 AND status = 'Active'".
- Fields — Specify Bullhorn Appointment fields to return. Optionally rename fields in output by setting the Output Name.
- Limit — Maximum number of Appointment records to return (minimum 1, maximum 500). Defaults to 20.
- Hide Deleted — Optionally exclude deleted or archived records by adding appropriate filtering to the query. Defaults to true.
- Enable Operations Log — Toggle to emit an audit log entry to a secondary output for write operations. Defaults to false (not used for query).
- Output Fields — Fields to include in every output item merged into each result for additional contextual data.
Output shape
a list of Appointment records matching the query
Each returned record includes the requested fields with optional field renaming applied. Results are limited by the provided Limit parameter. The query excludes deleted records if Hide Deleted is true by adding an isDeleted=false condition where applicable. No pagination beyond the limit parameter is applied. An optional second output with operation logs is not emitted for queries.
Examples
Example 1: Retrieve up to 50 active Appointments created after January 1, 2023, returning id, date, and status fields.
Authentication with Enterprise Credentials; Where Clause: "dateAdded > '2023-01-01' AND status = 'Active'"; Fields: id, date, status; Limit: 50
Example 2: Query all non-deleted Appointments and rename 'id' field to 'appointmentId' in output.
Authentication with User Credentials; Where Clause: "id > 0"; Fields mapping: Bullhorn field 'id' with Output Name 'appointmentId'; Hide Deleted: true; Limit: 20 (default)