Testing

You can test the API directly from the "Try It!" option in the interactive API reference guide. This feature helps you understand how the API works and verifies that your parameters and permissions are set correctly.

Here's how to use it:

1. Go to the specific API endpoint you want to test in the documentation.
2. From the testing pane on the right, click Try It! .
3. Click Base URL to select whether to test with Production server or with the Sandbox server.

   Note: The Sandbox capability is available only for accounts that have purchased Sandbox. To learn more, see HiBob's HRIS features).

4. From the Basic authorization, enter your service user's credentials:

• Enter the service user's ID in the username field.
• Enter the corresponding token in the password field.

  Don't have a service user yet? Check the API Service Users guide

5. From Body Params, update path parameters or query parameters if required.
6. If the request includes body parameters, click the Examples pulldown menu and select Request Example to copy the parameters from the endpoint’s description into the HTTP request.
7. Click Try It! to execute the API call.
8. Check the Responses section to see the results of your API request, including the status code, headers, and any returned data.

📘

Error 403 (Forbidden)

If you receive an empty response or error 403, it likely means the permissions do not allow you to access the data you are trying to fetch. You should check your permissions settings, amend the permissions, and try again.