v6

OpenAPI 3.1.12026-08-027636.5 MB
Events

List events

List events

get/events

Query parameters

partyIdstring

Defaults to your party. To act for another party, pass the ID of a party that has authorized you to act on its behalf.

eventType'party.updated' | 'compliance_case.updated' | 'wallet.created' | 'external_account.connected' | 'agent_delegation_invitation.created' | 'agent_delegation_invitation.accepted' | 'agent_delegation_invitation.declined' | 'agent_delegation_invitation.canceled' | 'agent_delegation.revoked' | 'delegation.activated' | 'delegation.revoked' | 'deposit.created' | 'deposit.completed' | 'deposit.failed' | 'deposit.returned' | 'deposit.canceled' | 'deposit.approval_denied' | 'withdrawal.created' | 'withdrawal.completed' | 'withdrawal.failed' | 'withdrawal.returned' | 'withdrawal.canceled' | 'withdrawal.approval_denied' | 'payment.created' | 'payment.completed' | 'payment.failed' | 'payment.returned' | 'payment.canceled' | 'payment.approval_denied' | 'approval.required' | 'approval.approved' | 'approval.denied' | 'approval.canceled' | 'payment_request.created' | 'payment_request.completed' | 'payment_request.canceled' | 'payment_request.declined' | 'payment_request.incoming'

Filter by event type. Required when partyId names another party.

createdAfterstring date-time

Return events created after this timestamp.

createdBeforestring date-time

Return events created before this timestamp.

cursorstring

Cursor from the previous page.

limitinteger

Maximum results per page.

Headers

X-Agent-IDstring nullable

Agent (agt_*) to attribute this request to when authenticating with a party API key; omit for agent keys and agent-scoped OAuth grants, which already carry agent identity.

X-Instance-IDstring nullable

Caller-chosen identifier for the agent run, session, or conversation, required when an agent moves money.

Response

Successful Response