This guide will help you quickly get set up and start using the Hiringbranch Assessment API.

​
1. Obtain an API Key

All requests to the Hiringbranch Assessment API require an API key for authentication. To obtain your API key, please contact our team.

​
2. Authentication

For details on authentication, please refer to the Authentication Documentation.

​
3. Base URL

The base URL for the Hiringbranch Assessment API is:

https://api.hiringbranch.com/connect

All API endpoints are relative to this base URL.

​
4. Making Your First Request

Here’s an example of how to make a simple request to retrieve a list of assessments using curl:

curl -X GET \
  https://api.hiringbranch.com/connect/v1/assessment \
  -H 'X-API-Key: YOUR_API_KEY'
  -H 'instance: YOUR_INSTANCE'

Response

A successful request will return a JSON response containing a list of assessments.

​
5. Next Steps

  • Explore the API documentation to discover the available endpoints and their functionalities.
  • Check out the examples section for more detailed use cases.
  • If you have any questions or need assistance, please contact our support team at dev-support@hiringbranch.com.