Skip to main content
GET
/
v2
/
data-structures
List Data Structures
curl --request GET \
  --url https://api.qobra.co/v2/data-structures \
  --header 'X-API-Key: <api-key>'
{
  "data": [
    {
      "id": "507f1f77bcf86cd799439011",
      "name": "Commission Statements",
      "type": "statement_reporting",
      "total_records": 12450,
      "links": {
        "fields": "https://api.qobra.co/v2/data-structures/507f1f77bcf86cd799439011/fields",
        "records": "https://api.qobra.co/v2/reporting/507f1f77bcf86cd799439011/statements"
      }
    },
    {
      "id": "507f1f77bcf86cd799439012",
      "name": "Opportunities (Record Reporting)",
      "type": "record_reporting",
      "total_records": 45230,
      "links": {
        "fields": "https://api.qobra.co/v2/data-structures/507f1f77bcf86cd799439012/fields",
        "records": "https://api.qobra.co/v2/reporting/507f1f77bcf86cd799439012/records"
      }
    }
  ]
}

​
Overview

This endpoint returns all data structures (tables) available in your Qobra account. It’s the entry point for the V2 API — use it to discover what data you can extract.
This is always your first call. It tells you what data structures exist and where to find their schemas and records.

​
Understanding Data Structure Types

The type field indicates what kind of data the structure contains:
What it is: A statement report summarizes commission data at statement level.Typical use: payroll integration, high-level payout analysis per user, sales performance trackingRecord endpoint: /v2/reporting/{id}/statementsContains fields like:
  • Statement user
  • Statement date
  • Payment
  • Statement status (paid, pending, validated)
What it is: A record report summarizes commission data at transaction level (e.g. CRM opportunity level)Typical use: Commission analysis per opportunity, cost of sales and deal margin monitoring Record endpoint: /v2/reporting/{id}/recordsContains fields like:
  • Deal/opportunity information
  • Account details
  • Close dates and amounts
  • Commission amounts

Authorizations

​
X-API-Key
string
header
required

Your Qobra API key. Generate it from Settings > API Keys in Qobra.

Response

Returns a list of all available data structures (statement reporting and record reporting) accessible through the API.

​
data
object[]
required

List of available data structures