Skip to main content
GET
Retrieve a business
The same shape as a row of List businesses. Read status and identityVerified to see where the business’s verification stands, or listen for account.updated.

Authorizations

x-api-key
string
header
required

Your secret key, from app.agentaos.ai -> Settings -> Developers -> API Keys. The key's prefix is both its identity and its environment: sk_test_... (sandbox, free, no verification) or sk_live_... (real money, requires business verification). A missing or invalid key returns 401.

Path Parameters

id
string<uuid>
required

The business UUID.

Response

The business.

A business you manage: a client's business, or another app of your own company. Every field is camelCase on the wire.

id
string<uuid>
required

Business UUID. Send it in AgentaOS-Account to act as the business.

name
string
required

The name buyers see.

country
string | null
required

ISO 3166-1 alpha-2.

status
enum<string>
required

Where the business stands. live = verified and with a payout account. changes_needed = we asked the business for a change.

Available options:
test_only,
in_review,
changes_needed,
on_hold,
rejected,
live
platformOrgId
string<uuid>
required

Your own id: the platform that manages it.

createdAt
string<date-time>
required
platformFee
object
required

Your share of its new sales, set in the dashboard: basis points of the price before VAT (1000 = 10%) plus a fixed amount in minor units.

true for another app of your own company: verified and priced with you, no share, no identity check of its own.

feesThisMonth
object[]
required

Your share of its live sales this month, per currency. feesDisplay is ready to show.

invitedEmail
string | null
required

Who an open invitation is waiting on, or null.

identityVerified
boolean
required

The identity check is done: its own, or your company's for another app of your own company.