Skip to main content
GET
/
v1
/
grids
/
{grid_id}
/
rows
Get grid rows
curl --request GET \
  --url https://clientapi.retailgrid.io/v1/grids/{grid_id}/rows

Documentation Index

Fetch the complete documentation index at: https://docs.retailgrid.io/llms.txt

Use this file to discover all available pages before exploring further.

Returns 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.

​
Authentication

Bearer token. See Authentication.

​
Path parameters

NameTypeRequiredDescription
grid_idstringYesThe grid to export. Discover IDs via List grids.

​
Query parameters

NameTypeRequiredDescription
limitintegerNoPage size, default 1000, max 10000.
cursorstringNoOpaque pagination cursor returned by a previous response.
columnsstringNoComma-separated list of column names to include. Defaults to every column in the grid.
updated_afterstring (ISO-8601, UTC)NoOnly 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"
}
Numeric values are returned as strings - see Conventions for the rationale.

​
Large grids

For grids above ~50k rows, page with limit=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"