Skip to main content
GET
/
v1
/
grids
/
{grid_id}
Export Grid
curl --request GET \
  --url https://api.example.com/v1/grids/{grid_id}
{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "name": "<string>",
  "status": "<string>",
  "row_count": 123,
  "column_count": 123,
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z",
  "offset": 123,
  "limit": 123,
  "total": 123,
  "has_more": true,
  "tags": [
    "<string>"
  ],
  "columns": [
    {
      "key": "<string>",
      "name": "<string>",
      "type": "<string>"
    }
  ],
  "rows": [
    {}
  ]
}

Path Parameters

grid_id
string<uuid>
required

Query Parameters

offset
integer
default:0
Required range: x >= 0
limit
integer
default:100
Required range: 1 <= x <= 1000

Response

Successful Response

GET /v1/grids/{id} — grid metadata, column definitions, and a page of rows (offset/limit) with materialized calculated-column values.

id
string<uuid>
required
name
string
required
status
string
required
row_count
integer
required
column_count
integer
required

Total columns: canonical (product/variant) plus user-defined custom and calculated columns. Identical in the list and export responses.

created_at
string<date-time>
required
updated_at
string<date-time>
required
offset
integer
required
limit
integer
required
total
integer
required
has_more
boolean
required
tags
string[]
columns
GridExportColumn · object[]
rows
Rows · object[]