Use hasMore to determine if additional pages exist. Increment offset by limit for each subsequent request.To return only some fields, pass fields with a list of field names or IDs (for example "fields": ["Name", "Status"]).
Sorting
When no sort parameter is provided, records are returned in ascending order by creation time (createdAt ASC).
Field name, field ID, or system field (id, createdAt, updatedAt)
direction
string
No
"asc" (default) or "desc"
fieldId is also accepted for backward compatibility, but field is preferred. For a single ascending sort you can pass the field name as a string ("sort": "Name").
Filtering
Use the filter parameter to query records. Each condition takes a field (name or ID) and exactly one operator. Filters support nested AND/OR logic, up to 20 levels deep. A condition on a field that doesn’t exist is ignored rather than rejected, so check field names if a filter returns every record.
Contains substring (text) or has value (multi-select)
"john"
does_not_contain
Does not contain
"test"
starts_with
Starts with string
"Mr."
ends_with
Ends with string
"@gmail.com"
is_empty
Field has no value
true
is_not_empty
Field has a value
true
in
Value is in array
["Active", "Pending"]
not_in
Value is not in array
["Archived", "Deleted"]
greater_than
Greater than (numbers/dates)
100 or "2024-01-01"
greater_than_or_equal_to
Greater than or equal
100
less_than
Less than
50
less_than_or_equal_to
Less than or equal
50
Text operators are case-sensitive. Add "mode": "insensitive" to a condition to ignore case, for example
{ "field": "Email", "equals": "ann@example.com", "mode": "insensitive" }.
Operators by Field Type
Field Type
Supported Operators
Text (single_line_text, long_text, rich_text, email, url, phone_number)
equals, does_not_equal, contains, does_not_contain, starts_with, ends_with, is_empty, is_not_empty, in, not_in
Number (number, currency, percent, rating, duration, autonumber)
equals, does_not_equal, greater_than, greater_than_or_equal_to, less_than, less_than_or_equal_to, is_empty, is_not_empty, in, not_in
equals, does_not_equal, contains, does_not_contain, is_empty, is_not_empty, in, not_in
Checkbox
equals, does_not_equal
Attachments (attachments)
is_empty, is_not_empty
Linked Record
contains, does_not_contain, is_empty, is_not_empty, in, not_in
User (user, created_by, updated_by)
in, not_in, is_empty, is_not_empty
Formula
The operators for its resultType (array uses the selection operators)
autonumber doesn’t support is_empty or is_not_empty. rollup and source fields can’t be filtered, and a lookup can only be filtered (as a checkbox) when it looks up a checkbox.
Number of records to return (default: 500, max: 2000)
Required range: 1 <= x <= 2000
offset
integer
default:0
Integer-based offset - Number of records to skip for pagination
Required range: x >= 0
sort
stringobject[]
A field name to sort ascending by, or an array of sort objects. When not provided, records are returned in ascending order by creation time (createdAt ASC). All queries include an internal tie-breaker to ensure deterministic ordering across paginated requests.
filter
object
Filter condition to query records. Supports nested AND/OR logic. Each condition requires field (field ID or name) and exactly one operator. See Filtering for details.
Show child attributes
Example:
{ "field": "Status", "equals": "Active" }
fields
string[]
Optional list of field names or IDs to return. Omit to return every field.
Response
List of records
records
object[]
required
Array of records
Show child attributes
total
integer
required
Total number of records matching the query
hasMore
boolean
required
Whether there are more records available beyond this page
{"docsConfig":{"theme":"luma","$schema":"https://mintlify.com/docs.json","name":"Zite Platform","colors":{"primary":"#292929","light":"#FFD202","dark":"#0F0F0F"},"logo":{"light":"https://mintcdn.com/zite-js/LSPdozoqw4nFOq3k/logo/light.svg?fit=max\u0026auto=format\u0026n=LSPdozoqw4nFOq3k\u0026q=85\u0026s=fa83feb01f3d85c0ca46aad9a6419281","dark":"https://mintcdn.com/zite-js/LSPdozoqw4nFOq3k/logo/dark.svg?fit=max\u0026auto=format\u0026n=LSPdozoqw4nFOq3k\u0026q=85\u0026s=2bda77a8d14427719e80cfa4fb133234"},"favicon":"https://mintcdn.com/zite-js/LSPdozoqw4nFOq3k/favicon.svg?fit=max\u0026auto=format\u0026n=LSPdozoqw4nFOq3k\u0026q=85\u0026s=f87512a1c9310c771dd35a01d948534c","api":{},"appearance":{"default":"dark"},"background":{"color":{"light":"#FBFBFB","dark":"#252522"}},"navbar":{"primary":{"type":"button","label":"Dashboard","href":"https://app.zite.com"}},"footer":{"socials":{"x":"https://x.com/zite","linkedin":"https://www.linkedin.com/company/zitecom","github":"https://github.com/zite"},"links":[{"header":"Documentation","items":[{"label":"Quickstart","href":"/quickstart"},{"label":"Build with agents","href":"/mcp/overview"},{"label":"Zite.js","href":"/framework/overview"},{"label":"Database API","href":"/api/overview"},{"label":"Build API","href":"/build-api/overview"}]},{"header":"Product","items":[{"label":"Zite.com","href":"https://zite.com"},{"label":"Dashboard","href":"https://app.zite.com"},{"label":"Databases","href":"https://zite.com/database"},{"label":"Help center","href":"https://zite.com/help"}]},{"header":"Company","items":[{"label":"Careers","href":"https://recruiting.zite.com/join-us"},{"label":"Enterprise","href":"https://zite.com/enterprise"},{"label":"Blog","href":"https://zite.com/blog"}]}]},"fonts":{"heading":{"family":"STK Bureau Serif","weight":500,"source":"fonts/STKBureauSerif-Medium.woff2","format":"woff2"},"body":{"family":"STK Bureau Sans","weight":400,"source":"fonts/STKBureauSans-Regular.woff2","format":"woff2"}},"icons":{"library":"lucide"},"styling":{"eyebrows":"section","codeblocks":"system","latex":false},"integrations":{"intercom":{"appId":"bbe4x0bh"}},"contextual":{"options":["copy","view","chatgpt","claude","cursor","vscode"],"display":"header"},"interaction":{"drilldown":false},"navigation":{"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"zite-js","hasAudioNarration":false,"actualSubdomain":"zite-js","customDomains":["developers.zite.com"],"gitSource":{"type":"github","owner":"zite","repo":"developer-docs","deployBranch":"main","contentDirectory":"","isPrivate":true,"mountPath":"","label":""},"entitlements":{},"buildId":"6ae31a100184476a8fdaf921","clientVersion":"0.0.4167","searchFilterCounts":[{"language":"default","tag":"Guides","count":42},{"language":"default","tag":"Database API","count":32},{"language":"default","tag":"API reference","count":30},{"language":"default","tag":"Build API","count":20},{"language":"default","tag":"Build \u0026 Deploy","count":20},{"language":"default","tag":"Recipes","count":13},{"language":"default","tag":"Build sessions","count":10},{"language":"default","tag":"Zite.js framework","count":10},{"language":"default","tag":"Records","count":9},{"language":"default","tag":"Core concepts","count":6}]},"assistantConfig":{"enableAskAiButton":false,"enableStarterQuestions":false,"enableContextualStarterQuestions":false,"enableAskAiSearchBar":true},"basePath":"","hasChatPermissions":false,"hasWebMcpPermissions":false,"toggles":[{"name":"kill-isr","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-rbac-roles","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-mintlify-slack","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-integrations-settings","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"rbac-expansion","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-pr-grouping","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-prefix","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"analytics-v7","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"user-flows-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"no-publish-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-onboarding","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving-live","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"stripTemperatureMiddleware","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"support-platform-pylon-zendesk","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"instant-rollback","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications-server","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-fable","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fixed-ai-action-pricing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automation-resolve-merge-conflict","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"scoped-publishing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"mintql","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"page-level-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-version-history-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-page-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"full-page-search","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workspace-projects","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"assistant-v5","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fork-pr-previews","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"revalidation-jwt","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-sso-scim","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"hobby-abuse-scan","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"dashboard-inbox","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-signup","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-dual-write","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-enabled","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"approve-review-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-metadata","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"sso-setup-deadline-banner","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-serve","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"live-agents","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"llms-txt-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"googleFontsInlined":false},"customCss":[{"filePath":"style.css","content":"@font-face{font-family:\"STK Bureau Sans\";src:url(\"/fonts/STKBureauSans-Regular.woff2\") format(\"woff2\");font-weight:400;font-style:normal;font-display:swap}@font-face{font-family:\"STK Bureau Serif\";src:url(\"/fonts/STKBureauSerif-Medium.woff2\") format(\"woff2\");font-weight:500;font-style:normal;font-display:swap}:root{--zb-bg: #252522;--zb-surface: #2d2d2a;--zb-surface-hi: #31312e;--zb-sunken: #242421;--zb-sunken-light: #f3f3f0;--zb-rule: #353531;--zb-border: #3d3d38;--zb-edge: #4b4b48;--zb-fg: #ffffff;--zb-fg-2: #c9c9c4;--zb-muted: #989893;--zb-dim: #8c8c86;--zb-accent: #ffd202;--zb-serif: \"STK Bureau Serif\", \"Iowan Old Style\", Charter, Palatino,\n \"Palatino Linotype\", Georgia, serif;--zb-sans: \"STK Bureau Sans\", Inter, -apple-system, BlinkMacSystemFont,\n \"Segoe UI\", Helvetica, Arial, sans-serif;--zb-mono: ui-monospace, SFMono-Regular, Menlo, Monaco, monospace;--zb-ink: #252522;--zb-ink-2: #3d3d38;--zb-container: 1240px;--zb-gutter: 40px;--zb-inset: 12px}:root{--gray-50: 248 248 246;--gray-100: 241 241 238;--gray-200: 227 227 223;--gray-300: 203 203 197;--gray-400: 168 168 162;--gray-500: 152 152 147;--gray-600: 111 111 106;--gray-700: 75 75 72;--gray-800: 61 61 56;--gray-900: 45 45 42;--gray-950: 37 37 34}html.dark{--zb-ink: #f8f8f6;--zb-ink-2: #c9c9c4}a[href*=\"mintlify.com\"][href*=\"poweredBy\"],a[href*=\"mintlify.com\"][href*=\"poweredBy\"]+span{display:none!important}#sidebar-content,nav[aria-label=\"Main\"],#navbar,footer{font-family:var(--zb-sans)}html{font-synthesis-weight:none}.prose strong,.prose b{color:var(--zb-ink)}:root{--zb-code-surface: var(--zb-sunken-light)}html.dark,.zx{--zb-code-surface: var(--zb-sunken)}[data-component-part=\"code-block-root\"]{background-image:linear-gradient(\n var(--zb-code-surface),\n var(--zb-code-surface)\n )}[data-fade-overlay][data-fade-overlay],html.dark [data-fade-overlay][data-fade-overlay]{background-image:linear-gradient(\n to right,\n transparent 0,\n color-mix(in srgb, var(--zb-code-surface) 20%, transparent) 10px,\n color-mix(in srgb, var(--zb-code-surface) 55%, transparent) 25px,\n color-mix(in srgb, var(--zb-code-surface) 85%, transparent) 35px,\n var(--zb-code-surface) 45px\n )}html.dark .code-block,.zx .code-block{border-width:0;box-shadow:0 0 0 1px rgba(255, 255, 255, 0.14)}html:not(.dark) .zx .shiki,html:not(.dark) .zx .shiki span{color:var(--shiki-dark)!important;font-weight:var(--shiki-dark-font-weight)!important;text-decoration:var(--shiki-dark-text-decoration)!important}[id=\"ask-assistant-code-block-button\"]{display:none!important}.zx{--zb-copy-clearance: 40px}.zx [data-component-part=\"code-block-root\"]{--code-padding-right: 0px}.zx .code-block:has([data-floating-buttons]) .line:first-child::after{content:\"\";display:inline-block;width:var(--zb-copy-clearance)}.zx .code-block:has([data-floating-buttons]) [data-fade-overlay]{width:var(--zb-copy-clearance)}.prose a:not(.not-prose):not([class*=\"card\"]){color:var(--zb-ink);text-decoration-color:var(--zb-accent);text-decoration-thickness:1px;text-underline-offset:3px}.prose a:not(.not-prose):not([class*=\"card\"]):hover{color:var(--zb-ink-2);text-decoration-thickness:2px}[data-table-wrapper] :is(td,th) code{white-space:nowrap}[data-table-wrapper] tbody tr{--zb-row-hover: color-mix(in srgb, rgb(var(--gray-500)) 8%, transparent);transition:background-color 0.12s ease}[data-table-wrapper] tbody tr:hover{background-color:var(--zb-row-hover);box-shadow:-10px 0 0 var(--zb-row-hover),\n 10px 0 0 var(--zb-row-hover)}@media (min-width: 64rem){:root{--zx-sidebar-w: 18rem}#sidebar-content{width:var(--zx-sidebar-w)}.is-not-custom~#body-content{padding-left:var(--zx-sidebar-w)}.is-not-custom~#body-content #content-area{margin-left:max(0px, calc(50vw - 348px - var(--zx-sidebar-w)))}}body:has(.zx-hero) nav[aria-label=\"Main\"] a[aria-current=\"location\"]{background-color:transparent;color:#a8a8a2}body:has(.zx-hero) nav[aria-label=\"Main\"] a[aria-current=\"location\"]:hover{background-color:color-mix(in oklab, #fff 4%, transparent);color:#f1f1ee}html:not(.dark) body:has(.zx-hero) #navbar{--background-light: 37 37 34;--gray-50: 37 37 34;--gray-100: 45 45 42;--gray-200: 61 61 56;--gray-300: 75 75 72;--gray-400: 111 111 106;--gray-500: 152 152 147;--gray-600: 168 168 162;--gray-700: 203 203 197;--gray-800: 227 227 223;--gray-900: 241 241 238;--gray-950: 248 248 246}html:not(.dark) body:has(.zx-hero) img.nav-logo[class*=\"dark:hidden\"]{display:none}html:not(.dark) body:has(.zx-hero) img.nav-logo[class*=\"dark:block\"]{display:block}html:not(.dark) body:has(.zx-hero) #navbar [class*=\"bg-white\"]{background-color:rgba(255, 255, 255, 0.08)}body:has(.zx-hero) #navbar a[class*=\"bg-primary\"]{background-color:rgba(255, 255, 255, 0.08);box-shadow:inset 0 0 0 1px rgba(255, 255, 255, 0.1)}body:has(.zx-hero) #navbar a[class*=\"bg-primary\"]:hover{background-color:rgba(255, 255, 255, 0.12);opacity:1}body:has(.zx-hero) #navbar a[class*=\"bg-primary\"],body:has(.zx-hero) #navbar a[class*=\"bg-primary\"] *{color:#f1f1ee}#navbar [class~=\"pb-px\"]{padding-bottom:0}#navbar [class~=\"h-9\"],#navbar a[class*=\"h-[34px]\"]{height:2rem}#navbar [class~=\"size-9\"]{width:2rem;height:2rem}html:not(.dark) #sidebar-content a[aria-current=\"page\"]{background:color-mix(in oklab, var(--zb-ink) 6%, transparent);border-radius:8px}html:not(.dark) body:not(:has(.zx-hero)) nav[aria-label=\"Main\"] a[aria-current=\"location\"]{background-color:color-mix(in oklab, var(--zb-ink) 8%, transparent)}.zx{--bg: var(--zb-bg);--surface: var(--zb-surface);--surface-hi: var(--zb-surface-hi);--sunken: var(--zb-sunken);--rule: var(--zb-rule);--line: rgba(255, 255, 255, 0.06);--line-2: rgba(255, 255, 255, 0.12);--edge: rgba(255, 255, 255, 0.16);--fg: var(--zb-fg);--fg-2: var(--zb-fg-2);--muted: var(--zb-muted);--dim: var(--zb-dim);--accent: var(--zb-accent);position:relative;margin-top:-2rem;background:var(--bg);color:var(--fg);font-family:var(--zb-sans);font-weight:400;-webkit-font-smoothing:antialiased}.zx [data-as=\"p\"]{display:contents}.zx img{margin:0;pointer-events:none}.zx-bleed{margin-left:calc(50% - 50vw);margin-right:calc(50% - 50vw)}.zx-sec{position:relative;background:var(--bg)}.zx-sec+.zx-sec{border-top:1px solid var(--rule)}.zx-rails{position:absolute;inset:0;left:0;right:0;max-width:var(--zb-container);margin:0 auto;border-left:1px solid var(--rule);border-right:1px solid var(--rule);pointer-events:none}.zx-head-wrap{position:relative;border-bottom:1px solid var(--rule)}.zx-head{display:flex;align-items:flex-end;justify-content:space-between;gap:40px;max-width:var(--zb-container);margin:0 auto;padding:clamp(64px, 10.3vw, 148px) var(--zb-gutter) 40px}.zx-head-copy{max-width:800px;min-width:0}.zx-head-copy .zx-sub{max-width:598px}.zx-head-aside{flex:none;padding-bottom:4px}.zx-slot{position:relative;max-width:var(--zb-container);margin:0 auto;padding:var(--zb-inset)}.zx-eyebrow{margin:0 0 16px;font-size:0.875rem;line-height:1.857;color:var(--accent)}.zx-h1{margin:0;font-family:var(--zb-serif);font-weight:500;font-size:clamp(2.5rem, 5vw, 4rem);line-height:1.02;letter-spacing:0;color:var(--fg)}.zx-h2{margin:0;font-family:var(--zb-serif);font-weight:500;font-size:clamp(2rem, 3.6vw, 2.75rem);line-height:1.04;letter-spacing:0;color:var(--fg)}.zx-sub{margin:16px 0 0;max-width:40rem;font-size:1rem;line-height:1.625;color:var(--muted)}.zx-h1+.zx-sub{font-size:1.0625rem;line-height:1.6}.zx :not(pre)>code{font-family:var(--zb-mono);font-size:0.86em;background:rgba(255, 255, 255, 0.07);border:1px solid var(--line);padding:0.05em 0.38em;border-radius:5px}.zx-canvas{position:relative;border-radius:16px;border:1px solid var(--line);border-top-color:var(--edge);background:linear-gradient(180deg, var(--surface-hi) 0%, var(--surface) 55%);box-shadow:0 0 0 1px rgba(0, 0, 0, 0.3),\n 0 30px 70px rgba(0, 0, 0, 0.34);overflow:hidden}.zx-canvas::before{content:\"\";position:absolute;inset:0;background-image:linear-gradient(rgba(255, 255, 255, 0.02) 1px, transparent 1px),\n linear-gradient(90deg, rgba(255, 255, 255, 0.02) 1px, transparent 1px);background-size:100px 100px;mask-image:radial-gradient(125% 105% at 14% 6%, #000 0%, transparent 64%);-webkit-mask-image:radial-gradient(125% 105% at 14% 6%, #000 0%, transparent 64%);pointer-events:none}.zx-canvas>*{position:relative}.zx-canvas-flush{padding:0}.zx-btn{display:inline-flex;align-items:center;gap:8px;padding:11px 20px;border:1px solid transparent;border-radius:999px;font-size:0.9375rem;line-height:1.2;text-decoration:none;transition:background 0.15s ease, border-color 0.15s ease, color 0.15s ease,\n box-shadow 0.15s ease}.zx-btn-primary{background:var(--accent);color:#1a1a17;box-shadow:0 0 0 1px var(--accent), 0 0 0 4px rgba(255, 210, 2, 0.14)}.zx-btn-primary:hover{background:#ffdc3d;color:#1a1a17;text-decoration:none;box-shadow:0 0 0 1px #ffdc3d, 0 0 0 5px rgba(255, 210, 2, 0.2)}.zx-btn:focus-visible{outline:2px solid var(--accent);outline-offset:3px}.zx-link{display:inline-flex;align-items:center;gap:6px;font-size:0.9375rem;color:var(--fg);text-decoration:none;border-bottom:1px solid var(--accent);padding-bottom:2px;transition:color 0.15s ease}.zx-link:hover{color:var(--accent);text-decoration:none}.zx a.zx-btn{border-color:transparent}.zx a.zx-mini{border-color:var(--line)}.zx a.zx-mini:hover{border-color:var(--line-2)}.zx-radio{position:absolute;width:1px;height:1px;opacity:0}.zx-cn-head{display:flex;align-items:center;justify-content:space-between;gap:16px;padding:15px 22px;border-bottom:1px solid var(--line);background:rgba(0, 0, 0, 0.14)}.zx-cn-t{font-size:0.9375rem;color:var(--fg)}.zx-cn-url{min-width:0;padding:5px 13px;border:1px solid var(--line);border-radius:999px;background:rgba(255, 255, 255, 0.03);font-family:var(--zb-mono);font-size:0.8125rem;color:var(--muted);white-space:nowrap;overflow:hidden;text-overflow:ellipsis}.zx-cn-body{display:grid;grid-template-columns:320px minmax(0, 1fr)}.zx-pick{display:flex;flex-direction:column;gap:2px;padding:10px;border-right:1px solid var(--line);background:rgba(0, 0, 0, 0.1)}.zx-pick-row{display:flex;align-items:center;gap:11px;padding:9px 11px;border:1px solid transparent;border-radius:10px;color:var(--fg-2);cursor:pointer;transition:background 0.15s ease, border-color 0.15s ease, color 0.15s ease}.zx-pick-row:hover{background:rgba(255, 255, 255, 0.05);color:var(--fg)}.zx-pick-ico{flex:none;display:inline-flex;align-items:center;justify-content:center;width:28px;height:28px;border:1px solid var(--line-2);border-radius:8px;background:#1d1d1b;color:var(--muted)}.zx-pick-ico img,.zx-pick-ico svg{width:15px;height:15px;display:block}.zx-pick-n{flex:1;min-width:0;font-size:0.9375rem;color:inherit;white-space:nowrap;overflow:hidden;text-overflow:ellipsis}.zx-pane{display:flex;align-items:center;min-width:0;padding:26px 28px}.zx-pane .zx-panels{max-width:620px;margin:0 auto}.zx-pane .zx-panel{align-content:center}.zx-panels{display:grid;width:100%;min-width:0}.zx-panel{display:grid;grid-row:1;grid-column:1;grid-template-columns:minmax(0, 1fr);width:100%;min-width:0;visibility:hidden;opacity:0;transition:opacity 0.18s ease}.zx-go{justify-self:start;padding:12px 22px;font-size:0.9375rem}.zx-go img,.zx-go svg{flex:none;width:16px;height:16px;display:block}.zx-go-i{margin-left:3px;font-size:0.8125rem}.zx-cue{margin:0 0 12px;font-size:0.9375rem;line-height:1.5;color:var(--fg-2)}.zx-note{margin:16px 0 0;font-size:0.875rem;line-height:1.6;color:var(--muted)}.zx-note strong{color:var(--fg-2)}.zx-more{justify-self:start;margin-top:16px;font-size:0.875rem;color:var(--accent);text-decoration:none}.zx-more:hover{color:#ffdc3d;text-decoration:none}.zx .zx-panel>div{margin:0}.zx-panel pre{margin:0}.zx-next{display:flex;align-items:baseline;gap:16px;padding:14px 22px;border-top:1px solid var(--line);background:rgba(0, 0, 0, 0.14)}.zx-next-l{flex:none;font-size:0.8125rem;color:var(--dim)}.zx-next-q{min-width:0;font-family:var(--zb-serif);font-size:1rem;line-height:1.5;color:var(--fg-2)}.zx-alt{display:flex;flex-wrap:wrap;align-items:center;justify-content:flex-end;gap:14px 32px;padding:28px 22px 18px 4px}.zx-tabs-bar{display:flex;justify-content:center;padding:14px 16px;border-bottom:1px solid var(--line);background:rgba(0, 0, 0, 0.14)}.zx-tabs{display:inline-flex;flex-wrap:wrap;gap:4px;padding:4px;border:1px solid var(--line);border-radius:999px;background:var(--sunken)}.zx-tab{cursor:pointer;padding:7px 16px;border-radius:999px;font-size:0.875rem;line-height:1.2;color:var(--muted);transition:color 0.15s ease, background 0.15s ease}.zx-tab:hover{color:var(--fg)}.zx-split{display:grid;grid-template-columns:minmax(0, 1fr) minmax(0, 1fr);height:100%}.zx-split>*{min-width:0;display:flex;flex-direction:column;justify-content:center;padding:28px}.zx-split-code{background:rgba(0, 0, 0, 0.16);border-right:1px solid var(--line)}.zx-split-lead{grid-template-columns:minmax(0, 1.55fr) minmax(0, 1fr)}.zx-split>*>*{width:100%;min-width:0}.zx .zx-split-code>div{margin:0}.zx-split-code pre{margin:0}.zx-split-lead .zx-split-code .code-block-copy-button button{width:auto;height:26px;gap:6px;padding:0 10px;border:1px solid rgba(255, 210, 2, 0.3);border-radius:999px;background:rgba(255, 210, 2, 0.11);color:var(--accent);transition:background 0.15s ease, border-color 0.15s ease}.zx-split-lead .zx-split-code .code-block-copy-button button:hover{border-color:rgba(255, 210, 2, 0.5);background:rgba(255, 210, 2, 0.2)}.zx-split-lead .zx-split-code .code-block-copy-button button svg{color:inherit}.zx-split-lead .zx-split-code .code-block-copy-button button::after{content:\"Copy\";font-size:0.75rem;font-weight:500;line-height:1;color:var(--accent)}.zx-split-lead .zx-split-code .code-block-copy-button:has([role=\"status\"]:not(:empty)) button::after{content:\"Copied\"}.zx-viz{display:flex;flex-direction:column;gap:12px}.zx-viz-row{display:grid;grid-template-columns:repeat(2, minmax(0, 1fr));gap:12px}.zx-mini{display:flex;flex-direction:column;gap:4px;padding:16px;border:1px solid var(--line);border-radius:12px;background:rgba(255, 255, 255, 0.025)}.zx-mini-ico{display:inline-flex;align-items:center;justify-content:center;width:30px;height:30px;margin-bottom:6px;border-radius:8px;background:rgba(255, 210, 2, 0.1);color:var(--accent)}.zx-mini-ico svg{width:15px;height:15px}.zx-mini-t{font-size:0.9375rem;color:var(--fg)}.zx-mini-s{font-size:0.8125rem;color:var(--muted)}.zx-db{border:1px solid var(--line-2);border-radius:12px;background:var(--sunken);overflow:hidden}.zx-db-head{display:flex;align-items:center;justify-content:space-between;gap:12px;flex-wrap:wrap;padding:13px 16px}.zx-db-title{display:inline-flex;align-items:center;gap:9px;font-size:0.9375rem;color:var(--fg)}.zx-db-title svg{width:16px;height:16px;color:var(--accent)}.zx-db-pill{padding:4px 10px;border-radius:999px;background:rgba(255, 210, 2, 0.12);color:var(--accent);font-size:0.75rem;line-height:1.3}.zx-db-tabs{display:flex;gap:6px;padding:0 16px 12px}.zx-db-tab{padding:4px 10px;border-radius:7px;background:rgba(255, 255, 255, 0.04);font-family:var(--zb-mono);font-size:0.75rem;color:var(--muted)}.zx-db-tab-on{background:rgba(255, 210, 2, 0.14);color:var(--accent)}.zx-db-table{border-top:1px solid var(--line)}.zx-db-row{display:grid;grid-template-columns:minmax(0, 1.7fr) minmax(0, 1fr) minmax(0, 0.5fr);align-items:center;gap:12px;padding:11px 16px;border-bottom:1px solid var(--line);font-size:0.875rem;color:var(--fg)}.zx-db-row:last-child{border-bottom:0}.zx-db-hd{background:rgba(255, 255, 255, 0.02);font-size:0.75rem;color:var(--dim)}.zx-db-c1{overflow:hidden;text-overflow:ellipsis;white-space:nowrap}.zx-badge{display:inline-flex;align-items:center;gap:6px;padding:3px 9px;border-radius:999px;font-size:0.75rem;line-height:1.35}.zx-badge::before{content:\"\";width:6px;height:6px;border-radius:50%;background:currentColor}.zx-badge-open{background:rgba(224, 112, 92, 0.14);color:#e8907d}.zx-badge-prog{background:rgba(255, 210, 2, 0.14);color:var(--accent)}.zx-badge-done{background:rgba(111, 184, 119, 0.14);color:#85c98c}.zx-av{display:inline-flex;align-items:center;justify-content:center;width:26px;height:26px;border-radius:50%;font-size:0.6875rem;background:rgba(255, 255, 255, 0.07);color:var(--fg-2)}.zx-av-amber{background:rgba(255, 210, 2, 0.18);color:var(--accent)}.zx-role-row{grid-template-columns:minmax(0, 1.2fr) minmax(0, 1.1fr) minmax(0, 1fr)}.zx-role-name{display:inline-flex;align-items:center;gap:9px}.zx-role-name svg{width:15px;height:15px;flex:none;color:var(--muted)}.zx-role-ops{font-family:var(--zb-mono);font-size:0.78rem;color:var(--muted)}.zx-role-scope{font-size:0.8125rem;color:var(--muted)}.zx-role-off{opacity:0.55}.zx-ep{display:grid;grid-template-columns:repeat(2, minmax(0, 1fr));gap:24px}.zx-ep-col{display:flex;flex-direction:column;min-width:0}.zx-ep-head{margin:0 0 4px;font-size:0.6875rem;letter-spacing:0.08em;text-transform:uppercase;color:var(--muted)}.zx-ep-row{display:flex;flex-direction:column;gap:2px;padding:9px 0;text-decoration:none}.zx-ep-row+.zx-ep-row{border-top:1px solid var(--line)}.zx-ep-res{font-family:var(--zb-mono);font-size:0.75rem;color:var(--accent)}.zx-ep-ops{min-width:0;font-size:0.8125rem;color:var(--fg-2)}.zx-ep-row:hover .zx-ep-ops{color:var(--fg)}.zx-foot{position:relative;border-top:1px solid var(--rule);background:var(--bg)}.zx-foot-grid{display:grid;grid-template-columns:1.6fr 1fr 1fr 1fr;gap:40px;max-width:var(--zb-container);margin:0 auto;padding:56px var(--zb-gutter)}.zx-foot-brand img{width:30px;height:30px;display:block}.zx-foot-word{margin-top:14px;font-family:var(--zb-serif);font-weight:500;font-size:1.0625rem;color:var(--fg)}.zx-foot-socials{display:flex;gap:16px;margin-top:12px}.zx-foot-socials a{font-size:0.875rem;color:var(--muted);text-decoration:none}.zx-foot-socials a:hover{color:var(--fg)}.zx-foot-col{display:flex;flex-direction:column;gap:11px}.zx-foot-h{margin-bottom:3px;font-size:0.8125rem;color:var(--dim)}.zx-foot-col a{font-size:0.9375rem;color:var(--muted);text-decoration:none}.zx-foot-col a:hover{color:var(--fg)}.zx-foot-legal{display:flex;justify-content:space-between;align-items:center;gap:16px;max-width:var(--zb-container);margin:0 auto;padding:20px var(--zb-gutter) 40px;border-top:1px solid var(--rule);font-size:0.8125rem;color:var(--dim)}.zx-foot-legal a{margin-left:18px;color:var(--dim);text-decoration:none}.zx-foot-legal a:hover{color:var(--fg)}#zx-ag-claude:checked~.zx-canvas .zx-p-claude,#zx-ag-gpt:checked~.zx-canvas .zx-p-gpt,#zx-ag-cc:checked~.zx-canvas .zx-p-cc,#zx-ag-cursor:checked~.zx-canvas .zx-p-cursor,#zx-ag-vsc:checked~.zx-canvas .zx-p-vsc,#zx-ag-other:checked~.zx-canvas .zx-p-other,#zx-fw-apps:checked~.zx-canvas .zx-p-apps,#zx-fw-data:checked~.zx-canvas .zx-p-data,#zx-fw-roles:checked~.zx-canvas .zx-p-roles{visibility:visible;opacity:1}#zx-ag-claude:checked~.zx-canvas label[for=\"zx-ag-claude\"],#zx-ag-gpt:checked~.zx-canvas label[for=\"zx-ag-gpt\"],#zx-ag-cc:checked~.zx-canvas label[for=\"zx-ag-cc\"],#zx-ag-cursor:checked~.zx-canvas label[for=\"zx-ag-cursor\"],#zx-ag-vsc:checked~.zx-canvas label[for=\"zx-ag-vsc\"],#zx-ag-other:checked~.zx-canvas label[for=\"zx-ag-other\"]{color:var(--fg);background:var(--surface-hi);border-color:rgba(255, 210, 2, 0.42)}#zx-fw-apps:checked~.zx-canvas label[for=\"zx-fw-apps\"],#zx-fw-data:checked~.zx-canvas label[for=\"zx-fw-data\"],#zx-fw-roles:checked~.zx-canvas label[for=\"zx-fw-roles\"]{color:var(--fg);background:var(--surface-hi);box-shadow:0 0 0 1px rgba(255, 210, 2, 0.45)}.zx-radio:focus-visible~.zx-canvas label[for=\"zx-ag-claude\"],.zx-radio:focus-visible~.zx-canvas label[for=\"zx-ag-gpt\"],.zx-radio:focus-visible~.zx-canvas label[for=\"zx-ag-cc\"],.zx-radio:focus-visible~.zx-canvas label[for=\"zx-ag-cursor\"],.zx-radio:focus-visible~.zx-canvas label[for=\"zx-ag-vsc\"],.zx-radio:focus-visible~.zx-canvas label[for=\"zx-ag-other\"]{outline:2px solid var(--accent);outline-offset:2px}@media (prefers-reduced-motion: reduce){.zx-panel{transition:none}}@media (max-width: 900px){.zx-head{flex-direction:column;align-items:flex-start;gap:28px;padding-bottom:32px}.zx-head-aside{padding-bottom:0}.zx-split{grid-template-columns:minmax(0, 1fr)}.zx-split-code{border-right:0;border-bottom:1px solid var(--line)}.zx .code-block:has([data-floating-buttons]) [data-fade-overlay]{width:var(--fade-width)}.zx-cn-body{grid-template-columns:minmax(0, 1fr)}.zx-pick{flex-direction:row;flex-wrap:wrap;border-right:0;border-bottom:1px solid var(--line)}.zx-pick-row{flex:1 1 auto}.zx-pick-n{flex:none}.zx-foot-grid{grid-template-columns:1fr 1fr;gap:32px}}@media (max-width: 620px){:root{--zb-gutter: 20px}.zx-cn-head{flex-direction:column;align-items:flex-start;gap:10px}.zx-cn-url{max-width:100%}.zx-pick{display:grid;grid-template-columns:repeat(2, minmax(0, 1fr));gap:6px;padding:8px}.zx-pick-row{flex:none;gap:9px;padding:9px 10px}.zx-pick-n{flex:1;font-size:0.875rem}.zx-pane{padding:22px 18px}.zx-next{flex-direction:column;gap:6px}.zx-next{padding:16px 18px}.zx-alt{justify-content:flex-start;padding:24px 4px 14px}.zx-foot-grid{grid-template-columns:1fr}.zx-foot-legal{flex-direction:column;align-items:flex-start;gap:10px}.zx-foot-legal a{margin:0 18px 0 0}.zx-db-row{grid-template-columns:minmax(0, 1.5fr) minmax(0, 1fr) auto}}"}],"page":{"pagePath":"api/records/list-records","slug":"/api/records/list-records","pageMetadata":{"title":"List Records","description":"Retrieves records from a table with filtering, sorting, and pagination.","openapi":"api/openapi.json POST /bases/{databaseId}/tables/{tableId}/records/list","href":"/api/records/list-records"},"description":{"compiledSource":"\"use strict\";\nconst {jsx: _jsx} = arguments[0];\nconst {useMDXComponents: _provideComponents} = arguments[0];\nfunction _createMdxContent(props) {\n const _components = {\n p: \"p\",\n ..._provideComponents(),\n ...props.components\n };\n return _jsx(_components.p, {\n children: \"Retrieves records from a table with filtering, sorting, and pagination.\"\n });\n}\nfunction MDXContent(props = {}) {\n const {wrapper: MDXLayout} = {\n ..._provideComponents(),\n ...props.components\n };\n return MDXLayout ? _jsx(MDXLayout, {\n ...props,\n children: _jsx(_createMdxContent, {\n ...props\n })\n }) : _createMdxContent(props);\n}\nreturn {\n default: MDXContent\n};\n","frontmatter":{},"scope":{}},"pageType":"default","mdx":{"mdxSource":{"compiledSource":"\"use strict\";const{Fragment:_Fragment,jsx:_jsx,jsxs:_jsxs}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){const _components={code:`code`,p:`p`,pre:`pre`,span:`span`,strong:`strong`,tbody:`tbody`,td:`td`,th:`th`,thead:`thead`,tr:`tr`,..._provideComponents(),...props.components},{Accordion,AccordionGroup,CodeBlock,Heading,Note,Table}=_components;if(!Accordion)_missingMdxReference(`Accordion`,true);if(!AccordionGroup)_missingMdxReference(`AccordionGroup`,true);if(!CodeBlock)_missingMdxReference(`CodeBlock`,true);if(!Heading)_missingMdxReference(`Heading`,true);if(!Note)_missingMdxReference(`Note`,true);if(!Table)_missingMdxReference(`Table`,true);return _jsxs(_Fragment,{children:[_jsx(Heading,{level:`2`,id:`pagination`,children:`Pagination`}),`\n`,_jsxs(Table,{children:[_jsx(_components.thead,{children:_jsxs(_components.tr,{children:[_jsx(_components.th,{children:`Parameter`}),_jsx(_components.th,{children:`Type`}),_jsx(_components.th,{children:`Default`}),_jsx(_components.th,{children:`Max`})]})}),_jsxs(_components.tbody,{children:[_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`limit`})}),_jsx(_components.td,{children:`number`}),_jsx(_components.td,{\"data-numeric\":`true`,children:`500`}),_jsx(_components.td,{\"data-numeric\":`true`,children:`2000`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`offset`})}),_jsx(_components.td,{children:`number`}),_jsx(_components.td,{\"data-numeric\":`true`,children:`0`}),_jsx(_components.td,{\"data-numeric\":`true`,children:`-`})]})]})]}),`\n`,_jsxs(_components.p,{children:[`Use `,_jsx(_components.code,{children:`hasMore`}),` to determine if additional pages exist. Increment `,_jsx(_components.code,{children:`offset`}),` by `,_jsx(_components.code,{children:`limit`}),` for each subsequent request.`]}),`\n`,_jsxs(_components.p,{children:[`To return only some fields, pass `,_jsx(_components.code,{children:`fields`}),` with a list of field names or IDs (for example `,_jsx(_components.code,{children:`\"fields\": [\"Name\", \"Status\"]`}),`).`]}),`\n`,_jsx(Heading,{level:`2`,id:`sorting`,children:`Sorting`}),`\n`,_jsxs(_components.p,{children:[`When no `,_jsx(_components.code,{children:`sort`}),` parameter is provided, records are returned in ascending order by creation time (`,_jsx(_components.code,{children:`createdAt ASC`}),`).`]}),`\n`,_jsx(CodeBlock,{filename:``,numberOfLines:`6`,language:`json`,children:_jsx(_components.pre,{className:`shiki shiki-themes github-light-default dark-plus`,style:{backgroundColor:`#ffffff`,\"--shiki-dark-bg\":`#0B0C0E`,color:`#1f2328`,\"--shiki-dark\":`#D4D4D4`},language:`json`,children:_jsxs(_components.code,{language:`json`,numberOfLines:`6`,children:[_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`{`})}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"sort\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: [`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` { `}),_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:`\"field\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"name\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`, `}),_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:`\"direction\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"asc\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` },`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` { `}),_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:`\"field\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"createdAt\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`, `}),_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:`\"direction\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"desc\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` }`})]}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` ]`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`}`})}),`\n`]})})}),`\n`,_jsxs(Table,{children:[_jsx(_components.thead,{children:_jsxs(_components.tr,{children:[_jsx(_components.th,{children:`Property`}),_jsx(_components.th,{children:`Type`}),_jsx(_components.th,{children:`Required`}),_jsx(_components.th,{children:`Description`})]})}),_jsxs(_components.tbody,{children:[_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`field`})}),_jsx(_components.td,{children:`string`}),_jsx(_components.td,{children:`Yes`}),_jsxs(_components.td,{children:[`Field name, field ID, or system field (`,_jsx(_components.code,{children:`id`}),`, `,_jsx(_components.code,{children:`createdAt`}),`, `,_jsx(_components.code,{children:`updatedAt`}),`)`]})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`direction`})}),_jsx(_components.td,{children:`string`}),_jsx(_components.td,{children:`No`}),_jsxs(_components.td,{children:[_jsx(_components.code,{children:`\"asc\"`}),` (default) or `,_jsx(_components.code,{children:`\"desc\"`})]})]})]})]}),`\n`,_jsxs(Note,{children:[_jsx(_components.code,{children:`fieldId`}),` is also accepted for backward compatibility, but `,_jsx(_components.code,{children:`field`}),` is preferred. For a single ascending sort you can pass the field name as a string (`,_jsx(_components.code,{children:`\"sort\": \"Name\"`}),`).`]}),`\n`,_jsx(Heading,{level:`2`,id:`filtering`,children:`Filtering`}),`\n`,_jsxs(_components.p,{children:[`Use the `,_jsx(_components.code,{children:`filter`}),` parameter to query records. Each condition takes a `,_jsx(_components.code,{children:`field`}),` (name or ID) and exactly one operator. Filters support nested AND/OR logic, up to 20 levels deep. A condition on a field that doesn’t exist is ignored rather than rejected, so check field names if a filter returns every record.`]}),`\n`,_jsx(CodeBlock,{filename:``,numberOfLines:`6`,language:`json`,children:_jsx(_components.pre,{className:`shiki shiki-themes github-light-default dark-plus`,style:{backgroundColor:`#ffffff`,\"--shiki-dark-bg\":`#0B0C0E`,color:`#1f2328`,\"--shiki-dark\":`#D4D4D4`},language:`json`,children:_jsxs(_components.code,{language:`json`,numberOfLines:`6`,children:[_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`{`})}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"filter\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: {`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"field\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"Status\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"equals\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"Active\"`})]}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` }`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`}`})}),`\n`]})})}),`\n`,_jsxs(AccordionGroup,{children:[_jsxs(Accordion,{title:`Combining Filters with AND/OR`,id:`combining-filters-with-and-or`,children:[_jsxs(_components.p,{children:[`Use `,_jsx(_components.code,{children:`and`}),` or `,_jsx(_components.code,{children:`or`}),` to combine multiple conditions:`]}),_jsx(CodeBlock,{filename:``,numberOfLines:`8`,language:`json`,children:_jsx(_components.pre,{className:`shiki shiki-themes github-light-default dark-plus`,style:{backgroundColor:`#ffffff`,\"--shiki-dark-bg\":`#0B0C0E`,color:`#1f2328`,\"--shiki-dark\":`#D4D4D4`},language:`json`,children:_jsxs(_components.code,{language:`json`,numberOfLines:`8`,children:[_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`{`})}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"filter\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: {`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"and\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: [`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` { `}),_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:`\"field\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"Status\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`, `}),_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:`\"equals\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"Active\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` },`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` { `}),_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:`\"field\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"Amount\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`, `}),_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:`\"greater_than\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#B5CEA8`},children:`100`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` }`})]}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` ]`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` }`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`}`})}),`\n`]})})}),_jsx(CodeBlock,{filename:``,numberOfLines:`8`,language:`json`,children:_jsx(_components.pre,{className:`shiki shiki-themes github-light-default dark-plus`,style:{backgroundColor:`#ffffff`,\"--shiki-dark-bg\":`#0B0C0E`,color:`#1f2328`,\"--shiki-dark\":`#D4D4D4`},language:`json`,children:_jsxs(_components.code,{language:`json`,numberOfLines:`8`,children:[_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`{`})}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"filter\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: {`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"or\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: [`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` { `}),_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:`\"field\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"Status\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`, `}),_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:`\"equals\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"Urgent\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` },`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` { `}),_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:`\"field\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"Priority\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`, `}),_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:`\"equals\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"High\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` }`})]}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` ]`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` }`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`}`})}),`\n`]})})}),_jsx(_components.p,{children:`Filters can be nested for complex logic:`}),_jsx(CodeBlock,{filename:``,numberOfLines:`13`,language:`json`,children:_jsx(_components.pre,{className:`shiki shiki-themes github-light-default dark-plus`,style:{backgroundColor:`#ffffff`,\"--shiki-dark-bg\":`#0B0C0E`,color:`#1f2328`,\"--shiki-dark\":`#D4D4D4`},language:`json`,children:_jsxs(_components.code,{language:`json`,numberOfLines:`13`,children:[_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`{`})}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"filter\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: {`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"or\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: [`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` { `}),_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:`\"field\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"Status\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`, `}),_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:`\"equals\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"Urgent\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` },`})]}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` {`})}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"and\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: [`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` { `}),_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:`\"field\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"Priority\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`, `}),_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:`\"equals\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"High\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` },`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` { `}),_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:`\"field\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"Completed\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`, `}),_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:`\"equals\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:`false`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` }`})]}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` ]`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` }`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` ]`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` }`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`}`})}),`\n`]})})})]}),_jsxs(Accordion,{title:`Available Operators`,id:`available-operators`,children:[_jsxs(Table,{children:[_jsx(_components.thead,{children:_jsxs(_components.tr,{children:[_jsx(_components.th,{children:`Operator`}),_jsx(_components.th,{children:`Description`}),_jsx(_components.th,{children:`Example Value`})]})}),_jsxs(_components.tbody,{children:[_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`equals`})}),_jsx(_components.td,{children:`Exact match`}),_jsx(_components.td,{children:_jsx(_components.code,{children:`\"Active\"`})})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`does_not_equal`})}),_jsx(_components.td,{children:`Not equal to`}),_jsx(_components.td,{children:_jsx(_components.code,{children:`\"Archived\"`})})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`contains`})}),_jsx(_components.td,{children:`Contains substring (text) or has value (multi-select)`}),_jsx(_components.td,{children:_jsx(_components.code,{children:`\"john\"`})})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`does_not_contain`})}),_jsx(_components.td,{children:`Does not contain`}),_jsx(_components.td,{children:_jsx(_components.code,{children:`\"test\"`})})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`starts_with`})}),_jsx(_components.td,{children:`Starts with string`}),_jsx(_components.td,{children:_jsx(_components.code,{children:`\"Mr.\"`})})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`ends_with`})}),_jsx(_components.td,{children:`Ends with string`}),_jsx(_components.td,{children:_jsx(_components.code,{children:`\"@gmail.com\"`})})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`is_empty`})}),_jsx(_components.td,{children:`Field has no value`}),_jsx(_components.td,{children:_jsx(_components.code,{children:`true`})})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`is_not_empty`})}),_jsx(_components.td,{children:`Field has a value`}),_jsx(_components.td,{children:_jsx(_components.code,{children:`true`})})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`in`})}),_jsx(_components.td,{children:`Value is in array`}),_jsx(_components.td,{children:_jsx(_components.code,{children:`[\"Active\", \"Pending\"]`})})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`not_in`})}),_jsx(_components.td,{children:`Value is not in array`}),_jsx(_components.td,{children:_jsx(_components.code,{children:`[\"Archived\", \"Deleted\"]`})})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`greater_than`})}),_jsx(_components.td,{children:`Greater than (numbers/dates)`}),_jsxs(_components.td,{children:[_jsx(_components.code,{children:`100`}),` or `,_jsx(_components.code,{children:`\"2024-01-01\"`})]})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`greater_than_or_equal_to`})}),_jsx(_components.td,{children:`Greater than or equal`}),_jsx(_components.td,{\"data-numeric\":`true`,children:_jsx(_components.code,{children:`100`})})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`less_than`})}),_jsx(_components.td,{children:`Less than`}),_jsx(_components.td,{\"data-numeric\":`true`,children:_jsx(_components.code,{children:`50`})})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`less_than_or_equal_to`})}),_jsx(_components.td,{children:`Less than or equal`}),_jsx(_components.td,{\"data-numeric\":`true`,children:_jsx(_components.code,{children:`50`})})]})]})]}),_jsxs(_components.p,{children:[`Text operators are case-sensitive. Add `,_jsx(_components.code,{children:`\"mode\": \"insensitive\"`}),` to a condition to ignore case, for example\n`,_jsx(_components.code,{children:`{ \"field\": \"Email\", \"equals\": \"ann@example.com\", \"mode\": \"insensitive\" }`}),`.`]})]}),_jsxs(Accordion,{title:`Operators by Field Type`,id:`operators-by-field-type`,children:[_jsxs(Table,{children:[_jsx(_components.thead,{children:_jsxs(_components.tr,{children:[_jsx(_components.th,{children:`Field Type`}),_jsx(_components.th,{children:`Supported Operators`})]})}),_jsxs(_components.tbody,{children:[_jsxs(_components.tr,{children:[_jsxs(_components.td,{children:[`Text (`,_jsx(_components.code,{children:`single_line_text`}),`, `,_jsx(_components.code,{children:`long_text`}),`, `,_jsx(_components.code,{children:`rich_text`}),`, `,_jsx(_components.code,{children:`email`}),`, `,_jsx(_components.code,{children:`url`}),`, `,_jsx(_components.code,{children:`phone_number`}),`)`]}),_jsxs(_components.td,{children:[_jsx(_components.code,{children:`equals`}),`, `,_jsx(_components.code,{children:`does_not_equal`}),`, `,_jsx(_components.code,{children:`contains`}),`, `,_jsx(_components.code,{children:`does_not_contain`}),`, `,_jsx(_components.code,{children:`starts_with`}),`, `,_jsx(_components.code,{children:`ends_with`}),`, `,_jsx(_components.code,{children:`is_empty`}),`, `,_jsx(_components.code,{children:`is_not_empty`}),`, `,_jsx(_components.code,{children:`in`}),`, `,_jsx(_components.code,{children:`not_in`})]})]}),_jsxs(_components.tr,{children:[_jsxs(_components.td,{children:[`Number (`,_jsx(_components.code,{children:`number`}),`, `,_jsx(_components.code,{children:`currency`}),`, `,_jsx(_components.code,{children:`percent`}),`, `,_jsx(_components.code,{children:`rating`}),`, `,_jsx(_components.code,{children:`duration`}),`, `,_jsx(_components.code,{children:`autonumber`}),`)`]}),_jsxs(_components.td,{children:[_jsx(_components.code,{children:`equals`}),`, `,_jsx(_components.code,{children:`does_not_equal`}),`, `,_jsx(_components.code,{children:`greater_than`}),`, `,_jsx(_components.code,{children:`greater_than_or_equal_to`}),`, `,_jsx(_components.code,{children:`less_than`}),`, `,_jsx(_components.code,{children:`less_than_or_equal_to`}),`, `,_jsx(_components.code,{children:`is_empty`}),`, `,_jsx(_components.code,{children:`is_not_empty`}),`, `,_jsx(_components.code,{children:`in`}),`, `,_jsx(_components.code,{children:`not_in`})]})]}),_jsxs(_components.tr,{children:[_jsxs(_components.td,{children:[`Date (`,_jsx(_components.code,{children:`date`}),`, `,_jsx(_components.code,{children:`datetime`}),`, `,_jsx(_components.code,{children:`created_at`}),`, `,_jsx(_components.code,{children:`updated_at`}),`)`]}),_jsxs(_components.td,{children:[_jsx(_components.code,{children:`equals`}),`, `,_jsx(_components.code,{children:`does_not_equal`}),`, `,_jsx(_components.code,{children:`greater_than`}),`, `,_jsx(_components.code,{children:`greater_than_or_equal_to`}),`, `,_jsx(_components.code,{children:`less_than`}),`, `,_jsx(_components.code,{children:`less_than_or_equal_to`}),`, `,_jsx(_components.code,{children:`is_empty`}),`, `,_jsx(_components.code,{children:`is_not_empty`})]})]}),_jsxs(_components.tr,{children:[_jsxs(_components.td,{children:[`Selection (`,_jsx(_components.code,{children:`single_select`}),`, `,_jsx(_components.code,{children:`multiple_select`}),`)`]}),_jsxs(_components.td,{children:[_jsx(_components.code,{children:`equals`}),`, `,_jsx(_components.code,{children:`does_not_equal`}),`, `,_jsx(_components.code,{children:`contains`}),`, `,_jsx(_components.code,{children:`does_not_contain`}),`, `,_jsx(_components.code,{children:`is_empty`}),`, `,_jsx(_components.code,{children:`is_not_empty`}),`, `,_jsx(_components.code,{children:`in`}),`, `,_jsx(_components.code,{children:`not_in`})]})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:`Checkbox`}),_jsxs(_components.td,{children:[_jsx(_components.code,{children:`equals`}),`, `,_jsx(_components.code,{children:`does_not_equal`})]})]}),_jsxs(_components.tr,{children:[_jsxs(_components.td,{children:[`Attachments (`,_jsx(_components.code,{children:`attachments`}),`)`]}),_jsxs(_components.td,{children:[_jsx(_components.code,{children:`is_empty`}),`, `,_jsx(_components.code,{children:`is_not_empty`})]})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:`Linked Record`}),_jsxs(_components.td,{children:[_jsx(_components.code,{children:`contains`}),`, `,_jsx(_components.code,{children:`does_not_contain`}),`, `,_jsx(_components.code,{children:`is_empty`}),`, `,_jsx(_components.code,{children:`is_not_empty`}),`, `,_jsx(_components.code,{children:`in`}),`, `,_jsx(_components.code,{children:`not_in`})]})]}),_jsxs(_components.tr,{children:[_jsxs(_components.td,{children:[`User (`,_jsx(_components.code,{children:`user`}),`, `,_jsx(_components.code,{children:`created_by`}),`, `,_jsx(_components.code,{children:`updated_by`}),`)`]}),_jsxs(_components.td,{children:[_jsx(_components.code,{children:`in`}),`, `,_jsx(_components.code,{children:`not_in`}),`, `,_jsx(_components.code,{children:`is_empty`}),`, `,_jsx(_components.code,{children:`is_not_empty`})]})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:`Formula`}),_jsxs(_components.td,{children:[`The operators for its `,_jsx(_components.code,{children:`resultType`}),` (`,_jsx(_components.code,{children:`array`}),` uses the selection operators)`]})]})]})]}),_jsxs(_components.p,{children:[_jsx(_components.code,{children:`autonumber`}),` doesn’t support `,_jsx(_components.code,{children:`is_empty`}),` or `,_jsx(_components.code,{children:`is_not_empty`}),`. `,_jsx(_components.code,{children:`rollup`}),` and `,_jsx(_components.code,{children:`source`}),` fields can’t be filtered, and a `,_jsx(_components.code,{children:`lookup`}),` can only be filtered (as a checkbox) when it looks up a checkbox.`]})]}),_jsxs(Accordion,{title:`Filter Examples`,id:`filter-examples`,children:[_jsx(_components.p,{children:_jsx(_components.strong,{children:`Filter by single select:`})}),_jsx(CodeBlock,{filename:``,numberOfLines:`1`,language:`json`,children:_jsx(_components.pre,{className:`shiki shiki-themes github-light-default dark-plus`,style:{backgroundColor:`#ffffff`,\"--shiki-dark-bg\":`#0B0C0E`,color:`#1f2328`,\"--shiki-dark\":`#D4D4D4`},language:`json`,children:_jsxs(_components.code,{language:`json`,numberOfLines:`1`,children:[_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`{ `}),_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:`\"filter\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: { `}),_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:`\"field\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"Status\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`, `}),_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:`\"equals\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"Active\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` } }`})]}),`\n`]})})}),_jsx(_components.p,{children:_jsx(_components.strong,{children:`Filter by number range:`})}),_jsx(CodeBlock,{filename:``,numberOfLines:`8`,language:`json`,children:_jsx(_components.pre,{className:`shiki shiki-themes github-light-default dark-plus`,style:{backgroundColor:`#ffffff`,\"--shiki-dark-bg\":`#0B0C0E`,color:`#1f2328`,\"--shiki-dark\":`#D4D4D4`},language:`json`,children:_jsxs(_components.code,{language:`json`,numberOfLines:`8`,children:[_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`{`})}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"filter\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: {`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"and\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: [`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` { `}),_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:`\"field\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"Price\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`, `}),_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:`\"greater_than_or_equal_to\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#B5CEA8`},children:`10`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` },`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` { `}),_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:`\"field\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"Price\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`, `}),_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:`\"less_than\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#B5CEA8`},children:`100`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` }`})]}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` ]`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` }`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`}`})}),`\n`]})})}),_jsx(_components.p,{children:_jsx(_components.strong,{children:`Filter by date:`})}),_jsx(CodeBlock,{filename:``,numberOfLines:`1`,language:`json`,children:_jsx(_components.pre,{className:`shiki shiki-themes github-light-default dark-plus`,style:{backgroundColor:`#ffffff`,\"--shiki-dark-bg\":`#0B0C0E`,color:`#1f2328`,\"--shiki-dark\":`#D4D4D4`},language:`json`,children:_jsxs(_components.code,{language:`json`,numberOfLines:`1`,children:[_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`{ `}),_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:`\"filter\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: { `}),_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:`\"field\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"CreatedAt\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`, `}),_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:`\"greater_than\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"2024-01-01\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` } }`})]}),`\n`]})})}),_jsx(_components.p,{children:_jsx(_components.strong,{children:`Filter by multiple values:`})}),_jsx(CodeBlock,{filename:``,numberOfLines:`1`,language:`json`,children:_jsx(_components.pre,{className:`shiki shiki-themes github-light-default dark-plus`,style:{backgroundColor:`#ffffff`,\"--shiki-dark-bg\":`#0B0C0E`,color:`#1f2328`,\"--shiki-dark\":`#D4D4D4`},language:`json`,children:_jsxs(_components.code,{language:`json`,numberOfLines:`1`,children:[_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`{ `}),_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:`\"filter\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: { `}),_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:`\"field\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"Status\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`, `}),_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:`\"in\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: [`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"Active\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`, `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"Pending\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`, `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"Review\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`] } }`})]}),`\n`]})})}),_jsx(_components.p,{children:_jsx(_components.strong,{children:`Filter for empty/non-empty:`})}),_jsx(CodeBlock,{filename:``,numberOfLines:`1`,language:`json`,children:_jsx(_components.pre,{className:`shiki shiki-themes github-light-default dark-plus`,style:{backgroundColor:`#ffffff`,\"--shiki-dark-bg\":`#0B0C0E`,color:`#1f2328`,\"--shiki-dark\":`#D4D4D4`},language:`json`,children:_jsxs(_components.code,{language:`json`,numberOfLines:`1`,children:[_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`{ `}),_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:`\"filter\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: { `}),_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:`\"field\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"AssignedTo\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`, `}),_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:`\"is_not_empty\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:`true`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` } }`})]}),`\n`]})})})]})]})]})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{default:MDXContent};function _missingMdxReference(id,component){throw new Error(`Expected `+(component?`component`:`object`)+\" `\"+id+\"` to be defined: you likely forgot to import, pass, or provide it.\")}","frontmatter":{},"scope":{"codeStyling":"system","config":{},"pageMetadata":{"title":"List Records","description":"Retrieves records from a table with filtering, sorting, and pagination.","openapi":"api/openapi.json POST /bases/{databaseId}/tables/{tableId}/records/list","href":"/api/records/list-records"}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[{"title":"Pagination","slug":"pagination","depth":2,"children":[]},{"title":"Sorting","slug":"sorting","depth":2,"children":[]},{"title":"Filtering","slug":"filtering","depth":2,"children":[]}],"codeExamples":{}},"jsLinks":[],"openApiReferenceData":{"operation":{"summary":"List records","description":"Retrieves records from a table with filtering, sorting, and pagination.","operationId":"listRecords","tags":["Records"],"parameters":["8ddbaf5c-34c7-4dba-9408-8d93acfc1665","a3659d97-0b30-4e9f-af47-f258124bb367"],"requestBody":"d66116ac-8150-470f-aa9f-3a6e164692a6","responses":{"200":"8e18d45d-4fc1-4dac-8c8f-0821c37bbedf","400":"9f7b2cbb-4daf-4c59-b935-9f36b45af4cf","401":"825feaf8-1118-43e5-870d-253f7a035bc5","404":"03beaa88-4799-49ff-a947-c2ff5764ab7d"},"method":"post","type":"path","servers":["b8e09bd3-e3a3-4a6e-9c4d-9f84b368768f"],"security":["b5a3a6fb-a3b1-486a-8ae2-412451bb9faa"],"path":"/bases/{databaseId}/tables/{tableId}/records/list","baseUrlOptions":["https://tables.zite.com/api/v1"],"title":"List records","codeSamples":[],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{"8ddbaf5c-34c7-4dba-9408-8d93acfc1665":{"name":"databaseId","in":"path","required":true,"schema":{"type":"string","isRequired":true,"description":"The unique identifier of the database","uniqueKey":"","typeLabel":"string"},"description":"The unique identifier of the database"},"a3659d97-0b30-4e9f-af47-f258124bb367":{"name":"tableId","in":"path","required":true,"schema":{"type":"string","isRequired":true,"description":"The unique identifier of the table.","uniqueKey":"","typeLabel":"string"},"description":"The unique identifier of the table."}},"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","properties":{"limit":{"type":"integer","minimum":1,"maximum":2000,"default":500,"description":"Number of records to return (default: 500, max: 2000)","uniqueKey":"limit","typeLabel":"integer"},"offset":{"type":"integer","minimum":0,"default":0,"description":"Integer-based offset - Number of records to skip for pagination","uniqueKey":"offset","typeLabel":"integer"},"sort":{"oneOf":[{"type":"string","description":"A field name to sort ascending by, or an array of sort objects. When not provided, records are returned in ascending order by creation time (createdAt ASC). All queries include an internal tie-breaker to ensure deterministic ordering across paginated requests.","uniqueKey":"sort.oneOf.0","typeLabel":"string"},{"type":"array","items":{"oneOf":[{"type":"object","required":["field"],"properties":{"field":{"type":"string","description":"Field name, field ID, or system field name (id, createdAt, updatedAt)","isRequired":true,"uniqueKey":"sort.oneOf.1.items.[INDEX].oneOf.0.field","typeLabel":"string"},"fieldId":{"type":"string","description":"Deprecated. Use 'field' instead. Kept for backward compatibility.","deprecated":true,"uniqueKey":"sort.oneOf.1.items.[INDEX].oneOf.0.fieldId","typeLabel":"string"},"direction":{"type":"string","enum":["asc","desc"],"default":"asc","description":"Sort direction (default: asc)","uniqueKey":"sort.oneOf.1.items.[INDEX].oneOf.0.direction","typeLabel":"enum\u003cstring>"}},"uniqueKey":"sort.oneOf.1.items.[INDEX].oneOf.0","typeLabel":"object"},{"type":"object","required":["fieldId"],"properties":{"fieldId":{"type":"string","description":"Deprecated. Use 'field' instead. Kept for backward compatibility.","deprecated":true,"isRequired":true,"uniqueKey":"sort.oneOf.1.items.[INDEX].oneOf.1.fieldId","typeLabel":"string"},"field":{"type":"string","description":"Field name, field ID, or system field name (id, createdAt, updatedAt)","uniqueKey":"sort.oneOf.1.items.[INDEX].oneOf.1.field","typeLabel":"string"},"direction":{"type":"string","enum":["asc","desc"],"default":"asc","description":"Sort direction (default: asc)","uniqueKey":"sort.oneOf.1.items.[INDEX].oneOf.1.direction","typeLabel":"enum\u003cstring>"}},"uniqueKey":"sort.oneOf.1.items.[INDEX].oneOf.1","typeLabel":"object"}],"uniqueKey":"sort.oneOf.1.items.[INDEX]","typeLabel":"object"},"description":"A field name to sort ascending by, or an array of sort objects. When not provided, records are returned in ascending order by creation time (createdAt ASC). All queries include an internal tie-breaker to ensure deterministic ordering across paginated requests.","uniqueKey":"sort.oneOf.1","typeLabel":"object[]"}],"uniqueKey":"sort","typeLabel":"string | object[]"},"filter":{"type":"object","description":"Filter condition to query records. Supports nested AND/OR logic. Each condition requires `field` (field ID or name) and exactly one operator. See [Filtering](/api/records/list-records#filtering) for details.","example":{"field":"Status","equals":"Active"},"properties":{"field":{"type":"string","description":"Field ID or field name to filter on","uniqueKey":"filter.field","typeLabel":"string"},"and":{"type":"array","items":{"$circularRef":"d1b697f9-d36a-403f-ad2a-e2b1458a3fe0"},"description":"Array of conditions that must ALL match (logical AND)","uniqueKey":"filter.and","typeLabel":"array"},"or":{"type":"array","items":{"$circularRef":"d1b697f9-d36a-403f-ad2a-e2b1458a3fe0"},"description":"Array of conditions where ANY must match (logical OR)","uniqueKey":"filter.or","typeLabel":"array"},"equals":{"oneOf":[{"type":"string","description":"Exact match. Supported by: text, number, date, selection, checkbox fields.","uniqueKey":"filter.equals.oneOf.0","typeLabel":"string"},{"type":"number","description":"Exact match. Supported by: text, number, date, selection, checkbox fields.","uniqueKey":"filter.equals.oneOf.1","typeLabel":"number"},{"type":"boolean","description":"Exact match. Supported by: text, number, date, selection, checkbox fields.","uniqueKey":"filter.equals.oneOf.2","typeLabel":"boolean"}],"uniqueKey":"filter.equals","typeLabel":"string | number | boolean"},"does_not_equal":{"oneOf":[{"type":"string","description":"Not equal to value. Supported by: text, number, date, selection, checkbox fields.","uniqueKey":"filter.does_not_equal.oneOf.0","typeLabel":"string"},{"type":"number","description":"Not equal to value. Supported by: text, number, date, selection, checkbox fields.","uniqueKey":"filter.does_not_equal.oneOf.1","typeLabel":"number"},{"type":"boolean","description":"Not equal to value. Supported by: text, number, date, selection, checkbox fields.","uniqueKey":"filter.does_not_equal.oneOf.2","typeLabel":"boolean"}],"uniqueKey":"filter.does_not_equal","typeLabel":"string | number | boolean"},"contains":{"type":"string","description":"Contains substring (text) or has value (multi-select, linked record). Supported by: text, selection, linked record fields.","uniqueKey":"filter.contains","typeLabel":"string"},"does_not_contain":{"type":"string","description":"Does not contain substring or value. Supported by: text, selection, linked record fields.","uniqueKey":"filter.does_not_contain","typeLabel":"string"},"starts_with":{"type":"string","description":"Starts with string. Supported by: text fields.","uniqueKey":"filter.starts_with","typeLabel":"string"},"ends_with":{"type":"string","description":"Ends with string. Supported by: text fields.","uniqueKey":"filter.ends_with","typeLabel":"string"},"is_empty":{"type":"boolean","description":"Field has no value (pass true). Supported by most field types.","uniqueKey":"filter.is_empty","typeLabel":"boolean"},"is_not_empty":{"type":"boolean","description":"Field has a value (pass true). Supported by most field types.","uniqueKey":"filter.is_not_empty","typeLabel":"boolean"},"in":{"type":"array","items":{"oneOf":[{"type":"string","uniqueKey":"filter.in.items.[INDEX].oneOf.0","typeLabel":"string"},{"type":"number","uniqueKey":"filter.in.items.[INDEX].oneOf.1","typeLabel":"number"}],"uniqueKey":"filter.in.items.[INDEX]","typeLabel":"string | number"},"description":"Value is in array. Supported by: text, number, selection, linked record fields.","uniqueKey":"filter.in","typeLabel":"(string | number)[]"},"not_in":{"type":"array","items":{"oneOf":[{"type":"string","uniqueKey":"filter.not_in.items.[INDEX].oneOf.0","typeLabel":"string"},{"type":"number","uniqueKey":"filter.not_in.items.[INDEX].oneOf.1","typeLabel":"number"}],"uniqueKey":"filter.not_in.items.[INDEX]","typeLabel":"string | number"},"description":"Value is not in array. Supported by: text, number, selection, linked record fields.","uniqueKey":"filter.not_in","typeLabel":"(string | number)[]"},"greater_than":{"oneOf":[{"type":"number","description":"Greater than value. Supported by: number, date fields.","uniqueKey":"filter.greater_than.oneOf.0","typeLabel":"number"},{"type":"string","description":"Greater than value. Supported by: number, date fields.","format":"date","uniqueKey":"filter.greater_than.oneOf.1","typeLabel":"string\u003cdate>"}],"uniqueKey":"filter.greater_than","typeLabel":"number | string\u003cdate>"},"greater_than_or_equal_to":{"oneOf":[{"type":"number","description":"Greater than or equal to value. Supported by: number, date fields.","uniqueKey":"filter.greater_than_or_equal_to.oneOf.0","typeLabel":"number"},{"type":"string","description":"Greater than or equal to value. Supported by: number, date fields.","format":"date","uniqueKey":"filter.greater_than_or_equal_to.oneOf.1","typeLabel":"string\u003cdate>"}],"uniqueKey":"filter.greater_than_or_equal_to","typeLabel":"number | string\u003cdate>"},"less_than":{"oneOf":[{"type":"number","description":"Less than value. Supported by: number, date fields.","uniqueKey":"filter.less_than.oneOf.0","typeLabel":"number"},{"type":"string","description":"Less than value. Supported by: number, date fields.","format":"date","uniqueKey":"filter.less_than.oneOf.1","typeLabel":"string\u003cdate>"}],"uniqueKey":"filter.less_than","typeLabel":"number | string\u003cdate>"},"less_than_or_equal_to":{"oneOf":[{"type":"number","description":"Less than or equal to value. Supported by: number, date fields.","uniqueKey":"filter.less_than_or_equal_to.oneOf.0","typeLabel":"number"},{"type":"string","description":"Less than or equal to value. Supported by: number, date fields.","format":"date","uniqueKey":"filter.less_than_or_equal_to.oneOf.1","typeLabel":"string\u003cdate>"}],"uniqueKey":"filter.less_than_or_equal_to","typeLabel":"number | string\u003cdate>"},"mode":{"type":"string","enum":["default","insensitive"],"default":"default","description":"Case sensitivity for text operators. `default` is case-sensitive; `insensitive` ignores case.","uniqueKey":"filter.mode","typeLabel":"enum\u003cstring>"}},"uniqueKey":"filter","typeLabel":"object"},"fields":{"type":"array","items":{"type":"string","uniqueKey":"fields.items.[INDEX]","typeLabel":"string"},"description":"Optional list of field names or IDs to return. Omit to return every field.","uniqueKey":"fields","typeLabel":"string[]"}},"example":{"sort":[{"field":"name","direction":"asc"},{"field":"createdAt","direction":"desc"}],"filter":{"and":[{"field":"Status","equals":"Active"},{"field":"Amount","greater_than":100}]},"limit":100,"offset":0},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"sort":[{"field":"name","direction":"asc"},{"field":"createdAt","direction":"desc"}],"filter":{"and":[{"field":"Status","equals":"Active"},{"field":"Amount","greater_than":100}]},"limit":100,"offset":0}}},"exampleType":"generated"}},"exampleType":"generated"},"responses":{"8e18d45d-4fc1-4dac-8c8f-0821c37bbedf":{"description":"List of records","content":{"application/json":{"schema":{"type":"object","properties":{"records":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"Unique UUID identifier for the record","isRequired":true,"uniqueKey":"records.items.[INDEX].id","typeLabel":"string\u003cuuid>"},"data":{"type":"object","additionalProperties":true,"description":"Record data with field IDs as keys","example":{"fwtJyga6dso":"John Doe","k8mNp2xQ9rL":"john.doe@newcompany.com","vB3zXc7Hf2w":"low"},"isRequired":true,"uniqueKey":"records.items.[INDEX].data","typeLabel":"object"},"fields":{"type":"object","additionalProperties":true,"description":"Record data with field names as keys","example":{"Name":"John Doe","Email":"john.doe@newcompany.com","Priority":"low"},"isRequired":true,"uniqueKey":"records.items.[INDEX].fields","typeLabel":"object"},"createdAt":{"type":"string","format":"date-time","description":"ISO timestamp of when the record was created","isRequired":true,"uniqueKey":"records.items.[INDEX].createdAt","typeLabel":"string\u003cdate-time>"},"updatedAt":{"type":"string","format":"date-time","description":"ISO timestamp of when the record was last updated","isRequired":true,"uniqueKey":"records.items.[INDEX].updatedAt","typeLabel":"string\u003cdate-time>"}},"required":["id","data","fields","createdAt","updatedAt"],"uniqueKey":"records.items.[INDEX]","typeLabel":"object"},"description":"Array of records","isRequired":true,"uniqueKey":"records","typeLabel":"object[]"},"total":{"type":"integer","description":"Total number of records matching the query","isRequired":true,"uniqueKey":"total","typeLabel":"integer"},"hasMore":{"type":"boolean","description":"Whether there are more records available beyond this page","isRequired":true,"uniqueKey":"hasMore","typeLabel":"boolean"}},"required":["records","total","hasMore"],"example":{"records":[{"id":"d4b3c2a3-c46b-46a1-a8ec-81b664bb41cb","data":{"f6JE46z2WoX":"","f5gMv8mk8CX":"","foEBBtqDY1F":false},"fields":{"Name":"","Notes":"","Active":false},"createdAt":"2025-11-13T11:59:45.000Z","updatedAt":"2025-11-13T11:59:45.000Z"}],"total":1250,"hasMore":true},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"records":[{"id":"d4b3c2a3-c46b-46a1-a8ec-81b664bb41cb","data":{"f6JE46z2WoX":"","f5gMv8mk8CX":"","foEBBtqDY1F":false},"fields":{"Name":"","Notes":"","Active":false},"createdAt":"2025-11-13T11:59:45.000Z","updatedAt":"2025-11-13T11:59:45.000Z"}],"total":1250,"hasMore":true}}},"exampleType":"generated"}},"exampleType":"generated"},"9f7b2cbb-4daf-4c59-b935-9f36b45af4cf":{"description":"Invalid request data or validation failure","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","description":"Error code","isRequired":true,"uniqueKey":"error.code","typeLabel":"string"},"message":{"type":"string","description":"Human-readable error message","isRequired":true,"uniqueKey":"error.message","typeLabel":"string"}},"required":["code","message"],"isRequired":true,"uniqueKey":"error","typeLabel":"object"}},"required":["error"],"uniqueKey":"","typeLabel":"object"},"examples":{"invalidRecordId":{"title":"invalidRecordId","value":{"error":{"code":"INVALID_RECORD_ID","message":"Record ID is not in valid UUID format"}}},"validationError":{"title":"validationError","value":{"error":{"code":"BAD_REQUEST","message":"Invalid request data or validation failure"}}}},"exampleType":"examples"}},"exampleType":"examples"},"825feaf8-1118-43e5-870d-253f7a035bc5":{"description":"Invalid or missing API key","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","description":"Error code","isRequired":true,"uniqueKey":"error.code","typeLabel":"string"},"message":{"type":"string","description":"Human-readable error message","isRequired":true,"uniqueKey":"error.message","typeLabel":"string"}},"required":["code","message"],"isRequired":true,"uniqueKey":"error","typeLabel":"object"}},"required":["error"],"uniqueKey":"","typeLabel":"object"},"example":{"error":{"code":"UNAUTHORIZED","message":"Invalid or missing API key"}},"examples":{"Example":{"title":"Example","value":{"error":{"code":"UNAUTHORIZED","message":"Invalid or missing API key"}}}},"exampleType":"examples"}},"exampleType":"examples"},"03beaa88-4799-49ff-a947-c2ff5764ab7d":{"description":"Requested resource does not exist","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","description":"Error code","isRequired":true,"uniqueKey":"error.code","typeLabel":"string"},"message":{"type":"string","description":"Human-readable error message","isRequired":true,"uniqueKey":"error.message","typeLabel":"string"}},"required":["code","message"],"isRequired":true,"uniqueKey":"error","typeLabel":"object"}},"required":["error"],"uniqueKey":"","typeLabel":"object"},"example":{"error":{"code":"NOT_FOUND","message":"Requested resource does not exist"}},"examples":{"Example":{"title":"Example","value":{"error":{"code":"NOT_FOUND","message":"Requested resource does not exist"}}}},"exampleType":"examples"}},"exampleType":"examples"}},"security":{"b5a3a6fb-a3b1-486a-8ae2-412451bb9faa":{"bearerAuth":{"type":"http","scheme":"bearer","description":"Enter your Zite API key. Format: Bearer \u003capi_key>","scopes":[],"schemeName":"bearerAuth"}}},"servers":{"b8e09bd3-e3a3-4a6e-9c4d-9f84b368768f":{"url":"https://tables.zite.com/api/v1","description":"Zite DB API"}},"schemas":{"d1b697f9-d36a-403f-ad2a-e2b1458a3fe0":{"type":"object","description":"A filter condition that can be a single field condition or a logical group (and/or) of conditions. Each field condition requires a field name/ID and exactly one operator.","properties":{"field":{"type":"string","description":"Field ID or field name to filter on"},"and":{"type":"array","items":{"$circularRef":"d1b697f9-d36a-403f-ad2a-e2b1458a3fe0"},"description":"Array of conditions that must ALL match (logical AND)"},"or":{"type":"array","items":{"$circularRef":"d1b697f9-d36a-403f-ad2a-e2b1458a3fe0"},"description":"Array of conditions where ANY must match (logical OR)"},"equals":{"oneOf":[{"type":"string","description":"Exact match. Supported by: text, number, date, selection, checkbox fields."},{"type":"number","description":"Exact match. Supported by: text, number, date, selection, checkbox fields."},{"type":"boolean","description":"Exact match. Supported by: text, number, date, selection, checkbox fields."}]},"does_not_equal":{"oneOf":[{"type":"string","description":"Not equal to value. Supported by: text, number, date, selection, checkbox fields."},{"type":"number","description":"Not equal to value. Supported by: text, number, date, selection, checkbox fields."},{"type":"boolean","description":"Not equal to value. Supported by: text, number, date, selection, checkbox fields."}]},"contains":{"type":"string","description":"Contains substring (text) or has value (multi-select, linked record). Supported by: text, selection, linked record fields."},"does_not_contain":{"type":"string","description":"Does not contain substring or value. Supported by: text, selection, linked record fields."},"starts_with":{"type":"string","description":"Starts with string. Supported by: text fields."},"ends_with":{"type":"string","description":"Ends with string. Supported by: text fields."},"is_empty":{"type":"boolean","description":"Field has no value (pass true). Supported by most field types."},"is_not_empty":{"type":"boolean","description":"Field has a value (pass true). Supported by most field types."},"in":{"type":"array","items":{"oneOf":[{"type":"string"},{"type":"number"}]},"description":"Value is in array. Supported by: text, number, selection, linked record fields."},"not_in":{"type":"array","items":{"oneOf":[{"type":"string"},{"type":"number"}]},"description":"Value is not in array. Supported by: text, number, selection, linked record fields."},"greater_than":{"oneOf":[{"type":"number","description":"Greater than value. Supported by: number, date fields."},{"type":"string","description":"Greater than value. Supported by: number, date fields.","format":"date"}]},"greater_than_or_equal_to":{"oneOf":[{"type":"number","description":"Greater than or equal to value. Supported by: number, date fields."},{"type":"string","description":"Greater than or equal to value. Supported by: number, date fields.","format":"date"}]},"less_than":{"oneOf":[{"type":"number","description":"Less than value. Supported by: number, date fields."},{"type":"string","description":"Less than value. Supported by: number, date fields.","format":"date"}]},"less_than_or_equal_to":{"oneOf":[{"type":"number","description":"Less than or equal to value. Supported by: number, date fields."},{"type":"string","description":"Less than or equal to value. Supported by: number, date fields.","format":"date"}]},"mode":{"type":"string","enum":["default","insensitive"],"default":"default","description":"Case sensitivity for text operators. `default` is case-sensitive; `insensitive` ignores case."}}}},"processedSecurityOptions":[{"schemes":[{"scheme":{"type":"http","scheme":"bearer","description":"Enter your Zite API key. Format: Bearer \u003capi_key>","scopes":[],"schemeName":"bearerAuth"},"schema":{"title":"Bearer Auth","type":"string","isRequired":true,"description":"Enter your Zite API key. Format: Bearer \u003capi_key>","format":"bearer","typeLabel":"string\u003cbearer>","deprecated":false},"schemeName":"bearerAuth","name":"Authorization"}],"title":"bearerAuth"}]},"originalFileLocation":"api/openapi.json"},"subdomain":"zite-js","siteName":"Zite Platform","title":"List Records - Zite Platform","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-10-27T05:56:45.373Z","originalFileLocation":"api/records/list-records.mdx"},"headHtml":"\u003cscript data-mint-head>(function(){var d=document.documentElement,p=null;if(!p){try{p=localStorage.getItem(\"isDarkMode\")}catch(e){}if(p==='true')p='dark';else if(p==='false')p='light';if(p!=='light'\u0026\u0026p!=='dark'\u0026\u0026p!=='system')p=\"dark\"}var r=p==='system'?(matchMedia(\"(prefers-color-scheme: dark)\").matches?'dark':'light'):p;d.classList.remove(r==='dark'?'light':'dark');d.classList.add(r);d.setAttribute(\"data-theme-preference\",p)})();\u003c/script>\u003cmeta data-mint-head name=\"description\" content=\"Retrieves records from a table with filtering, sorting, and pagination.\">\u003cmeta data-mint-head name=\"application-name\" content=\"Zite Platform\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/zite-js/kfgIWSogbuxhM4y1/_generated/favicon/android-chrome-192x192.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"apple-touch-icon\" type=\"image/png\" sizes=\"180x180\" href=\"/mintlify-assets/_mintlify/favicons/zite-js/kfgIWSogbuxhM4y1/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/zite-js/kfgIWSogbuxhM4y1/_generated/favicon/favicon-16x16.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/zite-js/kfgIWSogbuxhM4y1/_generated/favicon/favicon-32x32.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/zite-js/kfgIWSogbuxhM4y1/_generated/favicon/favicon.ico\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/zite-js/kfgIWSogbuxhM4y1/_generated/favicon-dark/android-chrome-192x192.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/zite-js/kfgIWSogbuxhM4y1/_generated/favicon-dark/favicon-16x16.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/zite-js/kfgIWSogbuxhM4y1/_generated/favicon-dark/favicon-32x32.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/zite-js/kfgIWSogbuxhM4y1/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"List Records - Zite Platform\">\u003cmeta data-mint-head property=\"og:description\" content=\"Retrieves records from a table with filtering, sorting, and pagination.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Zite Platform\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://developers.zite.com/api/records/list-records\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://zite-js.mintlify.site/_mintlify/api/og/v2?division=Records\u0026amp;title=List+Records\u0026amp;description=Retrieves+records+from+a+table+with+filtering%2C+sorting%2C+and+pagination.\u0026amp;theme=22b89a5d941d3e1a356e8acf\u0026amp;signature=eb2ef2e8cfbb751e677e4348752e59d70a8ef43b561e19594be2a233532a8760\">\u003cmeta data-mint-head property=\"og:image:width\" content=\"1200\">\u003cmeta data-mint-head property=\"og:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"twitter:card\" content=\"summary_large_image\">\u003cmeta data-mint-head name=\"twitter:title\" content=\"List Records - Zite Platform\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Retrieves records from a table with filtering, sorting, and pagination.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://zite-js.mintlify.site/_mintlify/api/og/v2?division=Records\u0026amp;title=List+Records\u0026amp;description=Retrieves+records+from+a+table+with+filtering%2C+sorting%2C+and+pagination.\u0026amp;theme=22b89a5d941d3e1a356e8acf\u0026amp;signature=eb2ef2e8cfbb751e677e4348752e59d70a8ef43b561e19594be2a233532a8760\">\u003cmeta data-mint-head name=\"twitter:image:width\" content=\"1200\">\u003cmeta data-mint-head name=\"twitter:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"msapplication-config\" content=\"/mintlify-assets/_mintlify/favicons/zite-js/kfgIWSogbuxhM4y1/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Zite Platform\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#292929\">\u003clink data-mint-head rel=\"canonical\" href=\"https://developers.zite.com/api/records/list-records\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api/records/list-records.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://developers.zite.com/#organization\",\"name\":\"Zite Platform\",\"url\":\"https://developers.zite.com\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/zite-js/LSPdozoqw4nFOq3k/logo/light.svg?fit=max\u0026auto=format\u0026n=LSPdozoqw4nFOq3k\u0026q=85\u0026s=fa83feb01f3d85c0ca46aad9a6419281\"}},{\"@type\":\"WebSite\",\"@id\":\"https://developers.zite.com#website\",\"name\":\"Zite Platform\",\"url\":\"https://developers.zite.com\",\"publisher\":{\"@id\":\"https://developers.zite.com/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://developers.zite.com/api/records/list-records#webpage\",\"url\":\"https://developers.zite.com/api/records/list-records\",\"name\":\"List Records\",\"description\":\"Retrieves records from a table with filtering, sorting, and pagination.\",\"dateModified\":\"2026-10-27T05:56:45.373Z\",\"isPartOf\":{\"@id\":\"https://developers.zite.com#website\"},\"breadcrumb\":{\"@id\":\"https://developers.zite.com/api/records/list-records#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://developers.zite.com/api/records/list-records#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"API reference\",\"item\":\"https://developers.zite.com/api/overview\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Records\",\"item\":\"https://developers.zite.com/api/records/create-record\"},{\"@type\":\"ListItem\",\"position\":3,\"name\":\"List Records\",\"item\":\"https://developers.zite.com/api/records/list-records\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://developers.zite.com/api/records/list-records#apireference\",\"headline\":\"List Records\",\"name\":\"List Records\",\"description\":\"Retrieves records from a table with filtering, sorting, and pagination.\",\"url\":\"https://developers.zite.com/api/records/list-records\",\"mainEntityOfPage\":{\"@id\":\"https://developers.zite.com/api/records/list-records#webpage\"},\"dateModified\":\"2026-10-27T05:56:45.373Z\",\"publisher\":{\"@id\":\"https://developers.zite.com/#organization\"},\"isPartOf\":{\"@id\":\"https://developers.zite.com#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Zite Platform\",\"publisher\":{\"@type\":\"Organization\",\"name\":\"Zite Platform\"},\"provider\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","agentPointerHref":"/api/records/list-records.md","siteName":"Zite Platform","nav":{"global":null,"tabs":[{"tab":"Guides","pages":[{"title":"Guides","href":"/introduction"}]},{"tab":"Database API","groups":[{"group":"API reference","icon":"server","pages":[{"title":"Zite Database REST API","sidebarTitle":"Overview","href":"/api/overview"},{"title":"JavaScript SDK","sidebarTitle":"JavaScript SDK","href":"/api/sdk"},{"title":"Zite Database Field Types","sidebarTitle":"Field Types","href":"/api/field-types"},{"title":"File Uploads","href":"/api/uploads"},{"group":"Records","icon":"rows-3","expanded":true,"pages":[{"title":"Create Record","openapi":"api/openapi.json POST /bases/{databaseId}/tables/{tableId}/records","href":"/api/records/create-record"},{"title":"Get Record by ID","openapi":"api/openapi.json GET /bases/{databaseId}/tables/{tableId}/records/{recordId}","href":"/api/records/get-record-by-id"},{"title":"Update Record","description":"Updates an existing record's field values.","openapi":"api/openapi.json PATCH /bases/{databaseId}/tables/{tableId}/records/{recordId}","href":"/api/records/update-record"},{"title":"List Records","openapi":"api/openapi.json POST /bases/{databaseId}/tables/{tableId}/records/list","href":"/api/records/list-records"},{"title":"Bulk Create Records","description":"Create or upsert up to 100 records in a single request.","openapi":"api/openapi.json POST /bases/{databaseId}/tables/{tableId}/records/bulk","href":"/api/records/bulk-create-records"},{"title":"Bulk Update Records","openapi":"api/openapi.json PUT /bases/{databaseId}/tables/{tableId}/records/bulk","href":"/api/records/bulk-update-records"},{"title":"Aggregate Records","openapi":"api/openapi.json POST /bases/{databaseId}/tables/{tableId}/records/aggregate","href":"/api/records/aggregate-records"},{"title":"Delete Record","openapi":"api/openapi.json DELETE /bases/{databaseId}/tables/{tableId}/records/{recordId}","href":"/api/records/delete-record"},{"title":"Bulk Delete Records","openapi":"api/openapi.json DELETE /bases/{databaseId}/tables/{tableId}/records/bulk","href":"/api/records/bulk-delete-records"}]},{"group":"SQL","icon":"terminal","expanded":true,"pages":[{"title":"Run SQL","openapi":"api/openapi.json POST /bases/{databaseId}/sql","href":"/api/sql/run-sql"},{"title":"Get SQL Schema","openapi":"api/openapi.json GET /bases/{databaseId}/sql/schema","href":"/api/sql/get-schema"}]},{"group":"Fields","icon":"columns-3","expanded":true,"pages":[{"title":"List Fields","openapi":"api/openapi.json GET /bases/{databaseId}/tables/{tableId}/fields","href":"/api/fields/list-fields"},{"title":"Create Field","openapi":"api/openapi.json POST /bases/{databaseId}/tables/{tableId}/fields","href":"/api/fields/create-field"},{"title":"Update Field","openapi":"api/openapi.json PATCH /bases/{databaseId}/tables/{tableId}/fields/{fieldId}","href":"/api/fields/update-field"},{"title":"Delete Field","openapi":"api/openapi.json DELETE /bases/{databaseId}/tables/{tableId}/fields/{fieldId}","href":"/api/fields/delete-field"}]},{"group":"Tables","icon":"table","expanded":true,"pages":[{"title":"Create Table","openapi":"api/openapi.json POST /bases/{databaseId}/tables","href":"/api/tables/create-table"},{"title":"Update Table","openapi":"api/openapi.json PATCH /bases/{databaseId}/tables/{tableId}","href":"/api/tables/update-table"},{"title":"Delete Table","openapi":"api/openapi.json DELETE /bases/{databaseId}/tables/{tableId}","href":"/api/tables/delete-table"}]},{"group":"Databases","icon":"database","expanded":true,"pages":[{"title":"Create Database","openapi":"api/openapi.json POST /bases","href":"/api/databases/create-database"},{"title":"Get Databases","openapi":"api/openapi.json GET /bases","href":"/api/databases/get-databases"},{"title":"Get Database by ID","openapi":"api/openapi.json GET /bases/{databaseId}","href":"/api/databases/get-database-by-id"},{"title":"Delete Database","openapi":"api/openapi.json DELETE /bases/{databaseId}","href":"/api/databases/delete-database"}]},{"group":"Webhooks","icon":"webhook","expanded":true,"pages":[{"title":"Webhooks overview","sidebarTitle":"Overview","href":"/api/webhooks/webhooks"},{"title":"Create Webhook","openapi":"api/openapi.json POST /bases/{databaseId}/webhooks","href":"/api/webhooks/create-webhook"},{"title":"List Webhooks","openapi":"api/openapi.json GET /bases/{databaseId}/webhooks","href":"/api/webhooks/list-webhooks"},{"title":"Delete Webhook","openapi":"api/openapi.json DELETE /bases/{databaseId}/webhooks/{webhookId}","href":"/api/webhooks/delete-webhook"}]}]},{"group":"Zite MCP (data)","icon":"plug","pages":[{"title":"Overview","sidebarTitle":"Overview","href":"/api/mcp/overview"},{"title":"Supported MCP Tools","sidebarTitle":"Supported Tools","href":"/api/mcp/tools"}]}]},{"tab":"Build API","pages":[{"title":"Build API","href":"/build-api/overview"}]}]},"basePath":"","title":"List Records - Zite Platform","buildId":"dpl_9RFrWkXdFTJCytfx6jAofvAaEXr6","deploymentId":"dpl_9RFrWkXdFTJCytfx6jAofvAaEXr6","dynamics":["c2aa737661","b0f84f53ff","a9bb46feb3","2b790eda92"],"chunks":["OpenApiReferenceProvider-BgGj2PGS.js","utils-BhNOqRKb.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-BAgRNUZo.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-CGkb0TPw.js","snippetPresets-ChLkL1a6.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","conditional-requirements-CFM0id0Q.js","Page-C7x-eUfk.js","ApiExamples-Ef10Jrbx.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-DlVCnjU8.js","shallow-BA55zJxQ.js","getApiPlaygroundDisplay-DR09dKtp.js","CodeSnippet-BZ8J8Kll.js","CodeSnippets-CcguVheG.js","getPastedJson-D5UqeqBp.js","icon-DpD0l99C.js","MethodPill-Wg2NXsp_.js","DuplicateIcon-CCSyX8lh.js","createIcon-C4Ukv9HX.js","DynamicMarkdown-RhjEuCHC.js","SectionHeading-DL1MykRq.js","axios-vUo_bRtp.js","Markdown-BwQ4RMdp.js","dist-CiVXVcSh.js","lib-DuNMoZ05.js","lib-B8HbPgcC.js","katex-YMM-FMeD.js","html-void-elements-mCSPHezU.js","marked.esm-CZWythHk.js","AssistantPageLink-Dic2Jtb2.js"]}