Skip to main content
GET
/
v1
/
grids
/
{grid_id}
Export Grid
curl --request GET \
  --url https://api.example.com/v1/grids/{grid_id}
import requests

url = "https://api.example.com/v1/grids/{grid_id}"

response = requests.get(url)

print(response.text)
const options = {method: 'GET'};

fetch('https://api.example.com/v1/grids/{grid_id}', 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://api.example.com/v1/grids/{grid_id}",
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://api.example.com/v1/grids/{grid_id}"

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://api.example.com/v1/grids/{grid_id}")
.asString();
require 'uri'
require 'net/http'

url = URI("https://api.example.com/v1/grids/{grid_id}")

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_body
{
  "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": [
    {}
  ]
}
{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>"
}
]
}

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[]