Skip to main content
GET
/
tradelines
List tradelines
curl --request GET \
  --url https://vvdufluovypptsnkihyv.supabase.co/functions/v1/tradelines \
  --header 'x-api-key: <api-key>'
{
  "data": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "consumer_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "partner_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "payment_type": "rent",
      "payment_type_label": "<string>",
      "external_account_id": "<string>",
      "account_opened_date": "2023-12-25",
      "account_closed_date": "2023-12-25",
      "payment_amount": 123,
      "payment_frequency": "<string>",
      "credit_limit": 123,
      "highest_balance": 123,
      "original_loan_amount": 123,
      "account_status": "current",
      "current_balance": 123,
      "amount_past_due": 123,
      "ecoa_code": "<string>",
      "metro2_account_type": "<string>",
      "payment_history": "<string>",
      "date_of_first_delinquency": "2023-12-25",
      "report_to_bureaus": [
        "<string>"
      ],
      "is_active": true,
      "created_at": "2023-11-07T05:31:56Z",
      "updated_at": "2023-11-07T05:31:56Z"
    }
  ],
  "pagination": {
    "page": 123,
    "per_page": 123,
    "total": 123,
    "total_pages": 123
  }
}

Authorizations

​
x-api-key
string
header
required

API key in the format sk_live_<token> (production) or sk_test_<token> (sandbox). Contact Cove to obtain your API key.

Query Parameters

​
consumer_id
string<uuid>

Filter by consumer UUID

​
payment_type
enum<string>

Filter by payment type Type of recurring payment being reported

Available options:
rent,
child_support,
alimony,
utility,
medical,
insurance,
subscription,
bill_pay,
loan,
custom
​
status
enum<string>

Filter by account status Current status of the tradeline account (auto-computed from payment reports)

Available options:
current,
late_30,
late_60,
late_90,
late_120,
late_150,
late_180_plus,
paid_in_full,
closed,
transferred,
account_in_dispute
​
is_active
boolean

Filter by active state (true or false)

​
page
integer
default:1

Page number (1-indexed)

Required range: x >= 1
​
per_page
integer
default:20

Number of records per page

Required range: 1 <= x <= 100

Response

Paginated list of tradelines

​
data
object[]
​
pagination
object