Sign in

v51

latestOpenAPI 3.0.0raw.githubusercontent.com2026-08-0175184292.5 KB
Connections

Get all session events for a user

Returns a list of session events associated with a user.

get/sessionEvents

Query parameters

PartnerClientIdstring required

SnapTrade Client ID (generated and provided to partner by SnapTrade)

Example:SNAPTRADETEST
userIdstring

Comma separated list of account IDs

Example:917c8734-8470-4a3e-a18f-57c3f2ee6631,65e839a3-9103-4cfb-9b72-2071ef80c5f2

Optional comma separated list of user IDs used to filter the request on specific users

sessionIdstring

Comma separated list of account IDs

Example:917c8734-8470-4a3e-a18f-57c3f2ee6631,65e839a3-9103-4cfb-9b72-2071ef80c5f2

Optional comma separated list of session IDs used to filter the request on specific users

Response

A list of all Session Events for the Partner.

idstring uuid
session_event_type'OAUTH_REDIRECT' | 'DISCLAIMER_ACCEPTED' | 'BROKERAGE_CONNECTION_INITIATED' | 'BROKERAGE_RECONNECT_INITIATED' | 'BROKERAGE_AUTHENTICATION' | 'OAUTH_BROKERAGE_AUTHENTICATION' | 'MFA_REQUESTED' | 'MFA_SUBMITTED' | 'MFA_CHOICE_REQUESTED' | 'MFA_CHOICE_SUBMITTED' | 'CONNECTION_SUCCESSFUL' | 'CONNECTION_FAILED' | 'PARTNER_REDIRECT' | 'CONNECTION_ABORTED' | 'SESSION_STARTED'
session_idstring uuid
user_idstring

SnapTrade User ID. This is chosen by the API partner and can be any string that is a) unique to the user, and b) immutable for the user. It is recommended to NOT use email addresses for this property because they are usually not immutable.

created_datestring

Time

brokerage_status_codeinteger nullable
brokerage_authorization_idstring uuid

Example response

[
  {
    "id": "2bcd7cc3-e922-4976-bce1-9858296801c3",
    "session_id": "2bcd7cc3-e922-4976-bce1-9858296801c3",
    "user_id": "snaptrade-user-123",
    "created_date": "2022-01-21T15:11:19.217000-05:00",
    "brokerage_status_code": 400,
    "brokerage_authorization_id": "2bcd7cc3-e922-4976-bce1-9858296801c3"
  }
]