Authentification

---

Foreword

An API Key can be created by your onboard administrator in the settings. The administrator can define the scope of permissions of your API Key, to restrict the data you can access.

API key has to be included in all API requests to the server in a header that looks like the following:

{
  API-KEY: YOUR-API-KEY
}

You can find more information in the Help Center.

Examples

You can authenticate to our API by passing your API Key in the header, here are a few possibilities.

JavaScript

xhr.setRequestHeader("API-KEY", "YOUR-API-KEY");

Shell

curl "https://YOUR-BUSINESS.onboard.org/services/api/v1/employees" -H "API-KEY: YOUR-API-KEY"

Python

headers = {
  "API-KEY": "YOUR-API-KEY",
}