Filter by visibility. ACTIVE excludes archived (default), ARCHIVED returns only archived, ALL returns both.
Available options:
ACTIVE,
ARCHIVED,
ALL
page
number
Page number
take
number
Number of items to take
next
string
Next page token (Only used on special endpoints)
progressive
boolean
Skip the total count: pagination-count is exact on the last page, and one more than the items so far while more pages exist (Only used on special endpoints)
Response
200 - application/json
id
string
required
Example:
"page_5Fb7…"
slug
string
required
Friendly URL segment, unique per org.
Required string length: 1 - 64
Pattern: ^[a-z][a-z0-9-]{0,63}$
Example:
"store-overview"
title
string | null
required
Page title.
Required string length: 1 - 255
Example:
"Store overview"
icon
string<emoji>enum<string>
required
The emoji of a curated icon a user can pick for a table, view, field, or other entity
color
enum<string> | null
required
Accent color, by name
Available options:
red,
orange,
amber,
yellow,
lime,
green,
teal,
cyan,
sky,
blue,
indigo,
violet,
purple,
fuchsia,
pink,
rose,
neutral
parent_id
string | null
required
Parent page id. Reserved for nesting; unused by the UI.
position
integer
required
Sidebar-zone order.
show_in_sidebar
boolean
required
archived
boolean
required
readonly
boolean
required
Locked: the UI hides all edit affordances until unlocked.