Mercury: Get organization information
Mercury organization.getOrganization: arguments, response, policy and SDK examples.
← Organization operations · Get started
Operation mercury.getorganization
Provider route: GET /organization. Alter supplies the connection’s credentials and routing.
Call through Alter
Section titled “Call through Alter”Install @alter-ai/sdk @alter-ai/mercury with npm, or alter-sdk-mercury with pip. Supply your connected customer’s grant ID and the arguments described below.
import { App } from "@alter-ai/sdk";import { MercuryIntegration } from "@alter-ai/mercury";
async function execute(input: Parameters<MercuryIntegration["organization"]["getOrganization"]>[0]) { const app = new App({ apiKey: process.env.ALTER_API_KEY! }); try { const provider = new MercuryIntegration(app, { grantId: process.env.PROVIDER_GRANT_ID! }); const call = await provider.organization.getOrganization(input); const result = await call.wait(); return result.bodyJson(); } finally { await app.close(); }}import osfrom alter_sdk import Appfrom alter_sdk_mercury import MercuryIntegration
async def execute(arguments): async with App(api_key=os.environ["ALTER_API_KEY"]) as app: provider = MercuryIntegration(app, {"grant_id": os.environ["PROVIDER_GRANT_ID"]}) call = await provider.organization.get_organization(arguments) result = await call.wait() return result.body_json()| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Additional keys: not allowed |
Response
Section titled “Response”Response media type: application/json. The table describes the pinned successful response. Referenced models link to their complete fields.
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | Model | Root | Expand Get organization information — response body |
Referenced models: Get organization information — response body
Schemas
Section titled “Schemas”Get organization information — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Response containing organization details. |
organization | JSON | Required within parent | |
organization (allOf 1) | Model | All variants apply | Expand Get organization information — response body — organization Organization information |
organization (allOf 2) | JSON | All variants apply | Organization information |
Referenced models: Get organization information — response body — organization Organization information
Get organization information — response body — organization Organization information
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Organization information |
billingCadence | JSON | Required within parent | |
billingCadence (allOf 1) | string | All variants apply | Known values: monthly, annual |
billingCadence (allOf 2) | JSON | All variants apply | How often the organization is billed for its current subscription. Always "monthly" when the tier is "free". |
dbas | array | Required within parent | List of DBAs (Doing Business As names) for this organization |
dbas[] | Model | Each item | Expand Get organization information — response body — organization Organization information dbas item |
ein | JSON | Optional | |
ein (anyOf 1) | string | Alternative | Employer Identification Number (EIN), if available |
ein (anyOf 2) | null | Alternative | |
id | JSON | Required within parent | |
id (allOf 1) | string | All variants apply | Format: uuid |
id (allOf 2) | JSON | All variants apply | Unique identifier for the organization |
kind | JSON | Required within parent | |
kind (allOf 1) | string | All variants apply | Known values: personal, business |
kind (allOf 2) | JSON | All variants apply | Whether this is a personal or business organization |
legalBusinessName | string | Required within parent | Legal business name as registered |
subscriptionTier | JSON | Required within parent | |
subscriptionTier (allOf 1) | string | All variants apply | Known values: free, plus, premium, pro, enterprise |
subscriptionTier (allOf 2) | JSON | All variants apply | The Mercury subscription tier this organization is currently on. Reports "free" when the organization has no paid subscription. |
Referenced models: Get organization information — response body — organization Organization information dbas item
Get organization information — response body — organization Organization information dbas item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | DBA (Doing Business As) information |
dbaIsDefault | boolean | Required within parent | Whether this DBA is set as the default for payments |
dbaName | string | Required within parent | The DBA name |
Policy, approvals and errors
Section titled “Policy, approvals and errors”SDK function policy ID: mercury.getorganization. Catalog operation: mercury:getOrganization. Rules can name either ID; function rules distinguish managed calls and conservatively cover raw calls sharing the route. Existing grant permissions and policy rules apply. wait() returns an immediate result or waits for a required approval; it never approves the request itself. Persist the approval ID to resume after a restart.
Provider errors retain their response; JSON decoding raises ProviderAPIError for provider failures. ManagedOperationError identifies contract/input/retention errors. See error handling and provider-specific behavior. Sensitive input may be refused before approval storage. A decoding error never resubmits a write.