Fetch records

Fetch records

curl --request GET \
  --url https://api.qobra.co/v1/tables/{data_table_key}/records \
  --header 'X-API-Key: <api-key>'

{
  "count": 3026,
  "next": "https://api.qobra.co/v1/tables/opportunities/records?limit=2000&offset=2000",
  "data": [
    {
      "id": "6545110915808dbcc34531ef",
      "name": "Great opportunity",
      "owner_id": "[email protected]",
      "close_date": "2024-06-25T09:58:32Z",
      "product": "Product A",
      "amount": 4000,
      "amount_currency": "EUR",
      "deal_types": "New Business, Existing Business"
    },
    "..."
  ]
}

GET

tables

{data_table_key}

records

Fetch records

curl --request GET \
  --url https://api.qobra.co/v1/tables/{data_table_key}/records \
  --header 'X-API-Key: <api-key>'

{
  "count": 3026,
  "next": "https://api.qobra.co/v1/tables/opportunities/records?limit=2000&offset=2000",
  "data": [
    {
      "id": "6545110915808dbcc34531ef",
      "name": "Great opportunity",
      "owner_id": "[email protected]",
      "close_date": "2024-06-25T09:58:32Z",
      "product": "Product A",
      "amount": 4000,
      "amount_currency": "EUR",
      "deal_types": "New Business, Existing Business"
    },
    "..."
  ]
}

Pagination

This endpoint is paginated using parameters offset and limit The “next” key in the response allow you to easily follow pagination to get the next batch of users

Variable api keys

This endpoint is based on dynamic fields. This mean that all annotations that look like <variable-key>, will have to or will be replaced by their actual API keys.

Authorizations

X-API-Key

string

header

required

Path Parameters

data_table_key

string

required

Used to identify the data table

Query Parameters

offset

integer

default:0

Optional (minimum:0 - maximum:9223372036854775807)

Required range: 0 <= x <= 9223372036854776000

limit

integer

default:2000

Optional (minimum:0 - maximum:2000): if set to 0 return total count only

Required range: 0 <= x <= 2000

Response

200 - application/json

Success operation

count

integer

required

Number of records in the response

data

RecordDataModel · object[]

required

Show child attributes

data.<id-field-api-key>

string

required

Record unique identifier value

data.<name-field-api-key>

string

required

Record name value

data.<field-1-api-key>

string

required

Field 1 value

data.<field-2-api-key>

string

required

Field 1 value

data.<field-3-api-key>

string

required

Field 1 value

data.<amount-field-1-api-key>

string

required

Field 1 value

data.<amount-field-1-api-key>_currency

enum<string>

required

Allowed currency codes.

Available options:

AED,

AFN,

ALL,

AMD,

ANG,

AOA,

ARS,

AUD,

AWG,

AZN,

BAM,

BBD,

BDT,

BGN,

BHD,

BIF,

BMD,

BND,

BOB,

BOV,

BRL,

BSD,

BTN,

BWP,

BYR,

BZD,

CAD,

CDF,

CHF,

CLF,

CLP,

CNY,

COP,

COU,

CRC,

CUC,

CUP,

CVE,

CZK,

DJF,

DKK,

DOP,

DZD,

EGP,

ERN,

ETB,

EUR,

FJD,

FKP,

GBP,

GEL,

GHS,

GIP,

GMD,

GNF,

GTQ,

GYD,

HKD,

HNL,

HRK,

HTG,

HUF,

IDR,

ILS,

INR,

IQD,

IRR,

ISK,

JMD,

JOD,

JPY,

KES,

KGS,

KHR,

KMF,

KPW,

KRW,

KWD,

KYD,

KZT,

LAK,

LBP,

LKR,

LRD,

LSL,

LTL,

LVL,

LYD,

MAD,

MDL,

MGA,

MKD,

MMK,

MNT,

MOP,

MRO,

MUR,

MVR,

MWK,

MXN,

MYR,

MZN,

NAD,

NGN,

NIO,

NOK,

NPR,

NZD,

OMR,

PAB,

PEN,

PGK,

PHP,

PKR,

PLN,

PYG,

QAR,

RON,

RSD,

RUB,

RWF,

SAR,

SBD,

SCR,

SDG,

SEK,

SGD,

SHP,

SLL,

SOS,

SRD,

STD,

SVC,

SYP,

SZL,

THB,

TJS,

TMT,

TND,

TOP,

TRY,

TTD,

TWD,

TZS,

UAH,

UGX,

USD,

UYI,

UYU,

UZS,

VEF,

VND,

VUV,

WST,

XAG,

XAU,

XCD,

XPD,

XPT,

XSU,

YER,

ZAR,

ZMK,

ZWL

data.{key}

string

Next page of the response

Upsert manager attributions bulk Upsert records bulk

⌘I

Inbound data integrations

Outbound data integrations

Public API documentation

Authentication

Variable api keys

Authorizations

Path Parameters

Query Parameters

Response

Inbound data integrations

Outbound data integrations

Public API documentation

Authentication

​Pagination

​Variable api keys

Authorizations

Path Parameters

Query Parameters

Response

Pagination

Variable api keys