'query'
The Me
query allows you to query the current user object. These query requires authentication and requires your session token to be passed along with the request. (See how to authenticate here).
Full User Query
query Me {
me {
id
email
phoneNumber
status
createdAt
updatedAt
syncedAt
deletedAt
name {
first
middle
last
}
address {
line1
line2
city
state
country
zipcode
type
}
notificationPreferences {
type
email
phoneNumber
}
legalAgreementVersions {
name
version
}
connections(input: { first: Int!, after: Int! }) {
totalCount
edges {
cursor
node {
id
institution {
id
name
}
}
}
}
tradelines(input: { first: Int!, after: Int! }) {
totalCount
edges {
cursor
node {
id
merchant
category
isOpen
isEligible
paymentFrequency
serviceAddress
servicePhone
leaseStartDate
utilityTypes
serviceAddressType
createdAt
updatedAt
transactions(input: { first: Int!, after: Int! }) {
totalCount
edges {
cursor
node {
id
date
value {
amount
currency
}
}
}
}
}
}
}
}
}
Input Attributes from Full User Query
Attribute | Description |
---|---|
userID | This is not a param you will pass, but rather we will get this from your session token to validate whether you are allowed to query this user. The logged in user can only see data for their user. |
first | This is a pagination parameter. (I.e. get the first N records). - Optional. Only required if you are wanting to query for the connections , tradelines , and/or transactions |
after | This is a pagination parameter. (I.e. get the first N records AFTER this cursor). - Optional. Only required if you are wanting to query for the connections , tradelines , and/or transactions |
Output Attributes from Full User Query
Attribute | Description |
---|---|
id | Global identifier for the user. |
User's email address | |
phoneNumber | User's phone number |
name | User's name. |
address | User's address. |
status | User's status |
notificationPreferences | Notifications are currently not sent for Enablement Services |
legalAgreementVersions | The Legal agreement versions the user has accepted. LegalAgreementVersions |
createdAt | The time the user was created in the database. |
updatedAt | The last time the user was updated. |
syncedAt | The last time this user's connections were synced. |
deletedAt | The time this user was deleted from the database. |
connections | The financial institution connections the user has created. **Requires the ConnectionsInput |
tradelines | The tradelines associated with the connected financial institution(s) this user has connected. **Requires the TradelinesInput |