curl --request POST \
--url https://api.getoneprofile.ai/tables/{table_id}/rows/ids/ \
--header 'Content-Type: application/json' \
--header 'X-API-Key: <api-key>' \
--data '
{
"cursor": "<string>",
"limit": 10000,
"offset": 1,
"sorts": [
{
"column_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"direction": "asc"
}
],
"where": {
"items": [
{
"column_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"type": "condition",
"value": "<string>"
}
],
"joiner": "and",
"unique_by": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"within": "<unknown>"
}
}
'import requests
url = "https://api.getoneprofile.ai/tables/{table_id}/rows/ids/"
payload = {
"cursor": "<string>",
"limit": 10000,
"offset": 1,
"sorts": [
{
"column_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"direction": "asc"
}
],
"where": {
"items": [
{
"column_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"type": "condition",
"value": "<string>"
}
],
"joiner": "and",
"unique_by": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"within": "<unknown>"
}
}
headers = {
"X-API-Key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'X-API-Key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
cursor: '<string>',
limit: 10000,
offset: 1,
sorts: [{column_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a', direction: 'asc'}],
where: {
items: [
{
column_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
type: 'condition',
value: '<string>'
}
],
joiner: 'and',
unique_by: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
within: '<unknown>'
}
})
};
fetch('https://api.getoneprofile.ai/tables/{table_id}/rows/ids/', 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.getoneprofile.ai/tables/{table_id}/rows/ids/",
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([
'cursor' => '<string>',
'limit' => 10000,
'offset' => 1,
'sorts' => [
[
'column_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'direction' => 'asc'
]
],
'where' => [
'items' => [
[
'column_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'type' => 'condition',
'value' => '<string>'
]
],
'joiner' => 'and',
'unique_by' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'within' => '<unknown>'
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"X-API-Key: <api-key>"
],
]);
$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.getoneprofile.ai/tables/{table_id}/rows/ids/"
payload := strings.NewReader("{\n \"cursor\": \"<string>\",\n \"limit\": 10000,\n \"offset\": 1,\n \"sorts\": [\n {\n \"column_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"direction\": \"asc\"\n }\n ],\n \"where\": {\n \"items\": [\n {\n \"column_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"type\": \"condition\",\n \"value\": \"<string>\"\n }\n ],\n \"joiner\": \"and\",\n \"unique_by\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"within\": \"<unknown>\"\n }\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("X-API-Key", "<api-key>")
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.getoneprofile.ai/tables/{table_id}/rows/ids/")
.header("X-API-Key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"cursor\": \"<string>\",\n \"limit\": 10000,\n \"offset\": 1,\n \"sorts\": [\n {\n \"column_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"direction\": \"asc\"\n }\n ],\n \"where\": {\n \"items\": [\n {\n \"column_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"type\": \"condition\",\n \"value\": \"<string>\"\n }\n ],\n \"joiner\": \"and\",\n \"unique_by\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"within\": \"<unknown>\"\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.getoneprofile.ai/tables/{table_id}/rows/ids/")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["X-API-Key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"cursor\": \"<string>\",\n \"limit\": 10000,\n \"offset\": 1,\n \"sorts\": [\n {\n \"column_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"direction\": \"asc\"\n }\n ],\n \"where\": {\n \"items\": [\n {\n \"column_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"type\": \"condition\",\n \"value\": \"<string>\"\n }\n ],\n \"joiner\": \"and\",\n \"unique_by\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"within\": \"<unknown>\"\n }\n}"
response = http.request(request)
puts response.read_body{
"data": [
"3c90c3cc-0d44-4b50-8888-8dd25736052a"
],
"next_page_cursor": "<string>",
"previous_page_cursor": "<string>"
}{
"detail": "<string>"
}{
"detail": "<string>"
}{
"detail": "<string>"
}{
"detail": "<string>",
"issues": [
{
"input": "<string>",
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>"
}
]
}{
"detail": "<string>"
}{
"detail": "<string>"
}{
"detail": "<string>"
}Query a listing's row IDs
Get the record IDs a listing selects, in order, carrying NO cell data: a page whose data are the IDs, with next_page_cursor to the rest.
Takes the same sorts, where, row_status, cursor and offset vocabulary as the rows query and answers only the membership-and-order half of it. Pages are correspondingly large (the default is 10,000 IDs) because a page of IDs is a fraction of the size of a page of rows. The two answer the same cursor for the same place in a listing, so either resumes where the other stopped; a cursor any other list answered is refused with invalid_cursor.
Pair it with the rows query’s record_ids mode: fetch an ordering once, then hydrate contents a window at a time. A client holding both can re-sort or re-filter by refetching only the ordering, and reuse every cell it already has.
A POST for the same reason the rows query is one: a filter list has no honest query-string encoding.
curl --request POST \
--url https://api.getoneprofile.ai/tables/{table_id}/rows/ids/ \
--header 'Content-Type: application/json' \
--header 'X-API-Key: <api-key>' \
--data '
{
"cursor": "<string>",
"limit": 10000,
"offset": 1,
"sorts": [
{
"column_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"direction": "asc"
}
],
"where": {
"items": [
{
"column_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"type": "condition",
"value": "<string>"
}
],
"joiner": "and",
"unique_by": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"within": "<unknown>"
}
}
'import requests
url = "https://api.getoneprofile.ai/tables/{table_id}/rows/ids/"
payload = {
"cursor": "<string>",
"limit": 10000,
"offset": 1,
"sorts": [
{
"column_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"direction": "asc"
}
],
"where": {
"items": [
{
"column_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"type": "condition",
"value": "<string>"
}
],
"joiner": "and",
"unique_by": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"within": "<unknown>"
}
}
headers = {
"X-API-Key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'X-API-Key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
cursor: '<string>',
limit: 10000,
offset: 1,
sorts: [{column_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a', direction: 'asc'}],
where: {
items: [
{
column_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
type: 'condition',
value: '<string>'
}
],
joiner: 'and',
unique_by: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
within: '<unknown>'
}
})
};
fetch('https://api.getoneprofile.ai/tables/{table_id}/rows/ids/', 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.getoneprofile.ai/tables/{table_id}/rows/ids/",
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([
'cursor' => '<string>',
'limit' => 10000,
'offset' => 1,
'sorts' => [
[
'column_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'direction' => 'asc'
]
],
'where' => [
'items' => [
[
'column_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'type' => 'condition',
'value' => '<string>'
]
],
'joiner' => 'and',
'unique_by' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'within' => '<unknown>'
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"X-API-Key: <api-key>"
],
]);
$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.getoneprofile.ai/tables/{table_id}/rows/ids/"
payload := strings.NewReader("{\n \"cursor\": \"<string>\",\n \"limit\": 10000,\n \"offset\": 1,\n \"sorts\": [\n {\n \"column_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"direction\": \"asc\"\n }\n ],\n \"where\": {\n \"items\": [\n {\n \"column_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"type\": \"condition\",\n \"value\": \"<string>\"\n }\n ],\n \"joiner\": \"and\",\n \"unique_by\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"within\": \"<unknown>\"\n }\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("X-API-Key", "<api-key>")
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.getoneprofile.ai/tables/{table_id}/rows/ids/")
.header("X-API-Key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"cursor\": \"<string>\",\n \"limit\": 10000,\n \"offset\": 1,\n \"sorts\": [\n {\n \"column_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"direction\": \"asc\"\n }\n ],\n \"where\": {\n \"items\": [\n {\n \"column_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"type\": \"condition\",\n \"value\": \"<string>\"\n }\n ],\n \"joiner\": \"and\",\n \"unique_by\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"within\": \"<unknown>\"\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.getoneprofile.ai/tables/{table_id}/rows/ids/")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["X-API-Key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"cursor\": \"<string>\",\n \"limit\": 10000,\n \"offset\": 1,\n \"sorts\": [\n {\n \"column_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"direction\": \"asc\"\n }\n ],\n \"where\": {\n \"items\": [\n {\n \"column_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"type\": \"condition\",\n \"value\": \"<string>\"\n }\n ],\n \"joiner\": \"and\",\n \"unique_by\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"within\": \"<unknown>\"\n }\n}"
response = http.request(request)
puts response.read_body{
"data": [
"3c90c3cc-0d44-4b50-8888-8dd25736052a"
],
"next_page_cursor": "<string>",
"previous_page_cursor": "<string>"
}{
"detail": "<string>"
}{
"detail": "<string>"
}{
"detail": "<string>"
}{
"detail": "<string>",
"issues": [
{
"input": "<string>",
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>"
}
]
}{
"detail": "<string>"
}{
"detail": "<string>"
}{
"detail": "<string>"
}Body
Request body for the row-ID manifest.
The same listing vocabulary as the rows query, minus the projection: this asks which rows a listing selects and in what order, not what is in them. Answering it reads no cell payload, so a client can hold a whole table's ordering cheaply and then hydrate only the window it is showing.
Was this page helpful?