Quickstart

Three minutes: a key, a request, an answer.

1. Create an API key

An owner or admin opens Developer → API keys in the app, names the key and ticks its scopes. The key is shown once; afterwards only its first characters are listed, and it can be revoked at any time.

2. Call /v1/users/me

curl https://api.a1merica.ai/v1/users/me \
  -H "Authorization: Bearer aim_live_3f9c1e2d0a7b4c5d6e8f90123456789a"

{
  "id": "9d8c7b6a-1f2e-4d3c-8b9a-0e1f2a3b4c5d",
  "email": "alex@example.com",
  "name": "Alex Roy",
  "extension": "101",
  "role": "owner",
  "status": "active",
  "presence": {"status": "available", "dnd": false},
  "created_at": "2026-08-01T12:00:00Z"
}

A key acts as the person who created it: it sees their lines, shared lines and company lines, never a colleague's private line. Create the key as the person whose lines the integration should watch.

3. Read calls

curl "https://api.a1merica.ai/v1/calls?limit=2&direction=inbound" \
  -H "Authorization: Bearer aim_live_…"

{
  "items": [
    {
      "id": "6b1f0d2a-7e0c-4f1a-9c3a-1d2e3f4a5b6c",
      "direction": "inbound",
      "result": "answered",
      "from": {"number": "+15145550100", "name": "Marie Tremblay", "user_id": null},
      "to":   {"number": "+16135550101", "name": "Front desk", "user_id": "9d8c…"},
      "started_at": "2026-09-24T14:02:11Z",
      "answered_at": "2026-09-24T14:02:19Z",
      "ended_at": "2026-09-24T14:05:40Z",
      "duration_s": 201,
      "user_id": "9d8c…",
      "number_id": "c4e1…",
      "recording": {"id": "6b1f…", "available": true},
      "transcript_available": false,
      "ai": null,
      "updated_at": "2026-09-24T14:05:41Z"
    }
  ],
  "next_cursor": "eyJ…",
  "sync_token": "eyJzaW5jZSI6…"
}

Lists page with limit (1–200) and cursor; a sync_token then brings back only what changed — see Sync tokens.

Conventions

• Base address: https://api.a1merica.ai/v1. Everything is JSON in UTF-8.
• Timestamps are ISO 8601 in UTC and end in _at; durations in seconds end in _s; money in cents ends in _cents.
• Phone numbers are E.164 (+15145550100); ids are UUIDs as strings.
• Every error has the same envelope — see Errors. Every response carries an X-Request-Id: quote it when you write to us.