Skip to content

Supported Entities

Jump to bottom
Peter Monroe edited this page Jan 18, 2024 · 51 revisions

Bullhorn's Rest API Documentation lists all possible entities that may be accessed via REST. Note that these entities may not all be turned on for your Bullhorn configuration. They break down into the following categories:

Primary Entities

These entities are at the top most level in the application, and each have their own list and search results.

  • ClientCorporation (a.k.a. Company)
  • ClientContact (a.k.a. Contact)
  • Candidate
  • JobOrder (a.k.a. Job, JobPosting)
  • JobSubmission (a.k.a. Submission)
  • Placement
  • Lead
  • Opportunity

Secondary Entities

These entities reference or are referenced by Primary Entities. For example, a Candidate record can reference a Skill or Country code, or a Note can reference a Candidate.

Reference and Modify

These secondary entities can be referenced from other entities, and can themselves be added/updated using DataLoader. If they are referenced from other entity records and do not exist (using the <EntityName>ExistField), they will be created first, then referenced.

  • Appointment
  • AppointmentAttendee
  • BillingProfile
  • Branch
  • CandidateEducation
  • CandidateReference
  • CandidateWorkHistory
  • CandidateTaxInfo (cannot be added or deleted - see FAQ)
  • FederalTaxForm
  • GeneralLedgerAccount
  • GeneralLedgerSegment1...GeneralLedgerSegment5
  • GeneralLedgerServiceCode
  • HousingComplex
  • InvoiceStatementMessageTemplate
  • InvoiceTerm
  • LocalTaxForm
  • Location
  • Note
  • PlacementChangeRequest
  • PlacementCommission
  • Sendout
  • StateTaxForm
  • Task
  • Tearsheet
  • WorkersCompensation
  • WorkersCompensationRate (must be added separately from WorkersCompensation - see FAQ)

Reference-Only

These secondary entities can be referenced from other entities, but they cannot be created or modified directly using REST, which means that they cannot be given as the entity to be added/updated on the command line, and they must exist in the system before being referenced from another entity record.

  • BusinessSector
  • Category
  • Certification
  • CorporationDepartment
  • CorporateUser
  • Country
  • Skill
  • Specialty
  • State

Custom Objects

These entities must be configured in Bullhorn Admin in order to be available via REST. The names of the Custom Objects follows the pattern: <EntityName>CustomObjectInstance<#>. There are ten available Custom Objects for each supported entity. Here are the available entity names:

  • ClientCorporationCustomObjectInstance1 ... ClientCorporationCustomObjectInstance35
  • JobOrderCustomObjectInstance1 ... JobOrderCustomObjectInstance10
  • OpportunityCustomObjectInstance1 ... OpportunityCustomObjectInstance10
  • PersonCustomObjectInstance1 ... PersonCustomObjectInstance35
  • PlacementCustomObjectInstance1 ... PlacementCustomObjectInstance10

Deletable Entities

Entities in Bullhorn can be either hard deleted (removed from the database completely) or soft deleted (the isDeleted field is set to true). The delete command is the same in DataLoader for all entities. All other entities not in one of these lists is not deletable via REST, and will return an error when attempting to delete in DataLoader.

Hard Deletable Entities

  • AppointmentAttendee
  • PlacementCommission
  • Sendout
  • Custom Objects

Soft Deletable Entities

  • All other entities except for ClientCorporation - they can only be archived
Clone this wiki locally