Skip to content

API referenceEndpoints

Account

The account a token works on.

The key behind this token

GET/v1/me

Which key the token belongs to, who owns it, its scopes and rate limits. With a partner key and AssistCall-Account, account is that client.

Headers

  • AssistCall-Accountstring (uuid)

    Partner keys: one of your clients' account ids (optional here).

Responses

  • 200The key.
    • keyobjectRequired
      Fields
      • idstring (uuid)Required

        The key's id.

      • namestringRequired

        The key's name.

      • client_idstringRequired

        The key's client id.

      • sandboxbooleanRequired

        Whether this is a read-only sandbox key, managed by AssistCall.

    • ownerobjectRequired
      Fields
      • typestringRequired

        A client account's key, or a partner's.

        One of: account, partner

      • idstring (uuid)Required

        The account or partner id.

      • namestringRequired

        Its name.

    • accountobject or any or nullRequired

      The account calls work on: the key's own, or the client in AssistCall-Account; null for a partner key without the header.

    • scopesarray of stringRequired

      The token's scopes.

    • rate_limitobjectRequired
      Fields
      • per_minuteintegerRequired

        Requests a minute.

      • per_dayintegerRequired

        Requests a UTC day.

    • token_expires_atstring (date-time)Required

      When this token expires.

    • 400invalid_requestA parameter or body field is missing or invalid; the message names it.
    • 401authenticationNo access token, or it’s invalid or expired (or, at the token endpoint, wrong client credentials).
    • 403permissionThe token lacks the scope, the IP isn’t allowed, the account isn’t active, or a sandbox key tried to write.
    • 429rate_limitToo many requests: wait Retry-After seconds.
    • 500serverSomething went wrong on our side. Retry with backoff.

    Errors share one shape. See Errors.

Example request

curl https://api.assistcall.ai/v1/me \
  -H "Authorization: Bearer $ASSISTCALL_TOKEN"

Example response (200)

{
  "key": {
    "id": "9e2d7c41-5a3b-4f8e-b1c6-2d4e6f8a0b13",
    "name": "CRM sync",
    "client_id": "ac_cli_4fK9pQ2mZ7rT1vX8bN3c",
    "sandbox": false
  },
  "owner": {
    "type": "account",
    "id": "6c1f4f0e-2b7d-4c51-9a43-0d8e5b7a9f10",
    "name": "Demo Dental"
  },
  "account": {
    "id": "6c1f4f0e-2b7d-4c51-9a43-0d8e5b7a9f10",
    "name": "Demo Dental"
  },
  "scopes": [
    "account:read",
    "calls:read"
  ],
  "rate_limit": {
    "per_minute": 60,
    "per_day": 10000
  },
  "token_expires_at": "2026-10-25T15:04:05.000Z"
}

Get the account

GET/v1/account

Scopeaccount:read

Partner keys send the client's account id in AssistCall-Account.

Headers

  • AssistCall-Accountstring (uuid)

    Partner keys: required. The account id of one of your clients; any other id gets 404. Client keys: optional, and must be the key's own account.

Responses

  • 200The account.
    • idstring (uuid)Required

      Account id.

    • namestringRequired

      Business name.

    • industrystringRequired

      Industry, e.g. healthcare.

    • websitestringRequired

      Website, or empty.

    • timezonestringRequired

      IANA time zone, e.g. America/New_York.

    • statusstringRequired

      Account status.

      One of: pending_payment, onboarding, active, past_due, suspended, canceled

    • planobjectRequired
      Fields
      • namestring or nullRequired

        Plan or package name.

      • minutes_includedintegerRequired

        Minutes included each billing period.

      • receptionistsintegerRequired

        Receptionists included.

      • numbersintegerRequired

        Phone numbers included.

    • current_period_startstring (date-time) or nullRequired

      Start of the billing period.

    • current_period_endstring (date-time) or nullRequired

      End of the billing period.

    • created_atstring (date-time)Required

      When the account was created.

    • 401authenticationNo access token, or it’s invalid or expired (or, at the token endpoint, wrong client credentials).
    • 403permissionThe token lacks the scope, the IP isn’t allowed, the account isn’t active, or a sandbox key tried to write.
    • 404not_foundNo such object in this account (ids from other accounts are “not found” too).
    • 429rate_limitToo many requests: wait Retry-After seconds.
    • 500serverSomething went wrong on our side. Retry with backoff.

    Errors share one shape. See Errors.

Example request

curl https://api.assistcall.ai/v1/account \
  -H "Authorization: Bearer $ASSISTCALL_TOKEN"

Example response (200)

{
  "id": "6c1f4f0e-2b7d-4c51-9a43-0d8e5b7a9f10",
  "name": "Demo Dental",
  "industry": "healthcare",
  "website": "",
  "timezone": "America/New_York",
  "status": "active",
  "plan": {
    "name": "Front Desk",
    "minutes_included": 100,
    "receptionists": 1,
    "numbers": 1
  },
  "current_period_start": "2026-10-13T00:00:00.000Z",
  "current_period_end": "2026-11-13T00:00:00.000Z",
  "created_at": "2026-09-02T17:20:00.000Z"
}

Try "token", "webhook signature", "rate limit" or "custom domain".