Skip to main content
GET
/
submissions
List bureau submissions
curl --request GET \
  --url https://vvdufluovypptsnkihyv.supabase.co/functions/v1/submissions \
  --header 'x-api-key: <api-key>'
{
  "data": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "tradeline_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "bureau": "equifax",
      "metro2_file_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "submission_date": "2023-12-25",
      "status": "pending",
      "response_code": "<string>",
      "response_message": "<string>",
      "error_details": "<string>",
      "retry_count": 123,
      "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

​
bureau
enum<string>

Filter by bureau

Available options:
equifax,
transunion,
experian
​
status
enum<string>

Filter by submission status Lifecycle status of a bureau submission

Available options:
pending,
submitted,
accepted,
rejected,
error
​
tradeline_id
string<uuid>

Filter by tradeline UUID

​
date_from
string<date>

Filter by submission date (inclusive lower bound, YYYY-MM-DD)

​
date_to
string<date>

Filter by submission date (inclusive upper bound, YYYY-MM-DD)

​
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 bureau submissions

​
data
object[]
​
pagination
object