List or read grids

curl --request POST \
  --url https://api.example.com/api/v1/business/grids/query \
  --header 'Content-Type: application/json' \
  --header 'x-project-id: <x-project-id>' \
  --data '
{
  "grid_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "workflow_ids": [
    "3c90c3cc-0d44-4b50-8888-8dd25736052a"
  ],
  "page": 1,
  "page_size": 50,
  "sort_by": "created_at",
  "sort_order": "desc",
  "sort_status": "awaiting_interaction",
  "search": "<string>",
  "created_by": [
    "<string>"
  ],
  "last_run_after": "2023-11-07T05:31:56Z",
  "last_run_before": "2023-11-07T05:31:56Z"
}
'

import requests

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

payload = {
    "grid_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "workflow_ids": ["3c90c3cc-0d44-4b50-8888-8dd25736052a"],
    "page": 1,
    "page_size": 50,
    "sort_by": "created_at",
    "sort_order": "desc",
    "sort_status": "awaiting_interaction",
    "search": "<string>",
    "created_by": ["<string>"],
    "last_run_after": "2023-11-07T05:31:56Z",
    "last_run_before": "2023-11-07T05:31:56Z"
}
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',
    workflow_ids: ['3c90c3cc-0d44-4b50-8888-8dd25736052a'],
    page: 1,
    page_size: 50,
    sort_by: 'created_at',
    sort_order: 'desc',
    sort_status: 'awaiting_interaction',
    search: '<string>',
    created_by: ['<string>'],
    last_run_after: '2023-11-07T05:31:56Z',
    last_run_before: '2023-11-07T05:31:56Z'
  })
};

fetch('https://api.example.com/api/v1/business/grids/query', 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/query",
  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',
    'workflow_ids' => [
        '3c90c3cc-0d44-4b50-8888-8dd25736052a'
    ],
    'page' => 1,
    'page_size' => 50,
    'sort_by' => 'created_at',
    'sort_order' => 'desc',
    'sort_status' => 'awaiting_interaction',
    'search' => '<string>',
    'created_by' => [
        '<string>'
    ],
    'last_run_after' => '2023-11-07T05:31:56Z',
    'last_run_before' => '2023-11-07T05:31:56Z'
  ]),
  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/query"

	payload := strings.NewReader("{\n  \"grid_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"workflow_ids\": [\n    \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n  ],\n  \"page\": 1,\n  \"page_size\": 50,\n  \"sort_by\": \"created_at\",\n  \"sort_order\": \"desc\",\n  \"sort_status\": \"awaiting_interaction\",\n  \"search\": \"<string>\",\n  \"created_by\": [\n    \"<string>\"\n  ],\n  \"last_run_after\": \"2023-11-07T05:31:56Z\",\n  \"last_run_before\": \"2023-11-07T05:31:56Z\"\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/query")
  .header("x-project-id", "<x-project-id>")
  .header("Content-Type", "application/json")
  .body("{\n  \"grid_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"workflow_ids\": [\n    \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n  ],\n  \"page\": 1,\n  \"page_size\": 50,\n  \"sort_by\": \"created_at\",\n  \"sort_order\": \"desc\",\n  \"sort_status\": \"awaiting_interaction\",\n  \"search\": \"<string>\",\n  \"created_by\": [\n    \"<string>\"\n  ],\n  \"last_run_after\": \"2023-11-07T05:31:56Z\",\n  \"last_run_before\": \"2023-11-07T05:31:56Z\"\n}")
  .asString();

require 'uri'
require 'net/http'

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

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  \"workflow_ids\": [\n    \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n  ],\n  \"page\": 1,\n  \"page_size\": 50,\n  \"sort_by\": \"created_at\",\n  \"sort_order\": \"desc\",\n  \"sort_status\": \"awaiting_interaction\",\n  \"search\": \"<string>\",\n  \"created_by\": [\n    \"<string>\"\n  ],\n  \"last_run_after\": \"2023-11-07T05:31:56Z\",\n  \"last_run_before\": \"2023-11-07T05:31:56Z\"\n}"

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

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

POST

api

business

grids

query

List or read grids

curl --request POST \
  --url https://api.example.com/api/v1/business/grids/query \
  --header 'Content-Type: application/json' \
  --header 'x-project-id: <x-project-id>' \
  --data '
{
  "grid_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "workflow_ids": [
    "3c90c3cc-0d44-4b50-8888-8dd25736052a"
  ],
  "page": 1,
  "page_size": 50,
  "sort_by": "created_at",
  "sort_order": "desc",
  "sort_status": "awaiting_interaction",
  "search": "<string>",
  "created_by": [
    "<string>"
  ],
  "last_run_after": "2023-11-07T05:31:56Z",
  "last_run_before": "2023-11-07T05:31:56Z"
}
'

import requests

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

