Skip to content

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.

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 os
from alter_sdk import App
from 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()
FieldTypePresenceDescription and constraints
$objectRootAdditional keys: not allowed

Response media type: application/json. The table describes the pinned successful response. Referenced models link to their complete fields.

FieldTypePresenceDescription and constraints
$ModelRootExpand Get organization information — response body

Referenced models: Get organization information — response body

Get organization information — response body
FieldTypePresenceDescription and constraints
$objectRootResponse containing organization details.
organizationJSONRequired within parent
organization (allOf 1)ModelAll variants applyExpand Get organization information — response body — organization Organization information
organization (allOf 2)JSONAll variants applyOrganization information

Referenced models: Get organization information — response body — organization Organization information

Get organization information — response body — organization Organization information
FieldTypePresenceDescription and constraints
$objectRootOrganization information
billingCadenceJSONRequired within parent
billingCadence (allOf 1)stringAll variants applyKnown values: monthly, annual
billingCadence (allOf 2)JSONAll variants applyHow often the organization is billed for its current subscription.
Always "monthly" when the tier is "free".
dbasarrayRequired within parentList of DBAs (Doing Business As names) for this organization
dbas[]ModelEach itemExpand Get organization information — response body — organization Organization information dbas item
einJSONOptional
ein (anyOf 1)stringAlternativeEmployer Identification Number (EIN), if available
ein (anyOf 2)nullAlternative
idJSONRequired within parent
id (allOf 1)stringAll variants applyFormat: uuid
id (allOf 2)JSONAll variants applyUnique identifier for the organization
kindJSONRequired within parent
kind (allOf 1)stringAll variants applyKnown values: personal, business
kind (allOf 2)JSONAll variants applyWhether this is a personal or business organization
legalBusinessNamestringRequired within parentLegal business name as registered
subscriptionTierJSONRequired within parent
subscriptionTier (allOf 1)stringAll variants applyKnown values: free, plus, premium, pro, enterprise
subscriptionTier (allOf 2)JSONAll variants applyThe 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
FieldTypePresenceDescription and constraints
$objectRootDBA (Doing Business As) information
dbaIsDefaultbooleanRequired within parentWhether this DBA is set as the default for payments
dbaNamestringRequired within parentThe DBA name

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.

Official provider source

Report an issue with this page

Necessary

Required for sign-in, security, authorization, and remembering your choices.

Always active

Analytics

Helps us understand which product and documentation features are useful.

Performance diagnostics

Uses performance tracing and privacy-masked session replay to diagnose problems.

You can change these choices at any time from Cookie settings.