'query'
The tradeline
query allows you to retrieve a specific tradeline by ID
. These query requires authentication and requires your session token to be passed along with the request. (See how to authenticate here).
Query
query Tradeline {
tradeline(id: ID!) {
id
merchant
category
isOpen
isEligible
paymentFrequency
serviceAddress
servicePhone
leaseStartDate
utilityTypes
serviceAddressType
createdAt
updatedAt
transactions(input: { first: Int, after: String }) {
totalCount
edges {
node {
id
date
value {
amount
currency
}
}
}
}
}
}
Input Attributes from Full User Query
Attribute | Description |
---|---|
id | The unique identifier for the tradeline you are querying. |
first | This is a pagination parameter. (I.e. get the first N records). - Optional. Only required if you are wanting to query for the transactions as well. |
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 transactions as well. |
Output Attributes from Query
Attribute | Description |
---|---|
id | Unique identifier for the organization |
merchant | Merchant Name. |
category | The tradeline's category. See TradelineCategory |
isEligible | A boolean of whether or not the tradeline is eligible for reporting to credit bureaus. . |
paymentFrequency | How often this tradline is paid. SeePaymentFrequency |
serviceAddress | The address associated with the tradeline, if applicable. |
servicePhone | The phone number associated with the tradeline, if applicable. |
leaseStartDate | The least start date, if applicable. |
utilityType | The type of utility, if applicable. See UtilityType |
serviceAddressType | The type of the address that is associated with the tradeline. See AddressType |
createdAt | When this tradeline was created in the database. |
updatedAt | When this tradeline was last updated in the database. |
transactions | The transactions for this particular tradeline. See Transactions |