Businesses

Retrieve a business

One business you manage, the same shape as a row of the list. A business you do not manage and an id that does not exist get the same 403, so the response never confirms an id.

get/gateway/businesses/{id}

Request

  • Base URL: https://api.agentaos.ai/api/v1
  • URL: https://api.agentaos.ai/api/v1/gateway/businesses/{id}
  • Auth: API key in header x-api-key

Path parameters

idstring uuid required

The business UUID.

Response

The business.

idstring uuid required

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

namestring required

The name buyers see.

countrystring nullable required

ISO 3166-1 alpha-2.

status'test_only' | 'in_review' | 'changes_needed' | 'on_hold' | 'rejected' | 'live' required

Where the business stands. live = verified. A bank account is needed before the first payout, not for this status. changes_needed = we asked the business for a change.

platformOrgIdstring uuid required

Your own id: the platform that manages it.

createdAtstring date-time required
sameLegalEntityboolean required

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

invitedEmailstring nullable required

Who an open invitation is waiting on, or null.

identityVerifiedboolean required

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

Changes

No recorded changes to this operation across all 1 revision of this API.