Quiltt Logo

Connections

A Connection in Quiltt serves as the primary way to ingest and sync financial data about a user. Connections are typically created from a data source like Plaid, and allow you to retrieve account information, transactions and other data, depending on the data source and connection configuration.

The Quiltt GraphQL API provides source-specific queries and mutations to support the lifecycle management of your user's connections. Once a connection is persisted, Quiltt will automatically ingest permissioned data, keep it in sync, and make its data available via API and the Quiltt Widget.

Like many other resources, connections support persisting arbitrary information via a metadata object. This can be used to store nicknames, custom timestamps, status indicators and other data that may be useful to retrieve later. See the API Reference or the Custom Metadata guide for more information.

Link to this section#Schemas & Types

GraphQL API Reference

To access the full documentation and typings, explore the schema in the GraphQL API Reference or use the GraphQL Explorer in the Quiltt Dashboard.

Link to this section#Queries

Connection queries allow you to fetch data about a specific connection or a list of connections associated with the user.

Link to this section#connection

Looks up a user's connection by its ID:

query { connection(id: "{{connectionId}}") { id metadata sourceType status institution { name logo { url } } accounts { id name } } }

Link to this section#connections

Lists the user's connections:

query { connections { id metadata sourceType status institution { name logo { url } } accounts { id name } } }

Link to this section#Connection Mutations

Connection mutation allow you delete or update a specific connection.

Link to this section#connectionDelete

Deletes a connection:

mutation ConnectionDelete { connectionDelete(input: { id: "{{connectionId}}" }) { success record { id } errors { message path } } }

Link to this section#connectionUpdate

Updates a connection.

mutation ConnectionUpdate($input: ConnectionUpdateInput!) { connectionUpdate(input: $input) { errors { message } record { id metadata } success } }

Link to this section#Connector Mutations

Connector mutations allow you to initiate and close a connector session, such as Plaid Link or MX Connect. This allows your end-user to register or manage a connection in Quiltt.

Link to this section#connectorPlaidInitialize

Creates a Plaid Link token to initialize an instance of Plaid's Link widget:

mutation ConnectorPlaidInitialize($input: ConnectorPlaidInitializeInput) { connectorPlaidInitialize(input: $input) { success record { linkToken expiration requestId connectorStatus connectorToken } errors { code message } } }

Link to this section#connectorPlaidClose

Creates or updates a Plaid connection from the onSuccess payload of a successful Plaid Link submission:

mutation ConnectorPlaidClose($input: ConnectorPlaidCloseInput) { connectorPlaidClose(input: $input) { success record { id accounts { id name } institution { name logo } } errors { code message } } }

Link to this section#connectorMxInitialize

Creates a MX Connect widget URL to initialize an instance of MX's Connect widget:

mutation ConnectorMxInitialize($input: ConnectorMxInitializeInput) { connectorMxInitialize(input: $input) { success record { url type connectorStatus connectorToken } errors { code message } } }

Link to this section#connectorMxClose

Creates or updates an MX connection from the memberConnected payload of a successful MX Connect submission:

mutation ConnectorMxClose($input: ConnectorMxCloseInput) { connectorMxClose(input: $input) { success record { id accounts { id name } institution { name logo } } errors { code message } } }