payload = {
    "grid_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "workflow_ids": ["3c90c3cc-0d44-4b50-8888-8dd25736052a"],
    "page": 1,
    "page_size": 50,
    "sort_by": "created_at",
    "sort_order": "desc",
    "sort_status": "awaiting_interaction",
    "search": "<string>",
    "created_by": ["<string>"],
    "last_run_after": "2023-11-07T05:31:56Z",
    "last_run_before": "2023-11-07T05:31:56Z"
}
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',
    workflow_ids: ['3c90c3cc-0d44-4b50-8888-8dd25736052a'],
    page: 1,
    page_size: 50,
    sort_by: 'created_at',
    sort_order: 'desc',
    sort_status: 'awaiting_interaction',
    search: '<string>',
    created_by: ['<string>'],
    last_run_after: '2023-11-07T05:31:56Z',
    last_run_before: '2023-11-07T05:31:56Z'
  })
};

fetch('https://api.example.com/api/v1/business/grids/query', 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/query",
  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',
    'workflow_ids' => [
        '3c90c3cc-0d44-4b50-8888-8dd25736052a'
    ],
    'page' => 1,
    'page_size' => 50,
    'sort_by' => 'created_at',
    'sort_order' => 'desc',
    'sort_status' => 'awaiting_interaction',
    'search' => '<string>',
    'created_by' => [
        '<string>'
    ],
    'last_run_after' => '2023-11-07T05:31:56Z',
    'last_run_before' => '2023-11-07T05:31:56Z'
  ]),
  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/query"

	payload := strings.NewReader("{\n  \"grid_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"workflow_ids\": [\n    \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n  ],\n  \"page\": 1,\n  \"page_size\": 50,\n  \"sort_by\": \"created_at\",\n  \"sort_order\": \"desc\",\n  \"sort_status\": \"awaiting_interaction\",\n  \"search\": \"<string>\",\n  \"created_by\": [\n    \"<string>\"\n  ],\n  \"last_run_after\": \"2023-11-07T05:31:56Z\",\n  \"last_run_before\": \"2023-11-07T05:31:56Z\"\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/query")
  .header("x-project-id", "<x-project-id>")
  .header("Content-Type", "application/json")
  .body("{\n  \"grid_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"workflow_ids\": [\n    \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n  ],\n  \"page\": 1,\n  \"page_size\": 50,\n  \"sort_by\": \"created_at\",\n  \"sort_order\": \"desc\",\n  \"sort_status\": \"awaiting_interaction\",\n  \"search\": \"<string>\",\n  \"created_by\": [\n    \"<string>\"\n  ],\n  \"last_run_after\": \"2023-11-07T05:31:56Z\",\n  \"last_run_before\": \"2023-11-07T05:31:56Z\"\n}")
  .asString();

require 'uri'
require 'net/http'

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

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  \"workflow_ids\": [\n    \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n  ],\n  \"page\": 1,\n  \"page_size\": 50,\n  \"sort_by\": \"created_at\",\n  \"sort_order\": \"desc\",\n  \"sort_status\": \"awaiting_interaction\",\n  \"search\": \"<string>\",\n  \"created_by\": [\n    \"<string>\"\n  ],\n  \"last_run_after\": \"2023-11-07T05:31:56Z\",\n  \"last_run_before\": \"2023-11-07T05:31:56Z\"\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

Grid listing: 'list' (inventory), 'detail' (config), 'status' (processing), or 'column_options' (the live, project-specific catalog of addable column types and usable workflow columns — call it to get the valid column types rather than guessing them).

Available options:

list,

detail,

status,

column_options

grid_id

string<uuid> | null

Grid id. Required for view='detail' and view='status'. Optional for view='list' and view='column_options'

workflow_ids

string<uuid>[] | null

Optional workflow filter for the list view

page

integer

default:1

Required range: x >= 1

page_size

integer

default:50

Required range: 1 <= x <= 100

sort_by

enum<string>

default:created_at

Sort the list view by created_at, updated_at, or status_count. Use status_count to rank grids by how many rows are in the sort_status state — e.g. sort_by=status_count + sort_status=failed + sort_order=desc surfaces the grids with the most failed rows first, so 'which grids failed' is answered from the top of one page instead of scanning every grid.

Available options:

created_at,

updated_at,

status_count

sort_order

enum<string>

default:desc

Sort direction for sort_by; asc or desc.

Available options:

asc,

desc

sort_status

enum<string>

default:awaiting_interaction

Row status counted when sort_by=status_count (e.g. failed, completed, awaiting_interaction). Pairs with sort_by=status_count to rank grids by that status.

Available options:

pending,

running,

completed,

failed,

cancelled,

awaiting_interaction

string | null

Free-text filter on grid name for the list view.

created_by

string[] | null

Filter by creator user id(s)

last_run_after

string<date-time> | null

Only grids with a run at/after this time

last_run_before

string<date-time> | null

Only grids with a run at/before this time

Response

Successful Response

⌘I

Getting Started

Identity & Project

Tasks

Agent Runs

Playbooks

Grids

Knowledge & Brand

Content Intelligence

Integrations & Attachments

List or read grids

Headers

Body

Response