Connections
A Connection in Quiltt serves as the primary way to ingest and sync financial data associated with one of your Profiles. Connections are typically created from a data source like Plaid or MX, and provide access to account information, transactions and other data, depending on the provider and Connection configuration.
After a Connection is created, Quiltt will automatically ingest permissioned data, keep it in sync, and make its data available via the GraphQL API.
Metadata
Link to this section#Schemas & Types
Profile GraphQL API Reference
Link to this section#Queries
Connection queries allow you to fetch data about a specific Connection or a list of Connections associated with the Profile.
Link to this section#The connection
Query
Looks up a Connection by its ID:
query {
connection(id: "conn_12tgD1WgzFgsy9fqKpW9b3") {
id
provider
status
institution {
name
logo {
url
}
}
accounts {
id
name
}
}
}
Link to this section#Response
"data": {
"connection": {
"id": "conn_12tgD1WgzFgsy9fqKpW9b3",
"provider": "MX",
"status": "SYNCED",
"institution": {
"name": "MX Bank",
"logo": {
"url": "https://cdn.quiltt.io/..."
}
},
"accounts": [
{
"id": "acct_12tgD1YBOnVPMw1oKlWj6b",
"name": "Mortgage"
},
{
"id": "acct_12tgD1YP33AwEvbdmSrcRY",
"name": "Credit Card"
},
...
]
},
}
Link to this section#The connections
Query
Lists the Connections associated with the Profile:
query {
connections {
id
provider
status
institution {
name
logo {
url
}
}
accounts {
id
name
}
}
}
Link to this section#Response
"data": {
"connections": [
{
"id": "conn_12tgD1WgzFgsy9fqKpW9b3",
"provider": "MX",
"status": "SYNCED",
"institution": {
"name": "MX Bank",
"logo": {
"url": "https://cdn.quiltt.io/..."
}
},
"accounts": [
{
"id": "acct_12tgD1YBOnVPMw1oKlWj6b",
"name": "Mortgage"
},
{
"id": "acct_12tgD1YP33AwEvbdmSrcRY",
"name": "Credit Card"
},
...
]
},
{
"id": "conn_12tErBquPaGw6diZp8j801",
"provider": "PLAID",
"status": "SYNCED",
"institution": {
"name": "Tartan Bank",
"logo": {
"url": "https://cdn.quiltt.io/..."
}
},
"accounts": [
{
"id": "acct_12tErBqz5oPva4qlsZ9Po8",
"name": "Plaid Bronze Standard 0.2% Interest CD"
},
{
"id": "acct_12tErBqwklkvjw6AIpeExJ",
"name": "Plaid Gold Standard 0% Interest Checking"
},
...
]
}
Link to this section#Mutations
Connection mutations allow you to disconnect or update individual Connections.
Link to this section#The connectionDisconnect
Mutation
Disconnect a Connection from its provider, preventing Quiltt from syncing data:
mutation ConnectionDisconnect {
connectionDisconnect(input: { id: "conn_12tgD1WgzFgsy9fqKpW9b3" }) {
success
record {
id
}
}
}
Link to this section#Response
{
"data": {
"connectionDisconnect": {
"success": true,
"record": {
"id": "conn_12tgD1WgzFgsy9fqKpW9b3"
}
}
}
}
Link to this section#The connectionUpdate
Mutation
Updates a Connection with new metadata. This is useful for storing additional information about the Connection, such as a user-friendly name, or an internal ID.
mutation ConnectionUpdate {
connectionUpdate(
input: {
id: "conn_12tgD1WgzFgsy9fqKpW9b3"
metadata: { nickname: "My Special Connection", hiddenFromUI: "true", internal_id: "12345" }
}
) {
success
record {
id
metadata
}
}
}
Link to this section#Variables
{
"input": {
"metadata" {
"nickname": "My Special Connection",
"hiddenFromUI": "true",
"internal_id": "12345"
}
}
}
Link to this section#Response
{
"data": {
"connectionUpdate": {
"success": true,
"record": {
"id": "conn_12tgD1WgzFgsy9fqKpW9b3",
"metadata": {
"nickname": "My Special Connection",
"hiddenFromUI": "true",
"internal_id": "12345"
}
}
}
}
}