Export API Reference

Export Report

GET

GET /v1/export/{report_name}

Retrieves the data for the specified report.

Path parameters

string

required

The unique identifier of the report.

Query parameters

integer

The maximum number of JSON objects to return in the data array.

integer

The number of records to skip before starting to return data.

string

Case-insensitive substring filter on the supplier/vendor name. Applies to vendor-based reports (for example, the all-suppliers report); ignored for other base objects. total_count reflects the filtered result.

Example request

curl -X GET "https://api.coverbase.app/v1/export/vendor-custom-report?limit=10&offset=20" \
  -H "Authorization: Bearer <api-key>" \
  -H "Content-Type: application/json"

import os
import requests

API_KEY = os.getenv("COVERBASE_API_KEY", "<api-key>")
BASE_URL = "https://api.coverbase.app"

report_name = "vendor-custom-report"

headers = {
    "Authorization": f"Bearer {API_KEY}",
    "Content-Type": "application/json",
}

resp = requests.get(
    f"{BASE_URL}/v1/export/{report_name}?limit=10&offset=20",
    headers=headers,
    timeout=30,
)
resp.raise_for_status()
report = resp.json()

print(f"Report: {report['report_name']} ({report['base_object']})")
print(f"Returned {len(report['data'])} of {report['total_count']} records")

Example response

{
  "id": "cbexprt_a13361e835664c26bb0551a860258f6d",
  "slug": "vendor-custom-report",
  "report_name": "Vendor Report",
  "base_object": "vendor",
  "mapping": {
    "id": "Id",
    "name": "Name",
    "status": "Status",
    "website": "Website",
    "products": "Products",
    "created_at": "Created At",
    "description": "Description",
    "hq_location": "Hq Location"
  },
  "data": [
    {
      "Id": "cbvndr_0de9333fece3493eb3987b1a1af28119",
      "Name": "1Password",
      "Status": "Active",
      "Website": "1password.com",
      "Products": [],
      "Created At": 1731132522,
      "Description": "1Password provides secure password management solutions for individuals and businesses.",
      "Hq Location": "Toronto, Ontario, Canada"
    }
  ],
  "limit": 10,
  "offset": 20,
  "total_count": 157
}

Response fields

string

Unique Coverbase export report ID.

string

Unique string used in the API endpoint URL.

string

Display name for the report.

string

The object each record in data represents (for example, vendor or assessment).

object

Mapping between Coverbase field names and the field names exported in the JSON objects.

array

Array of JSON objects. Each object represents one base_object and contains field names specified by the values in the mapping object.

integer

The maximum length of the data array.

integer

The number of records skipped before the system began returning records.

integer

Total number of base objects in Coverbase.

Need help? Email support@coverbase.ai.

Getting started

Products

Control Set library

Trust & security

API Reference

Data Import & Export

Reporting & Templates

Integration Workflows

AI, Agents, MCP

Export Report

Path parameters

Query parameters

Example request

Example response

Response fields

​Export Report

​Path parameters

​Query parameters

​Example request

​Example response

​Response fields

Export Report

Path parameters

Query parameters

Example request

Example response

Response fields