Get a sheet's rows - QX Labs Docs

GET

/

v1

/

grids

/

{grid_id}

/

sheets

/

{sheet_id}

cURL

curl "https://api.qxlabs.com/v1/grids/3e7a9c415b2d4f8ea6c19d0b2e4f7a18/sheets/b2d4f6a81c3e4a5b8d7f0e9c2a4b6d81?limit=50" \
  -H "Authorization: Bearer <YOUR_QX_API_KEY>"

import requests

headers = {"Authorization": "Bearer <YOUR_QX_API_KEY>"}

page = requests.get(
    "https://api.qxlabs.com/v1/grids/3e7a9c415b2d4f8ea6c19d0b2e4f7a18/sheets/b2d4f6a81c3e4a5b8d7f0e9c2a4b6d81",
    params={"limit": 50, "column_ids": "9f8e7d6c5b4a439281706f5e4d3c2b1a"},
    headers=headers,
).json()
for row in page["rows"]:
    print(row["row_id"], row["cells"])
print(page["total_count"], page["has_more"])

const headers = { Authorization: "Bearer <YOUR_QX_API_KEY>" };
const url = new URL("https://api.qxlabs.com/v1/grids/3e7a9c415b2d4f8ea6c19d0b2e4f7a18/sheets/b2d4f6a81c3e4a5b8d7f0e9c2a4b6d81");
url.searchParams.set("limit", "50");
url.searchParams.set("column_ids", "9f8e7d6c5b4a439281706f5e4d3c2b1a");

const page = await (await fetch(url, { headers })).json();
for (const row of page.rows) {
  console.log(row.row_id, row.cells);
}
console.log(page.total_count, page.has_more);

{
  "rows": [
    {
      "row_id": "7d1e3f5a9b2c4d6e8f0a1b3c5d7e9f20",
      "cells": {
        "c1a2b3c4d5e64f708a9b0c1d2e3f4a5b": {
          "value": "acme.com",
          "status": "completed",
          "error": null
        },
        "9f8e7d6c5b4a439281706f5e4d3c2b1a": {
          "value": "Acme makes industrial sensors for factory lines.",
          "status": "completed",
          "error": null
        }
      }
    }
  ],
  "total_count": 240,
  "has_more": true
}

{
  "error": "<string>"
}

{
  "error": "<string>"
}

{
  "error": "<string>"
}

{
  "error": "Read rate limit exceeded for grids endpoints"
}

Authorizations

Authorization

string

header

required

Your QX API key. The X-API-Key header works too

Path Parameters

grid_id

string

required

The grid's ID

sheet_id

string

required

The sheet's ID

Query Parameters

offset

integer

default:0

Rows to skip

limit

integer

default:50

Rows per page, up to 500

row_ids

string

Comma-separated row IDs. Returns only these rows. About 200 IDs fit in a URL most servers accept

column_ids

string

Comma-separated column IDs. Returns only these columns' cells

filters

string

JSON list of {"column_id", "operator", "value"}. A row is kept only if it matches every filter. Operators: equals, not_equal, contains, does_not_contain, starts_with, ends_with, is_empty, is_not_empty, greater_than, less_than, greater_or_equal, less_or_equal, is_true, is_false, on_day, before and after. They compare against the text the app shows in the cell. The number operators ignore thousands commas.

Response

A page of rows

rows

object[]

The page of rows, in the order the app shows them

Show child attributes

total_count

integer

The number of rows that match row_ids and filters, across all pages

has_more

boolean

Whether there are rows after this page

cURL

curl "https://api.qxlabs.com/v1/grids/3e7a9c415b2d4f8ea6c19d0b2e4f7a18/sheets/b2d4f6a81c3e4a5b8d7f0e9c2a4b6d81?limit=50" \
  -H "Authorization: Bearer <YOUR_QX_API_KEY>"

import requests

headers = {"Authorization": "Bearer <YOUR_QX_API_KEY>"}

page = requests.get(
    "https://api.qxlabs.com/v1/grids/3e7a9c415b2d4f8ea6c19d0b2e4f7a18/sheets/b2d4f6a81c3e4a5b8d7f0e9c2a4b6d81",
    params={"limit": 50, "column_ids": "9f8e7d6c5b4a439281706f5e4d3c2b1a"},
    headers=headers,
).json()
for row in page["rows"]:
    print(row["row_id"], row["cells"])
print(page["total_count"], page["has_more"])

const headers = { Authorization: "Bearer <YOUR_QX_API_KEY>" };
const url = new URL("https://api.qxlabs.com/v1/grids/3e7a9c415b2d4f8ea6c19d0b2e4f7a18/sheets/b2d4f6a81c3e4a5b8d7f0e9c2a4b6d81");
url.searchParams.set("limit", "50");
url.searchParams.set("column_ids", "9f8e7d6c5b4a439281706f5e4d3c2b1a");

const page = await (await fetch(url, { headers })).json();
for (const row of page.rows) {
  console.log(row.row_id, row.cells);
}
console.log(page.total_count, page.has_more);

{
  "rows": [
    {
      "row_id": "7d1e3f5a9b2c4d6e8f0a1b3c5d7e9f20",
      "cells": {
        "c1a2b3c4d5e64f708a9b0c1d2e3f4a5b": {
          "value": "acme.com",
          "status": "completed",
          "error": null
        },
        "9f8e7d6c5b4a439281706f5e4d3c2b1a": {
          "value": "Acme makes industrial sensors for factory lines.",
          "status": "completed",
          "error": null
        }
      }
    }
  ],
  "total_count": 240,
  "has_more": true
}

{
  "error": "<string>"
}

{
  "error": "<string>"
}

{
  "error": "<string>"
}

{
  "error": "Read rate limit exceeded for grids endpoints"
}