Skip to main content
GET
Get the calling app

Authorizations

Authorization
string
header
required

An API key of one app, sent as Authorization: Bearer <key>. Keys start with fk_test_ (test mode: sandbox senders and test data only) or fk_live_ (live mode). Keep live keys on your server; never ship them in an app or page.

Headers

Flow-Version
string<date>

The API version to use, as a date. Without it, the version pinned to your app when it was created is used.

Example:

"2026-11-01"

Response

The calling app.

Who is calling, as worked out from the API key.

account
object
required

A customer company. Holds the plan, billing and members. Every app belongs to one account.

app
object
required

One agent integration. Owns API keys (per mode), webhook endpoints and settings.

api_key
object
required

An API key's record. The key itself is shown once, at creation, and stored only as a hash.

livemode
boolean
required

true for a live key, false for a test key.

allowance
object

What the app may still send on the shared sandbox senders for free. Present only on apps that have one: apps made with POST /v1/sandbox/keys (anonymous, one allowance per app), and apps of people who signed in (signed_in, one allowance per person: every app the person owns or claimed draws on the same contacts and messages, so the counts here are the person's, over all those apps). Only messages your agent sends count, on the channels in channels; inbound messages are free. A contact counts once it joins an app on a sandbox sender, and keeps counting after it leaves. Sends past the allowance answer 403 permission with channel_code sandbox_allowance_used; a join past contacts.limit is refused in the chat.