Query rows through a view (its filter and columns apply)
curl --request POST \
--url http://localhost:3000/api/v1/bases/views/query \
--header 'Content-Type: application/json' \
--data '
{
"base": "<string>",
"view": "<string>",
"all": true,
"console": "<string>",
"cursor": "<string>",
"filter": "<string>",
"format": "<string>",
"includeBody": true,
"limit": "<string>",
"maxRows": "<string>",
"project": "<string>",
"sort": "<string>"
}
'import requests
url = "http://localhost:3000/api/v1/bases/views/query"
payload = {
"base": "<string>",
"view": "<string>",
"all": True,
"console": "<string>",
"cursor": "<string>",
"filter": "<string>",
"format": "<string>",
"includeBody": True,
"limit": "<string>",
"maxRows": "<string>",
"project": "<string>",
"sort": "<string>"
}
headers = {"Content-Type": "application/json"}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'Content-Type': 'application/json'},
body: JSON.stringify({
base: '<string>',
view: '<string>',
all: true,
console: '<string>',
cursor: '<string>',
filter: '<string>',
format: '<string>',
includeBody: true,
limit: '<string>',
maxRows: '<string>',
project: '<string>',
sort: '<string>'
})
};
fetch('http://localhost:3000/api/v1/bases/views/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_PORT => "3000",
CURLOPT_URL => "http://localhost:3000/api/v1/bases/views/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([
'base' => '<string>',
'view' => '<string>',
'all' => true,
'console' => '<string>',
'cursor' => '<string>',
'filter' => '<string>',
'format' => '<string>',
'includeBody' => true,
'limit' => '<string>',
'maxRows' => '<string>',
'project' => '<string>',
'sort' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json"
],
]);
$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 := "http://localhost:3000/api/v1/bases/views/query"
payload := strings.NewReader("{\n \"base\": \"<string>\",\n \"view\": \"<string>\",\n \"all\": true,\n \"console\": \"<string>\",\n \"cursor\": \"<string>\",\n \"filter\": \"<string>\",\n \"format\": \"<string>\",\n \"includeBody\": true,\n \"limit\": \"<string>\",\n \"maxRows\": \"<string>\",\n \"project\": \"<string>\",\n \"sort\": \"<string>\"\n}")
req, _ := http.NewRequest("POST", url, payload)
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("http://localhost:3000/api/v1/bases/views/query")
.header("Content-Type", "application/json")
.body("{\n \"base\": \"<string>\",\n \"view\": \"<string>\",\n \"all\": true,\n \"console\": \"<string>\",\n \"cursor\": \"<string>\",\n \"filter\": \"<string>\",\n \"format\": \"<string>\",\n \"includeBody\": true,\n \"limit\": \"<string>\",\n \"maxRows\": \"<string>\",\n \"project\": \"<string>\",\n \"sort\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("http://localhost:3000/api/v1/bases/views/query")
http = Net::HTTP.new(url.host, url.port)
request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n \"base\": \"<string>\",\n \"view\": \"<string>\",\n \"all\": true,\n \"console\": \"<string>\",\n \"cursor\": \"<string>\",\n \"filter\": \"<string>\",\n \"format\": \"<string>\",\n \"includeBody\": true,\n \"limit\": \"<string>\",\n \"maxRows\": \"<string>\",\n \"project\": \"<string>\",\n \"sort\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"baseRef": "<string>",
"columns": [
"<string>"
],
"consoleUrl": "<string>",
"nextCursor": "<string>",
"pagination": {
"count": 123,
"hasMore": true,
"limit": 123,
"nextCommand": "<string>",
"nextCursor": "<string>"
},
"projectRef": "<string>",
"rows": [
{
"rowId": "<string>",
"values": {},
"version": 123,
"archivedAt": "<string>",
"body": "<string>"
}
],
"success": true,
"truncated": true,
"users": {},
"viewId": "<string>"
}bases
Query rows through a view (its filter and columns apply)
POST
/
api
/
v1
/
bases
/
views
/
query
Query rows through a view (its filter and columns apply)
curl --request POST \
--url http://localhost:3000/api/v1/bases/views/query \
--header 'Content-Type: application/json' \
--data '
{
"base": "<string>",
"view": "<string>",
"all": true,
"console": "<string>",
"cursor": "<string>",
"filter": "<string>",
"format": "<string>",
"includeBody": true,
"limit": "<string>",
"maxRows": "<string>",
"project": "<string>",
"sort": "<string>"
}
'import requests
url = "http://localhost:3000/api/v1/bases/views/query"
payload = {
"base": "<string>",
"view": "<string>",
"all": True,
"console": "<string>",
"cursor": "<string>",
"filter": "<string>",
"format": "<string>",
"includeBody": True,
"limit": "<string>",
"maxRows": "<string>",
"project": "<string>",
"sort": "<string>"
}
headers = {"Content-Type": "application/json"}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'Content-Type': 'application/json'},
body: JSON.stringify({
base: '<string>',
view: '<string>',
all: true,
console: '<string>',
cursor: '<string>',
filter: '<string>',
format: '<string>',
includeBody: true,
limit: '<string>',
maxRows: '<string>',
project: '<string>',
sort: '<string>'
})
};
fetch('http://localhost:3000/api/v1/bases/views/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_PORT => "3000",
CURLOPT_URL => "http://localhost:3000/api/v1/bases/views/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([
'base' => '<string>',
'view' => '<string>',
'all' => true,
'console' => '<string>',
'cursor' => '<string>',
'filter' => '<string>',
'format' => '<string>',
'includeBody' => true,
'limit' => '<string>',
'maxRows' => '<string>',
'project' => '<string>',
'sort' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json"
],
]);
$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 := "http://localhost:3000/api/v1/bases/views/query"
payload := strings.NewReader("{\n \"base\": \"<string>\",\n \"view\": \"<string>\",\n \"all\": true,\n \"console\": \"<string>\",\n \"cursor\": \"<string>\",\n \"filter\": \"<string>\",\n \"format\": \"<string>\",\n \"includeBody\": true,\n \"limit\": \"<string>\",\n \"maxRows\": \"<string>\",\n \"project\": \"<string>\",\n \"sort\": \"<string>\"\n}")
req, _ := http.NewRequest("POST", url, payload)
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("http://localhost:3000/api/v1/bases/views/query")
.header("Content-Type", "application/json")
.body("{\n \"base\": \"<string>\",\n \"view\": \"<string>\",\n \"all\": true,\n \"console\": \"<string>\",\n \"cursor\": \"<string>\",\n \"filter\": \"<string>\",\n \"format\": \"<string>\",\n \"includeBody\": true,\n \"limit\": \"<string>\",\n \"maxRows\": \"<string>\",\n \"project\": \"<string>\",\n \"sort\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("http://localhost:3000/api/v1/bases/views/query")
http = Net::HTTP.new(url.host, url.port)
request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n \"base\": \"<string>\",\n \"view\": \"<string>\",\n \"all\": true,\n \"console\": \"<string>\",\n \"cursor\": \"<string>\",\n \"filter\": \"<string>\",\n \"format\": \"<string>\",\n \"includeBody\": true,\n \"limit\": \"<string>\",\n \"maxRows\": \"<string>\",\n \"project\": \"<string>\",\n \"sort\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"baseRef": "<string>",
"columns": [
"<string>"
],
"consoleUrl": "<string>",
"nextCursor": "<string>",
"pagination": {
"count": 123,
"hasMore": true,
"limit": 123,
"nextCommand": "<string>",
"nextCursor": "<string>"
},
"projectRef": "<string>",
"rows": [
{
"rowId": "<string>",
"values": {},
"version": 123,
"archivedAt": "<string>",
"body": "<string>"
}
],
"success": true,
"truncated": true,
"users": {},
"viewId": "<string>"
}Body
application/json
Base id or slug
View id
Follow cursors until the end or --max-rows
Console base URL
Opaque cursor from a previous page
Query AST filter, inline JSON or @file
Human output: table|csv|json (default table)
Include the row body when readable
Rows per page, 1-500 (default 100)
Stop following cursors after this many rows (default 10000, max 100000)
Console project id or slug; overrides the saved Console scope
Comma-separated sort keys, key[:asc|desc], e.g. amount:desc,created_time (max 3)
Response
Success — body conforms to the @Returns schema.
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes