User guide

Authentication

link Creating an API key

To use the kiwiHR API you must have an access key. An access key is an identifier that is used to authenticate requests associated with your company.

To get an access key:

  • 1. Go to Account -> API -> New access key
  • 2. Generate a new access key by entering the name
  • 3. Dialog displays newly generated access key

You might want to copy your key and keep it secure. You won't be able to reveal it. An API key once created can be only deleted.

link Using an API key

You must pass in an access key by using the HTTP X-Api-Key header. Don't forget to send Host containing your company subdomain.

POST /api/graphql HTTP/1.1
Host: subdomain.kiwihr.com
Content-Type: application/json
X-Api-Key: ‹YOUR API KEY›
 
{"query":"users { items { id } }"}