Skip to main content
GET
List Data Structures

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.
Only data structures from your company’s live environment are returned. Reporting tables and quotas that exist in a sandbox environment are not listed and their ids cannot be used with the other V2 endpoints. See the introduction for details.

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 trackingData 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 monitoringData endpoint: /v2/reporting/{id}/recordsContains fields like:
  • Deal/opportunity information
  • Account details
  • Close dates and amounts
  • Commission amounts
What it is: The target assigned to each person, for each period.Typical use: BI reporting on targets vs attainment, warehouse syncData endpoint: /v2/quotas/{id}/valuesContains fields like:
  • The person the target is set for
  • The period it applies to
  • The target value
  • Whether it was set in Qobra or synchronized from an integration
For a quota, total_records is the exact, live number of quota values it holds — one per person and per period. For a reporting table it is a periodically refreshed count, and it can be null.

Active and archived structures

Every structure carries a status, either active or archived.
Archiving a quota does not hide it here. An archived quota stays listed, with "status": "archived", and its fields and values stay readable. Filter on status yourself to leave archived quotas out of a sync.
Only a quota can be archived. Reporting tables are always active.

links.records points at the data endpoint that matches the structure’s type: The URL is absolute and already carries the id. Follow it rather than mapping types to routes yourself.

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