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.
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["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 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.users.get_users(arguments) result = await call.wait() return result.body_json()| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Additional keys: not allowed |
query | object | Optional | Additional keys: not allowed |
query.limit | integer | Optional | Maximum number of results to return. Allowed range: 1 to 1000. Defaults to 1000 Default: 1000 Format: int64 Maximum: 1000 Minimum: 1 |
query.start_after | string | Optional | The 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_before | string | Optional | The 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.order | string | Optional | Sort order. Can be ‘asc’ or ‘desc’. Defaults to ‘asc’ Default: asc One of: asc, desc |
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 all users — response body |
Referenced models: Get all users — response body
Schemas
Section titled “Schemas”Get all users — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Paginated response containing a list of organization users. |
page | object | Required within parent | Pagination information including cursors for navigating to next/previous pages |
page.nextPage | string | Optional | ID for the user Format: uuid |
page.previousPage | string | Optional | ID for the user Format: uuid |
users | array | Required within parent | List of users in the current page |
users[] | Model | Each item | Expand Get user by ID — response body |
Referenced models: Get user by ID — response body
Get user by ID — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Details of a user within an organization. |
email | string | Required within parent | User's email address |
firstName | string | Required within parent | User's first name Maximum length: 299 Minimum length: 1 |
lastName | string | Required within parent | User's last name Maximum length: 299 Minimum length: 1 |
organizationRole | JSON | Required within parent | |
organizationRole (allOf 1) | string | All variants apply | Known values: administrator, bookkeeper, customUser, cardOnlyUser, employee |
organizationRole (allOf 2) | JSON | All variants apply | User's role within the organization |
userId | JSON | Required within parent | |
userId (allOf 1) | string | All variants apply | ID for the user Format: uuid |
userId (allOf 2) | JSON | All variants apply | Unique identifier for the user |
Policy, approvals and errors
Section titled “Policy, approvals and errors”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.