| API | Protocol | Base URL | Docs | Reference | OpenAPI | SDKs |
|---|---|---|---|---|---|---|
| Main | rest | https://rest.bullhornstaffing.com/rest-services | link | — | — | — |
Actions (50)
Saved Searches · 13
- Add saved search to favoritesPUT /rest-services/{corpToken}/savedSearchFavorite/{savedSearchId}
Mark a saved search as a favorite.
documented - Associate saved searchPUT /rest-services/{corpToken}/savedSearchAssociation/{savedSearchId}/{entityName}/{entityId}
Associate a saved search with an entity.
documented - Create saved searchPUT /rest-services/{corpToken}/savedSearch
Create a new saved Lucene search.
documented - Disassociate saved searchDELETE /rest-services/{corpToken}/savedSearchAssociation/{savedSearchId}/{entityName}/{entityId}
Remove an association between a saved search and an entity.
documented - Get saved search by IDGET /rest-services/{corpToken}/savedSearch/{savedSearchId}
Retrieve a saved search by its ID.
documented - Get saved search grantsGET /rest-services/{corpToken}/savedSearchGrants
Retrieve entitlements for saved searches.
documented - Get saved searches for an entityGET /rest-services/{corpToken}/savedSearch?entity={entity}&entityId={entityId}
Fetch saved searches associated with a specific entity.
documented - List saved searchesGET /rest-services/{corpToken}/savedSearch
Retrieve saved searches for the corporation; supports entity/entityId filters.
documented - List saved searchesGET /rest-services/{corpToken}/savedSearch
Return all saved searches in the corporation.
documented - Remove saved search from favoritesDELETE /rest-services/{corpToken}/savedSearchFavorite/{savedSearchId}
Remove a saved search from favorites.
documented - Remove saved search grantDELETE /rest-services/{corpToken}/savedSearchGrant/{savedSearchId}/{type}
Remove saved search entitlements.
documented - Set saved search grantPUT /rest-services/{corpToken}/savedSearchGrant/{savedSearchId}/{type}
Grant entitlements for a saved search to a target (CORP/DEPT/USER).
documented - Update saved searchPOST /rest-services/{corpToken}/savedSearch/{savedSearchId}
Update an existing saved search.
documented
Entity · 10
- Add to-many associationPUT /rest-services/{corpToken}/entity/{entityType}/{entityId}/{toManyAssociation}/{childIds}
Add to-many associations (child IDs) to a parent entity field.
documented - Create to-many associations on an entityPUT /rest-services/{corpToken}/entity/{parentEntityName}/{parentEntityId}
Create/associate to-many child records on the parent entity in a single call.
documented - Delete an entityDELETE /rest-services/{corpToken}/entity/{entityType}/{entityId}
Hard or soft delete the specified {entityType} by ID, depending on entity rules.
documented - Get entity by IDGET /rest-services/{corpToken}/entity/{entityType}/{entityId}?fields={fieldList}
Retrieve a single {entityType} by ID with specified fields.
documented - Get multiple entities by IDsGET /rest-services/{corpToken}/entity/{entityType}/{entityIds}?fields={fieldList}
Retrieve multiple {entityType} records by comma-separated IDs.
documented - List file attachmentsGET /rest-services/{corpToken}/entity/{entityType}/{entityId}/fileAttachments
List files attached to the given entity.
documented - List file attachmentsGET /rest-services/{corpToken}/entity/{entityType}/{entityId}/fileAttachments
Retrieve files attached to the given entity.
documented - Remove from to-many associationDELETE /rest-services/{corpToken}/entity/{entityType}/{entityId}/{toManyAssociation}/{childIds}
Disassociate to-many relationships from a parent entity.
documented - Update an entityPUT /rest-services/{corpToken}/entity/{entityType}/{entityId}
Update fields on an existing {entityType} by ID.
documented - Update an entity (POST)POST /rest-services/{corpToken}/entity/{entityType}/{entityId}
Update an existing {entityType} by ID using POST payload.
documented
Resume · 7
- Convert resume (JSON) with formatPOST /rest-services/{corpToken}/resume/convertToText|HtmlViaJson?format={format}
Convert resume JSON to specified format (text/html/etc.).
documented - Convert resume to text or HTMLPOST /rest-services/{corpToken}/resume/convertToText|Html
Convert resume to plain text or HTML.
documented - Convert resume via JSON to text/HTMLPOST /rest-services/{corpToken}/resume/convertToText|HtmlViaJson
Convert JSON-encoded resume to text/HTML.
documented - Parse HR-XML via JSONPOST /rest-services/{corpToken}/resume/parseToHrXmlViaJson
Parse HR-XML payload via JSON.
documented - Parse resume to CandidatePOST /rest-services/{corpToken}/resume/parseToCandidate
Parse an uploaded resume into Candidate data (multipart/file upload).
documented - Parse resume to HR-XMLPOST /rest-services/{corpToken}/resume/parseToHrXml
Parse a resume to HR-XML via file upload.
documented - Parse resume via JSON to CandidatePOST /rest-services/{corpToken}/resume/parseToCandidateViaJson
Parse resume text/blob provided in JSON to Candidate data.
documented
Authentication · 4
- Get OAuth login URLsGET /rest-services/loginInfo?username={API_Username}
Return the correct REST login URL and data center data for the provided user.
documented - Logout REST sessionGET /rest-services/{corpToken}/logout
Terminate the current REST session and invalidate the BhRestToken.
documented - Partner login (duplicate entry)POST /login?access_token={token}&version={version}
Same OAuth login path shown in REST docs.
documented - Partner login using OAuthGET /login?access_token={access_token}&version={version}
Obtain a REST session (BhRestToken) and base REST URL for subsequent calls.
documented
Metadata · 4
- Get all entity metadataGET /rest-services/{corpToken}/meta
Return metadata describing Bullhorn's entities for the corporation.
documented - Get metadata for an entityGET /rest-services/{corpToken}/meta/{entityName}
Return the metadata for a specific entity type.
documented - Get options by typeGET /rest-services/{corpToken}/options/{optionsType}
Get the value/label options for a given Options type.
documented - List all Options metadataGET /rest-services/{corpToken}/options
Get the list of supported option types (e.g., Country, State) and their endpoints.
documented
Mass Update · 3
- Get mass update propertiesGET /rest-services/{corpToken}/massUpdate/{entityType}
Return the properties for mass updates for the specified entity type.
documented - List mass-updateable entitiesGET /rest-services/{corpToken}/massUpdate
Return the list of entity types that support mass update.
documented - Mass update entitiesPOST /rest-services/{corpToken}/massUpdate/{entityType}
Apply mass updates to a list of entity IDs for the given entity type.
documented
Department · 2
- List department client contactsGET /rest-services/{corpToken}/departmentClientContacts?fields={fields}&start={start}&count={count}
List Candidate/ClientContact contacts within the user’s department.
documented - List department entitiesGET /rest-services/{corpToken}/department{Entity}s/?fields={fields}&start={start}&count={count}
List entities within the user’s departments for specified types.
documented
Query · 2
- Query an entity (GET)GET /rest-services/{corpToken}/query/{entity}?where={query}&fields={fields}&layout={layout}
Query an entity type using JPQL where clause; returns matching IDs/fields.
documented - Query an entity (POST)POST /rest-services/{corpToken}/query/{entity}
POST-based JPQL query for an entity; useful for long where clauses.
documented
Search · 2
- Search entities (GET)GET /rest-services/{corpToken}/search/{entity}?query={lucene}&fields={fields}
Lucene-based search for an entity type with field selection.
documented - Search entities (POST)POST /rest-services/{corpToken}/search/{entity}
POST-based Lucene search for an entity type; body contains query payload.
documented