Best Practices

We have some tips to help you get the most out of the HUVR API.

Check Response Codes

Do not assume the API called worked.

Our API uses HTTP response codes as recommended. Check the value of the status code and act accordingly. For example, a 429 indicates you need to throttle your API calls. This typically happens if a surge of requests come in all at once. Retry the request with a small wait added in.

The authentication token HUVR uses is short-lived. If you start to get a 401, your token needs to be refreshed.

In addition, user credentials are tied to specific roles and permissions. A 403 indicates this users is not allowed to perform the requested action.

Leverage the UI to test query params

Most of our endpoints include extensive query params to help you find the data you need. The reference documentation can be a bit overwhelming with the number of params available. The most used filters are built into our web application. You can try the filters in a HUVR table and see the query parameters used to call the API.

Only change what you need to

All our API objects support partial updates using the PATCH method. When updating an object only send the fields that have changed.