Skip to content

Mercury: Get all events

Mercury events.getEvents: arguments, response, policy and SDK examples.

← Events operations · Get started

Operation mercury.getevents

Provider route: GET /events. 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["events"]["getEvents"]>[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.events.getEvents(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.events.get_events(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 event to start the page after (exclusive). When provided, results will begin with the event 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 event 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
query.resourceTypestringOptionalOne of: transaction, checkingAccount, savingsAccount, treasuryAccount, investmentAccount, creditAccount
query.resourceIdstringOptionalFormat: uuid

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 events — response body

Referenced models: Get all events — response body

Get all events — response body
FieldTypePresenceDescription and constraints
$objectRootPaginated response containing a list of API events.
| Use the page cursor information to fetch additional pages of events.
eventsarrayRequired within parentList of events in the current page
events[]ModelEach itemExpand Get event by ID — response body
pageobjectRequired within parentPagination information including cursors for navigating to next/previous pages
page.nextPagestringOptionalID for the API event
Format: uuid
page.previousPagestringOptionalID for the API event
Format: uuid

Referenced models: Get event by ID — response body

Get event by ID — response body
FieldTypePresenceDescription and constraints
$objectRootRepresents a single event in the Mercury API event stream.
Events track changes to resources over time, providing an audit trail
of all modifications with before/after values and metadata about what changed.
changedPathsarrayRequired within parentList of JSON paths that were modified in this event
changedPaths[]stringEach item
idJSONRequired within parent
id (allOf 1)stringAll variants applyID for the API event
Format: uuid
id (allOf 2)JSONAll variants applyUnique identifier for this event
mergePatchobjectRequired within parentJSON object containing the fields that were changed and their new values
occurredAtJSONRequired within parent
occurredAt (allOf 1)stringAll variants applyFormat: yyyy-mm-ddThh:MM:ssZ
occurredAt (allOf 2)JSONAll variants applyTimestamp when the event occurred
operationTypeJSONRequired within parent
operationType (allOf 1)stringAll variants applyKnown values: create, update, delete
operationType (allOf 2)JSONAll variants applyThe type of operation performed (e.g., create, update, delete)
previousValuesJSONOptional
previousValues (anyOf 1)objectAlternativeJSON object containing the fields that were changed and their previous values before the update
previousValues (anyOf 2)nullAlternative
resourceIdJSONRequired within parent
resourceId (allOf 1)stringAll variants applyFormat: uuid
resourceId (allOf 2)JSONAll variants applyThe ID of the resource that was affected
resourceTypeJSONRequired within parent
resourceType (allOf 1)stringAll variants applyKnown values: transaction, checkingAccount, savingsAccount, treasuryAccount, investmentAccount, creditAccount
resourceType (allOf 2)JSONAll variants applyThe type of resource that was affected (e.g., transaction, account)
resourceVersionJSONRequired within parent
resourceVersion (allOf 1)ModelAll variants applyExpand Get event by ID — response body — resource Version value
resourceVersion (allOf 2)JSONAll variants applyVersion number of the resource after this change

Referenced models: Get event by ID — response body — resource Version value

Get event by ID — response body — resource Version value
FieldTypePresenceDescription and constraints
$JSONRoot
$ (anyOf 1)integerAlternativeFormat: int64
Minimum: 1
$ (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$

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