Me

'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

AttributeDescription
userIDThis 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.
firstThis 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
afterThis is a pagination parameter. (I.e. get the first Nrecords AFTERthis cursor). - Optional. Only required if you are wanting to query for the connections, tradelines, and/or transactions

Output Attributes from Full User Query

AttributeDescription
idGlobal identifier for the user.
emailUser's email address
phoneNumberUser's phone number
nameUser's name.
addressUser's address.
statusUser's status
notificationPreferencesNotifications are currently not sent for Enablement Services
legalAgreementVersionsThe Legal agreement versions the user has accepted. LegalAgreementVersions
createdAtThe time the user was created in the database.
updatedAtThe last time the user was updated.
syncedAtThe last time this user's connections were synced.
deletedAtThe time this user was deleted from the database.
connectionsThe financial institution connections the user has created.
**Requires the ConnectionsInput
tradelinesThe tradelines associated with the connected financial institution(s) this user has connected. **Requires the TradelinesInput