Get grid rows
curl --request GET \
--url https://clientapi.retailgrid.io/v1/grids/{grid_id}/rowsimport requests
url = "https://clientapi.retailgrid.io/v1/grids/{grid_id}/rows"
response = requests.get(url)
print(response.text)const options = {method: 'GET'};
fetch('https://clientapi.retailgrid.io/v1/grids/{grid_id}/rows', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://clientapi.retailgrid.io/v1/grids/{grid_id}/rows",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://clientapi.retailgrid.io/v1/grids/{grid_id}/rows"
req, _ := http.NewRequest("GET", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://clientapi.retailgrid.io/v1/grids/{grid_id}/rows")
.asString();require 'uri'
require 'net/http'
url = URI("https://clientapi.retailgrid.io/v1/grids/{grid_id}/rows")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
response = http.request(request)
puts response.read_bodyGrids
Get grid rows
Export the full row contents of a grid - canonical, custom, and formula/calculated columns.
GET
/
v1
/
grids
/
{grid_id}
/
rows
Get grid rows
curl --request GET \
--url https://clientapi.retailgrid.io/v1/grids/{grid_id}/rowsimport requests
url = "https://clientapi.retailgrid.io/v1/grids/{grid_id}/rows"
response = requests.get(url)
print(response.text)const options = {method: 'GET'};
fetch('https://clientapi.retailgrid.io/v1/grids/{grid_id}/rows', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://clientapi.retailgrid.io/v1/grids/{grid_id}/rows",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://clientapi.retailgrid.io/v1/grids/{grid_id}/rows"
req, _ := http.NewRequest("GET", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://clientapi.retailgrid.io/v1/grids/{grid_id}/rows")
.asString();require 'uri'
require 'net/http'
url = URI("https://clientapi.retailgrid.io/v1/grids/{grid_id}/rows")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
response = http.request(request)
puts response.read_bodyReturns the row contents of a grid, including canonical columns, user-added custom columns, and formula or calculated columns. This is the programmatic counterpart of the in-app Export action.
Use this endpoint when you want to pull a user-built workspace - with its column set and computed columns - into an ERP, BI tool, or warehouse on a schedule.
Numeric values are returned as strings - see Conventions for the rationale.
Authentication
Bearer token. See Authentication.Path parameters
| Name | Type | Required | Description |
|---|---|---|---|
grid_id | string | Yes | The grid to export. Discover IDs via List grids. |
Query parameters
| Name | Type | Required | Description |
|---|---|---|---|
limit | integer | No | Page size, default 1000, max 10000. |
cursor | string | No | Opaque pagination cursor returned by a previous response. |
columns | string | No | Comma-separated list of column names to include. Defaults to every column in the grid. |
updated_after | string (ISO-8601, UTC) | No | Only return rows updated at or after this timestamp. |
Response
{
"grid_id": "grd_01HX2K8E4Y",
"columns": [
{ "name": "product_id", "type": "string", "source": "canonical" },
{ "name": "price", "type": "number", "source": "canonical" },
{ "name": "margin", "type": "number", "source": "formula" },
{ "name": "role", "type": "single_select", "source": "custom" }
],
"data": [
{
"product_id": "SKU-12345",
"price": "4.99",
"margin": "0.31",
"role": "KVI"
}
],
"next_cursor": "eyJvZmZzZXQiOjEwMDB9"
}
Large grids
For grids above ~50k rows, page withlimit=5000 and follow next_cursor until it returns null. Pulling the entire grid in one call is supported up to the limit ceiling but is slower than chunked pulls and more likely to hit a retry on transient failures.
If you only need a subset of columns, pass columns= - the response is smaller and the export is faster.
Example request
curl -s "https://clientapi.retailgrid.io/v1/grids/grd_01HX2K8E4Y/rows?limit=5000&columns=product_id,price,margin" \
-H "Authorization: Bearer rg_live_xxx"

