Detailed information available at https://clayhr.readme.io

Introduction

ClayHR APIs provide robust integration options to interact with the data, in much the same way as the web application.  Users can get their API keys from the ClayHR portal and start using the services immediately.  The calls follow the RESTful architecture and naming, and are secured via https, just like calls from the web browsers.

The API key has the same security access as the user to whom the key belongs.

Obtaining your API key and User ID

ClayHR APIs accept an API key via HTTP request Authorization Header. Each user can get Authorization API key (also called x-api-key)  from within the application using these steps:

1. Hover over your user record in the top right crner.
2. Scroll down to My Integration and then click on Manage API keys option.  
3. Click on Generate API key as shown in the screenshot below.
4. The API key generally needs the user ID that you can obtain from your user record page.

Invoking API End Points

For accessing the ClayHR API services, you to go through following steps:

1. Get an API key, user ID and domain url (URL specified byClayHR) as specified above.  The domain of your account is generally of the form https://yourcompany.clayhr.net/rm/
2. Refer to individual articles to get the exact end point and the request and response provided by them.
3. Endpoint user will send a HTTP request with HTTP header contains access token for key Authorization and application/json value for key Content-Type.

Example

To get Goals list

URL - https://yourcompany.clayhr.net/rm/goal/

Request type - GET

HTTP Header - Authorization:{"userId" : 123, "apiKey": "czMDRkMjBjOWY0MkjlXg2s23g13X"}

Content-Type: application/json