The API

The HireFire web interface is powered by this API. Every user has it’s own API key. With it you can programmatically get/patch/post/delete your resources.

API STILL CHANGING
You're welcome to consume the API. However, we may introduce breaking changes in the coming months as we further improve it. We'll remove this message once we've finished refining it.

How it works

This is the API’s base url:

https://api.hirefire.io

The following headers will allow you to specify which version of the API you want to consume (v1), what data format you want to use (JSON), and how to authorize the request (Authorization Token):

Accept: application/vnd.hirefire.v1+json
Content-Type: application/json
Authorization: Token YOUR_API_KEY

For example, this is how you would fetch all of your applications:

curl https://api.hirefire.io/applications \
  -H "Accept: application/vnd.hirefire.v1+json" \
  -H "Content-Type: application/json" \
  -H "Authorization: Token YOUR_API_KEY"

Resulting in:

{
  "applications": [
    {
      "id": "d53a72ef-884e-4af3-aa25-824b631e2634",
      "account_id": "6439cf4f-1f98-48fb-8058-2bea32ef4e1f",
      "name": "hirefire",
      "custom_domain": "www.hirefire.io",
      "token": "ce4cd30d-f88b-4d37-a107-a4a8866d9576",
      "ssl": true,
      "restart_crashed_dynos": false,
      "created_at": "2015-01-01T00:00:00.000Z",
      "updated_at": "2015-01-01T00:00:00.000Z",
      "issue": null
    }
  ]
}

You can find your API key by logging into HireFire and clicking on the “Account” button in the sidebar.

The rest of this API section serves as a reference for all available endpoints.