API keys

Keys let other systems push schedules, estimates and actuals into Earnest and read pacing summaries back. The full reference is in docs/API.md.

Try it nowdemo key

In demo mode there is one public key. It reads the sample data, and it checks everything you send, but it stores nothing. It is not a secret:

ek_demo_public

For example, how the deal with CRM id d-103 is pacing:

curl -H "Authorization: Bearer ek_demo_public" \
  https://YOUR-SITE/api/v1/deals/d-103/pacing

What a key can be allowed to do

`read:pacing`	Read pacing summaries for a deal or an account.
`write:schedules`	Push a deal's schedule or dated estimates.
`write:actuals`	Push what was actually delivered on a deal.

Each key may make 600 requests a minute. A key is shown once when it is made; only a scrambled copy is kept, so nobody — including us — can read it back. A key can be switched off at any time and stops working at once.

Under each key is how its pushes are going. The key can read the same summary for itself at GET /api/v1/status. A refused push is kept for 30 days with its reason, so it can be fixed and sent again.

Your keys

In your own workspace you can make keys here, choose what each may do, and switch one off at any time. Each key also shows how its pushes are going: the last one stored, the last one refused, the counts for the last 7 days, and the latest refused pushes with the reason for each. Sign in with Pipedrive to use it.