Impartire
Create an account

API reference

Who is calling

Every path is under https://impartire.com/api/v1. Generated from the API’s own contract, openapi.json (OpenAPI 3.1), which you can load into any OpenAPI tool. Errors are Problems — see Conventions.

GET/api/v1/me

Who is calling: the key, its org, its scopes and its request budget

Any valid key may call it, whatever its scopes.

Scopes: any valid credential

Response 200Me

Who is calling: the credential, its org, its authority, its scopes and its request budget.

  • authority"org" | "user"required

    org: an org API key — its scopes, org-wide. user: an OAuth access token acting for one person — its scopes AND that person's own permissions, so it sees what they see and does what they may do.

  • orgobjectrequired

    The org this credential acts in.

    • idstring (uuid)required
    • namestringrequired
  • credential_class"standard" | "guarded"required

    guarded when the credential holds any guarded scope (runs:signal, delivery:write, schedules:write, channels:control, access:write, sharing:write); standard otherwise. A guarded key must expire within 90 days and acts at once. With a guarded token, each guarded action waits for its person to confirm it in impartire.

  • keyobject or nullrequired

    The API key, for authority: org; null for a token.

    • idstring (uuid)required
    • namestringrequired
    • scopesarray of stringrequired

      What this key may do. <resource>:write includes <resource>:read.

    • expires_atstring (date-time) or nullrequired

      When the key stops working, or null if it does not expire.

    • created_atstring (date-time)required
  • userobject or nullrequired

    The person a token acts for, for authority: user; null for a key.

    • idstringrequired
    • namestringrequired
    • emailstringrequired
  • client_idstring or nullrequired

    The OAuth client acting for the person (a URL for a client that published a metadata document); null for a key.

  • scopesarray of stringrequired

    What this credential may do. <resource>:write includes <resource>:read.

  • rate_limitobjectrequired
    • limitintegerrequired

      Requests allowed per window, per credential. Enforced approximately (per edge location, eventually consistent): a burst can exceed it before the first 429.

    • window_secondsintegerrequired
Other responses
  • 401 unauthenticated — no key, or an unknown, revoked or expired one.
  • 403 insufficient-scope — the key lacks a required scope.
  • 404 not-found.
  • 429 rate-limited — the key's request budget is spent; wait Retry-After seconds.
  • 500 internal.