Projects API

Aragorns partner api allows you to access your standardized project data via API

Conventions

The base URL to send all API requests is:

https://prod-partner-gateway.api.aragorn.ai

HTTPS is required for all API requests. The Aragorn API follows RESTful conventions when possible, with most operations performed via GET, POST, PATCH, and DELETE requests on project resources. Request and response bodies are encoded as JSON

Authentication

Requests use the HTTP x-aragorn-api-key and x-aragorn-org-id header to both authenticate and authorize operations. The Aragorn API accepts values in these headers. These values can be generated by:

Login to the Aragorn platform
Navigate to Projects → View project API

3. Copy down your x-aragorn-org-id which will be provided in the headers of your API request

4. Click the Generate a key button to generate the x-aragorn-api-key

API Reference

GET Projects

Request

--request GET
--url "{BASE_URL}/projects"
--header "accept: application/json"
--header "x-aragorn-org-id: {ORG_ID}"
--header "x-aragorn-api-key: {PROJECTS_API_KEY}"

Response

{
  "page": 1,     
  "pageSize": 50,     
  "totalCount": 3,     
  "totalPages": 1,     
  "data": [
            {             
              "id": "9e72c39a-1083-42f1-ac06-112ec84e235d",             
              "name": "SomeCorp Inc",             
              "description": "SomeCorp's Global HR data",             
              "isDefault": false         
            }
          ]
}

GET Project Data Downloadable File

Request

--request GET
--url "{BASE_URL}/projects/{PROJECT_ID}/employees/as-data-feed"
--header "accept: application/json"
--header "x-aragorn-org-id: {ORG_ID}"
--header "x-aragorn-api-key: {PROJECTS_API_KEY}"

Response

{   
  url: "downloadable_file_url"
}

GET Employees

This api allows you to get paginated employee records that have changed in a project every time the project source data syncs. Whenever a project source is synced, a readToken(the same as the sync job ID) is generated for each sync. Thus, when you call this api with a readToken, it returns the changed data during that particular sync in time. In order to get the readToken auto sent to you for a sync, you must setup a web-hook where Aragorn will notify you whenever change data in your project is available after sources are synced. To get the web-hook credentials you setup during the api key creation,

Navigate to the api key you generated in step 4
Click to open the Webhook and copy the credential to setup your webhook

Query Params	Detail
readToken	string (Optional)
page	number (Optional)

Setting the readToken to empty will return every record in the project

Request

--request GET
--url "{BASE_URL}/projects/{PROJECT_ID}/employees"
--header "accept: application/json"
--header "x-aragorn-org-id: {ORG_ID}"
--header "x-aragorn-api-key: {PROJECTS_API_KEY}"

Response

{   
  "page": 1,
  "pageSize": 50,   
  "totalCount": 3,   
  "totalPages": 1,   
  "data": [     
            {       
              "external_employee_id": "109876",       
              "first_name": "Janet",       
              "last_name": "Jackson",       
              "is_terminated": true,       
              ...     
            }   
          ] 
}

Conventions

Authentication

API Reference​

GET Projects

GET Project Data Downloadable File

GET Employees

API Reference