List Invitations
Request and response reference for GET /v1/console/invitations.
/v1/console/invitationsRequest
This interface uses an approved institutional session, not a financial API key. Session writes also need Origin and CSRF protection. Use the JavaScript sample within an authorized browser integration.
curl -X GET "$OSAI_CONSOLE_BASE_URL/v1/console/invitations" \
-H "Origin: $OSAI_APP_ORIGIN" \
--cookie "$OSAI_SESSION_COOKIE_FILE"Parameters
| Name | Location | Requirement | Description |
|---|---|---|---|
after | query · string | Optional | Use the value defined for this resource. |
limit | query · integer | Optional | Use the value defined for this resource. |
Request body
This operation does not define a JSON request body.
Responses
Inspect HTTP status before parsing a body. These tables describe client response fields rather than invented successful transaction payloads.
200 · HTTP 200 response
| Field | Type | Description & constraints |
|---|---|---|
invitationsRequired in parent object | array | Defined by the resource contract. |
invitations[].invitation_idRequired in parent object | string | Defined by the resource contract. |
invitations[].institution_idRequired in parent object | string | Defined by the resource contract. |
invitations[].masked_emailRequired in parent object | string | Defined by the resource contract. |
invitations[].role_idsRequired in parent object | array | Defined by the resource contract. |
invitations[].statusRequired in parent object | string | Defined by the resource contract. |
invitations[].versionRequired in parent object | string | Exact nonnegative base-10 integer; never a JSON number.Pattern: ^(0|[1-9][0-9]*)$ |
invitations[].created_atRequired in parent object | stringdate-time | Defined by the resource contract. |
invitations[].expires_atRequired in parent object | stringdate-time | Defined by the resource contract. |
invitations[].delivery_statusRequired in parent object | string | Defined by the resource contract. |
next_afterRequired in parent object | string | Defined by the resource contract. |
has_moreRequired in parent object | boolean | Defined by the resource contract. |
400 · Invalid bounded instruction
No client body fields are defined for this response.
401 · Authentication required
No client body fields are defined for this response.
403 · Permission, recent verified MFA or CSRF denied
No client body fields are defined for this response.
409 · Version, preview, instruction or capacity conflict
No client body fields are defined for this response.
503 · Unavailable or unknown commit outcome; query the original command before retrying
No client body fields are defined for this response.
Retries & recovery
Keep the original request identifiers and any required idempotency key. A timeout does not establish failure. Read the original resource or command before another financial write; use expected versions for concurrent changes.