Query a listing's row IDs

curl --request POST \
  --url https://api.getoneprofile.ai/tables/{table_id}/rows/ids/ \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --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"
  }
}
'

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"
    }
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', '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'
    }
  })
};

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'
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "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 := "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  }\n}")

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

	req.Header.Add("Authorization", "Bearer <token>")
	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("Authorization", "Bearer <token>")
  .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  }\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["Authorization"] = 'Bearer <token>'
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  }\n}"

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

{
  "has_more": true,
  "limit": 123,
  "next_cursor": "<string>",
  "record_ids": [
    "3c90c3cc-0d44-4b50-8888-8dd25736052a"
  ]
}

{
  "detail": "<string>"
}

{
  "detail": "<string>"
}

{
  "detail": "<string>"
}

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

{
  "detail": "<string>"
}

{
  "detail": "<string>"
}

{
  "detail": "<string>"
}

table-rows

Query a listing's row IDs

Get the record IDs a listing selects, in order, carrying NO cell data.

Takes the same sorts, where and row_status 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.

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.

POST

tables

{table_id}

rows

ids

Query a listing's row IDs

curl --request POST \
  --url https://api.getoneprofile.ai/tables/{table_id}/rows/ids/ \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --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"
  }
}
'

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"
    }
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', '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'
    }
  })
};

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'
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "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 := "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  }\n}")

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

	req.Header.Add("Authorization", "Bearer <token>")
	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("Authorization", "Bearer <token>")
  .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  }\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["Authorization"] = 'Bearer <token>'
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  }\n}"

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

{
  "has_more": true,
  "limit": 123,
  "next_cursor": "<string>",
  "record_ids": [
    "3c90c3cc-0d44-4b50-8888-8dd25736052a"
  ]
}

{
  "detail": "<string>"
}

{
  "detail": "<string>"
}

{
  "detail": "<string>"
}

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

{
  "detail": "<string>"
}

{
  "detail": "<string>"
}

{
  "detail": "<string>"
}

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

table_id

string<uuid>

required

Body

application/json

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.

cursor

string | null

Opaque cursor from a previous page's next_cursor.

Maximum string length: 1024

limit

integer

default:10000

Maximum record IDs per page. Far higher than the rows query's limit because a page of IDs carries no cells.

Required range: 1 <= x <= 10000

offset

integer | null

Start the listing this many rows in. Mutually exclusive with cursor.

Required range: x >= 0

row_status

enum<string> | null

Restrict to rows whose cells are errored or fully_computed.

Available options:

errored,

fully_computed

sorts

TableRowSortSchema · object[]

Order by these columns, in priority order, instead of display order.

Maximum array length: 3

Show child attributes

where

TableRowsWhereSchema · object | null

The predicate tree every returned row must satisfy.

Show child attributes

Response

Successful Response

One keyset page of a listing's record IDs, in order.

has_more

boolean

required

limit

integer

required

next_cursor

string | null

required

Cursor for the next page; None when this is the last page.

record_ids

string<uuid>[]

required

API reference

Endpoints

Query a listing's row IDs

Authorizations

Path Parameters

Body

Response