Contact Document REST APIs

For information on the BH4SF REST APIClosed API, or Application Programming Interface, is used by customers to create custom career portals or to take advantage of Data Mirror/DataMart. Bullhorn prefers to use REST API., see BH4SF REST API.

You can call a RESTful API for accessing documents stored in AWS that are associated with a Contact. This allows third-party integrations to access the resumes stored in AWS.

We have two endpoints for documents stored in AWS associated with a contact, (full documentation for which can be gotten through the Open API spec, see above).

The first API is:

Copy 
/services/apexrest/TR1/api/v1/contacts/{contactId}/documents

 

This will return a list of all documents associated with a given Contact ID.

The records will include fields such as:

  • Name
  • Type
  • IsDefault
  • CreatedDate

 

Copy 
[
    {
        "type": "Resume",
        "name": "CV_1.CV.pdf",
        "isDefault": false,
        "id": "xxxxxxxxxxxxxxxxxx",
        "extension": "pdf", 
        "createdDate": "2023-10-24T08:08:46.000Z",
        "contactId": "xxxxxxxxxxxxxxxxxx"
    },
    {
        "type": "Resume",
        "name": "CV_2.CV.docx",
        "isDefault": true,
        "id": "xxxxxxxxxxxxxxxxxx",
        "extension": "docx", 
        "createdDate": "2024-06-13T09:46:45.000Z",
        "contactId": "xxxxxxxxxxxxxxxxxx"
    }
]    

The second API is:

Copy 
/services/apexrest/TR1/api/v1/contact-documents/{documentId}/public-url

 

This will return a pre-signed URL which can be used to retrieve the document with the given ID.

Next Steps

For presigned URLs, permissions, and presigned URLs, see API Access Management.