Read grid data

curl --request POST \
  --url https://api.example.com/api/v1/business/grids/data \
  --header 'Content-Type: application/json' \
  --header 'x-project-id: <x-project-id>' \
  --data '
{
  "grid_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "row_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "column_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "workflow_run_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "query": "<string>",
  "page": 1,
  "page_size": 50,
  "column_ids": [
    "3c90c3cc-0d44-4b50-8888-8dd25736052a"
  ],
  "row_ids": [
    "3c90c3cc-0d44-4b50-8888-8dd25736052a"
  ],
  "column_type": [],
  "field_name": "<string>",
  "workflow_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
'

import requests

url = "https://api.example.com/api/v1/business/grids/data"

payload = {
    "grid_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "row_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "column_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "workflow_run_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "query": "<string>",
    "page": 1,
    "page_size": 50,
    "column_ids": ["3c90c3cc-0d44-4b50-8888-8dd25736052a"],
    "row_ids": ["3c90c3cc-0d44-4b50-8888-8dd25736052a"],
    "column_type": [],
    "field_name": "<string>",
    "workflow_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
headers = {
    "x-project-id": "<x-project-id>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {'x-project-id': '<x-project-id>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    grid_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    row_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    column_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    workflow_run_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    query: '<string>',
    page: 1,
    page_size: 50,
    column_ids: ['3c90c3cc-0d44-4b50-8888-8dd25736052a'],
    row_ids: ['3c90c3cc-0d44-4b50-8888-8dd25736052a'],
    column_type: [],
    field_name: '<string>',
    workflow_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a'
  })
};

fetch('https://api.example.com/api/v1/business/grids/data', 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/api/v1/business/grids/data",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'grid_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    'row_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    'column_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    'workflow_run_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    'query' => '<string>',
    'page' => 1,
    'page_size' => 50,
    'column_ids' => [
        '3c90c3cc-0d44-4b50-8888-8dd25736052a'
    ],
    'row_ids' => [
        '3c90c3cc-0d44-4b50-8888-8dd25736052a'
    ],
    'column_type' => [
        
    ],
    'field_name' => '<string>',
    'workflow_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a'
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "x-project-id: <x-project-id>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.example.com/api/v1/business/grids/data"

	payload := strings.NewReader("{\n  \"grid_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"row_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"column_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"workflow_run_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"query\": \"<string>\",\n  \"page\": 1,\n  \"page_size\": 50,\n  \"column_ids\": [\n    \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n  ],\n  \"row_ids\": [\n    \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n  ],\n  \"column_type\": [],\n  \"field_name\": \"<string>\",\n  \"workflow_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("x-project-id", "<x-project-id>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.example.com/api/v1/business/grids/data")
  .header("x-project-id", "<x-project-id>")
  .header("Content-Type", "application/json")
  .body("{\n  \"grid_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"row_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"column_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"workflow_run_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"query\": \"<string>\",\n  \"page\": 1,\n  \"page_size\": 50,\n  \"column_ids\": [\n    \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n  ],\n  \"row_ids\": [\n    \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n  ],\n  \"column_type\": [],\n  \"field_name\": \"<string>\",\n  \"workflow_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.example.com/api/v1/business/grids/data")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["x-project-id"] = '<x-project-id>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"grid_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"row_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"column_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"workflow_run_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"query\": \"<string>\",\n  \"page\": 1,\n  \"page_size\": 50,\n  \"column_ids\": [\n    \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n  ],\n  \"row_ids\": [\n    \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n  ],\n  \"column_type\": [],\n  \"field_name\": \"<string>\",\n  \"workflow_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n}"

response = http.request(request)
puts response.read_body

{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>",
      "input": "<unknown>",
      "ctx": {}
    }
  ]
}

POST

api

business

grids

data

Read grid data

curl --request POST \
  --url https://api.example.com/api/v1/business/grids/data \
  --header 'Content-Type: application/json' \
  --header 'x-project-id: <x-project-id>' \
  --data '
{
  "grid_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "row_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "column_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "workflow_run_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "query": "<string>",
  "page": 1,
  "page_size": 50,
  "column_ids": [
    "3c90c3cc-0d44-4b50-8888-8dd25736052a"
  ],
  "row_ids": [
    "3c90c3cc-0d44-4b50-8888-8dd25736052a"
  ],
  "column_type": [],
  "field_name": "<string>",
  "workflow_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
'

import requests

url = "https://api.example.com/api/v1/business/grids/data"

payload = {
    "grid_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "row_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "column_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "workflow_run_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "query": "<string>",
    "page": 1,
    "page_size": 50,
    "column_ids": ["3c90c3cc-0d44-4b50-8888-8dd25736052a"],
    "row_ids": ["3c90c3cc-0d44-4b50-8888-8dd25736052a"],
    "column_type": [],
    "field_name": "<string>",
    "workflow_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
headers = {
    "x-project-id": "<x-project-id>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {'x-project-id': '<x-project-id>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    grid_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    row_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    column_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    workflow_run_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    query: '<string>',
    page: 1,
    page_size: 50,
    column_ids: ['3c90c3cc-0d44-4b50-8888-8dd25736052a'],
    row_ids: ['3c90c3cc-0d44-4b50-8888-8dd25736052a'],
    column_type: [],
    field_name: '<string>',
    workflow_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a'
  })
};

