Skip to content

Mercury: Get all users

Mercury users.getUsers: arguments, response, policy and SDK examples.

← Users operations · Get started

Operation mercury.getusers

Provider route: GET /users. 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["users"]["getUsers"]>[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.users.getUsers(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.users.get_users(arguments)
result = await call.wait()
return result.body_json()
FieldTypePresenceDescription and constraints
$objectRootAdditional keys: not allowed
queryobjectOptionalAdditional keys: not allowed
query.limitintegerOptionalMaximum number of results to return. Allowed range: 1 to 1000. Defaults to 1000
Default: 1000
Format: int64
Maximum: 1000
Minimum: 1
query.start_afterstringOptionalThe ID of the user to start the page after (exclusive). When provided, results will begin with the user immediately following this ID. Use this for standard forward pagination to get the next page of results. Cannot be combined with end_before.
Format: uuid
query.end_beforestringOptionalThe ID of the user to end the page before (exclusive). When provided, results will end just before this ID and work backwards. Use this for reverse pagination or to retrieve previous pages. Cannot be combined with start_after.
Format: uuid
query.orderstringOptionalSort order. Can be ‘asc’ or ‘desc’. Defaults to ‘asc’
Default: asc
One of: asc, desc

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

FieldTypePresenceDescription and constraints
$ModelRootExpand Get all users — response body

Referenced models: Get all users — response body

Get all users — response body
FieldTypePresenceDescription and constraints
$objectRootPaginated response containing a list of organization users.
pageobjectRequired within parentPagination information including cursors for navigating to next/previous pages
page.nextPagestringOptionalID for the user
Format: uuid
page.previousPagestringOptionalID for the user
Format: uuid
usersarrayRequired within parentList of users in the current page
users[]ModelEach itemExpand Get user by ID — response body

Referenced models: Get user by ID — response body

Get user by ID — response body
FieldTypePresenceDescription and constraints
$objectRootDetails of a user within an organization.
emailstringRequired within parentUser's email address
firstNamestringRequired within parentUser's first name
Maximum length: 299
Minimum length: 1
lastNamestringRequired within parentUser's last name
Maximum length: 299
Minimum length: 1
organizationRoleJSONRequired within parent
organizationRole (allOf 1)stringAll variants applyKnown values: administrator, bookkeeper, customUser, cardOnlyUser, employee
organizationRole (allOf 2)JSONAll variants applyUser's role within the organization
userIdJSONRequired within parent
userId (allOf 1)stringAll variants applyID for the user
Format: uuid
userId (allOf 2)JSONAll variants applyUnique identifier for the user

SDK function policy ID: mercury.getusers. Catalog operation: mercury:getUsers. 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.