Skip to main content
GET
Use it to confirm a new key works, and to see which agency it belongs to, which broker it acts as by default, its type and scopes, and its mode. See authentication.

Authorizations

Authorization
string
header
required

bl_live_… or bl_test_… API key.

Headers

Bridgeline-Version
string

API version (a date). Defaults to 2026-09-23; echoed on every response.

Pattern: ^\d{4}-\d{2}-\d{2}$

Response

The principal summary.

Who the calling API key acts as.

object
string
required
Allowed value: "whoami"
livemode
boolean
required

false for bl_test_ keys.

brokerage
object
required
acting_broker
object
required
api_key
object
required
api_version
string
required

The resolved Bridgeline-Version for this request.