Skip to main content
Five minutes, one curl.

​
1. Generate a key

In the OpenQuota admin, open Settings → API Keys and click New key. Pick:
  • A name (so you can identify it later).
  • A set of scopes. For this quickstart, grant deals:read and earnings:read.
Copy the key when it’s shown — it starts with oqp_. OpenQuota only shows it once. If you lose it, revoke and rotate.
Treat the key like a password. Put it in a secrets manager. Never commit it to source control.

​
2. Call the API

curl https://api.openquota.ai/v1/ \
  -H "Authorization: Bearer oqp_your_key_here"
You should get back JSON describing your key: its prefix, the scopes it has, and the list of endpoints you can reach. 
{
  "api_version": "v1",
  "authenticated_as": {
    "key_id": "ak_...",
    "key_prefix": "oqp_abcd",
    "scopes": ["deals:read", "earnings:read"]
  },
  "endpoints": [
    "GET  /v1/deals",
    "POST /v1/deals/events",
    "GET  /v1/earnings",
    "GET  /v1/earnings/:id",
    "GET  /v1/plans",
    "GET  /v1/plans/:id?include=chips"
  ]
}

​
3. Read some deals

curl "https://api.openquota.ai/v1/deals?limit=10" \
  -H "Authorization: Bearer oqp_your_key_here"
You’ll get a page of your org’s current deal projections, newest first. Pagination is cursor-free — pass ?limit=N&offset=M.

​
4. Read an earning

curl https://api.openquota.ai/v1/earnings/ern_01abc... \
  -H "Authorization: Bearer oqp_your_key_here"
Earnings come back with a trace field — that’s the exact chip evaluation history that produced the commission amount. Pass it along with the amount to your finance team or rep dashboard.

​
Next

Push deal events

Stream deal changes in from wherever you track them.

Webhooks

Subscribe to outbound events so you learn about new earnings in real time.