fetch('https://api.example.com/api/v1/business/grids/data', 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/api/v1/business/grids/data",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'grid_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    'row_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    'column_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    'workflow_run_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    'query' => '<string>',
    'page' => 1,
    'page_size' => 50,
    'column_ids' => [
        '3c90c3cc-0d44-4b50-8888-8dd25736052a'
    ],
    'row_ids' => [
        '3c90c3cc-0d44-4b50-8888-8dd25736052a'
    ],
    'column_type' => [
        
    ],
    'field_name' => '<string>',
    'workflow_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a'
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "x-project-id: <x-project-id>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.example.com/api/v1/business/grids/data"

	payload := strings.NewReader("{\n  \"grid_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"row_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"column_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"workflow_run_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"query\": \"<string>\",\n  \"page\": 1,\n  \"page_size\": 50,\n  \"column_ids\": [\n    \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n  ],\n  \"row_ids\": [\n    \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n  ],\n  \"column_type\": [],\n  \"field_name\": \"<string>\",\n  \"workflow_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("x-project-id", "<x-project-id>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.example.com/api/v1/business/grids/data")
  .header("x-project-id", "<x-project-id>")
  .header("Content-Type", "application/json")
  .body("{\n  \"grid_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"row_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"column_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"workflow_run_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"query\": \"<string>\",\n  \"page\": 1,\n  \"page_size\": 50,\n  \"column_ids\": [\n    \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n  ],\n  \"row_ids\": [\n    \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n  ],\n  \"column_type\": [],\n  \"field_name\": \"<string>\",\n  \"workflow_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.example.com/api/v1/business/grids/data")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["x-project-id"] = '<x-project-id>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"grid_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"row_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"column_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"workflow_run_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"query\": \"<string>\",\n  \"page\": 1,\n  \"page_size\": 50,\n  \"column_ids\": [\n    \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n  ],\n  \"row_ids\": [\n    \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n  ],\n  \"column_type\": [],\n  \"field_name\": \"<string>\",\n  \"workflow_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n}"

response = http.request(request)
puts response.read_body

{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>",
      "input": "<unknown>",
      "ctx": {}
    }
  ]
}

Headers

x-project-id

string<uuid>

required

Project ID for tenant scoping

X-Workspace-Id

string<uuid> | null

Overrides the key's workspace

X-API-Key

string | null

User API key

Body

application/json

view

enum<string>

required

Which grid data slice to return: columns, rows, cell (needs row_id/column_id), cell_run (that cell's producing run - needs row_id/column_id/workflow_run_id), or row_search. Prefer cell/cell_run over rows+page_size=1 for a single-row/cell question - but only for expandable (blob-backed) columns, e.g. workflow/output columns with markdown/json/array/file content; plain scalar columns (text/number/boolean/single_select) already return their full value via rows and have no cell view to expand.

Available options:

columns,

rows,

cell,

cell_run,

row_search

grid_id

string<uuid>

required

Grid to read from

row_id

string<uuid> | null

Row id; required for cell and cell_run views

column_id

string<uuid> | null

Column id; required for cell and cell_run views. For cell_run specifically, must be the WORKFLOW-type column id (not the input/output column) - the one whose AI runs are being traced.

workflow_run_id

string<uuid> | null

Run id; required for the cell_run view

query

string | null

Search text; required for the row_search view. row_search matches only searchable (text-like input) cell values — generated workflow output stored as markdown/JSON/blobs is not indexed and won't match.

page

integer

default:1

Required range: x >= 1

page_size

integer

default:50

Required range: 1 <= x <= 200

column_ids

string<uuid>[] | null

Column id filter for the rows view — return only these columns per row instead of every column. See also field_name/column_type for the columns view.

row_ids

string<uuid>[] | null

Row id filter for the rows view — fetch specific, non-contiguous rows (e.g. 'rows 3, 7, and 9') instead of a page range. Resolve ordinal positions to ids with a prior rows view read, then pass them here.

column_type

enum<string>[] | null

Column-type filter for the columns view. Defaults to INPUT columns; pass ['output'] to see the generated/workflow columns the grid produces for each row.

Available options:

input,

workflow,

output

field_name

string | null

Column filter for the columns view — matches the underlying workflow input schema's field name (not the grid's display column name). Use this to answer 'which column maps to field X' directly instead of listing all columns and matching by eye.

workflow_id

string<uuid> | null

Filter columns by workflow id (for the columns view)

Response

Successful Response

⌘I

Getting Started

Identity & Project

Tasks

Agent Runs

Playbooks

Grids

Knowledge & Brand

Content Intelligence

Integrations & Attachments

Read grid data

Headers

Body

Response