Authentication - Engrate Developer Documentation

All requests to the Engrate API must include an API key. The API key identifies your company. The API then gives you access only to the data of your company.

Get an API key

If your company does not have access to the Engrate Console yet, contact us.

Sign in to console.engrate.io.
Go to API keys.
Select +.
If you want, give the key a name. Then select Create.
Copy the key.

The console shows the key only one time. If you lose the key, make a new key.

Console page listing API keys with name, key prefix and creation date — API keys in the console

Send the API key in a request

Put the API key in the authorization header of each request. Do not add a prefix such as Bearer before the key.

curl --request GET \
  --url "https://api.engrate.io/schedule-management/v1/schedules" \
  --header "authorization: $API_KEY"

Errors

Status	Cause
`403`	The request has no `authorization` header.
`401`	The API key is not correct.
`429`	You sent too many requests in a short time. Wait the number of seconds in the `Retry-After` header, then send the request again.