{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"Awardee API Docs","description":"The Awardee API. Programmable scan URLs, AI chatbots, dynamic pages, knowledge bases, and the data flowing between them. One platform, one REST API.","colors":{"primary":"#007495","light":"#007495","dark":"#007495"},"logo":{"light":"https://mintcdn.com/awardee/7I10fGCy_lj2kAK9/images/logo.png?fit=max\u0026auto=format\u0026n=7I10fGCy_lj2kAK9\u0026q=85\u0026s=bef1392e0027469937f4188e5805d952","dark":"https://mintcdn.com/awardee/7I10fGCy_lj2kAK9/images/logo-dark.png?fit=max\u0026auto=format\u0026n=7I10fGCy_lj2kAK9\u0026q=85\u0026s=d2b74502b57db56f1fb9ee4d5afb6e47","href":"https://awardee.com"},"favicon":"https://mintcdn.com/awardee/7I10fGCy_lj2kAK9/images/favicon.ico?fit=max\u0026auto=format\u0026n=7I10fGCy_lj2kAK9\u0026q=85\u0026s=ffe5ac4fc2e5971a90f56c86c4267386","api":{"openapi":"openapi.json","playground":{"display":"interactive"},"examples":{"languages":["curl","javascript","python"]}},"appearance":{"default":"light"},"navbar":{"links":[{"href":"https://app.awardee.com","label":"Dashboard"},{"href":"mailto:[email protected]","label":"Support"}],"primary":{"type":"button","label":"Get started","href":"https://awardee.com/login"}},"search":{"prompt":"Search the Awardee API"},"fonts":{"family":"Geist"},"styling":{"latex":false},"navigation":{"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"awardee","hasAudioNarration":false,"actualSubdomain":"awardee","customDomains":["docs.awardee.com"],"gitSource":{"type":"github","owner":"awardee-pty-ltd","repo":"awardee","deployBranch":"main","contentDirectory":"docs","isPrivate":true,"mountPath":"","label":""},"chroma":{"liveDeploymentHistoryId":"6ac37648f2a73d93d63d5107","collectionId":"bee74cda-cdab-43bc-856f-35cfaafa67d6","schemaVersion":"v3","latestBuiltDeploymentHistoryId":"6ac37648f2a73d93d63d5107"},"entitlements":{"AI_CHAT":{"status":"DISABLED"}},"buildId":"6ac37648f2a73d93d63d5107","clientVersion":"0.0.4021","searchFilterCounts":[{"language":"default","tag":"Endpoints","count":121},{"language":"default","tag":"Articles","count":28},{"language":"default","tag":"Conversations","count":13},{"language":"default","tag":"Products","count":13},{"language":"default","tag":"Objects","count":12},{"language":"default","tag":"Chatbots","count":11},{"language":"default","tag":"QR Codes","count":11},{"language":"default","tag":"Team","count":11},{"language":"default","tag":"Webhooks","count":11},{"language":"default","tag":"QR Groups","count":9}]},"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":"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":"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":"llms-txt-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"pause-universal-search-reconcile","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":"per-site-search-delta","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":"editor-private-page-search","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":"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":"byok-sep-25","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":"vite-origin","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-updated-9-15","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":"workos-enabled","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"googleFontsInlined":true},"customCss":[],"page":{"pagePath":"api-reference/pages/list-pages","slug":"/api-reference/pages/list-pages","pageMetadata":{"title":"List pages","description":"Returns page metadata only — fetch `/pages/{id}` to walk the block tree.","deprecated":null,"version":null,"openapi":"/openapi.json get /pages","href":"/api-reference/pages/list-pages","autogeneratedByOpenApi":true},"description":{"compiledSource":"\"use strict\";\nconst {jsx: _jsx, jsxs: _jsxs} = arguments[0];\nconst {useMDXComponents: _provideComponents} = arguments[0];\nfunction _createMdxContent(props) {\n const _components = {\n code: \"code\",\n p: \"p\",\n ..._provideComponents(),\n ...props.components\n };\n return _jsxs(_components.p, {\n children: [\"Returns page metadata only — fetch \", _jsx(_components.code, {\n children: \"/pages/{id}\"\n }), \" to walk the block tree.\"]\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}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){return _jsx(_Fragment,{})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{default:MDXContent}","frontmatter":{},"scope":{"config":{},"pageMetadata":{"title":"List pages","description":"Returns page metadata only — fetch `/pages/{id}` to walk the block tree.","deprecated":null,"version":null,"openapi":"/openapi.json get /pages","href":"/api-reference/pages/list-pages","autogeneratedByOpenApi":true}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":[],"openApiReferenceData":{"operation":{"summary":"List pages","description":"Returns page metadata only — fetch `/pages/{id}` to walk the block tree.","tags":["Pages"],"parameters":["5c8882b1-580a-4a23-a06e-cda9215ff61b","d1e07128-09b3-4d08-8964-d2ed19fc3812","7d7491bc-cc17-4032-ae58-8d20b774b464","4db0aec7-890a-4b0d-ab95-abc58d80952a"],"responses":{"200":"a961454f-8a05-45fa-9d92-da3e85211ccd","400":"7896212f-c421-4c00-80fb-69d04acc87d0","401":"165ff921-207c-4847-ad43-e5a7670e6a41","403":"bc99397b-78e9-447f-b450-2d6a37c88193","404":"621d8f5c-dfea-47de-a41a-ce2755d7190c","429":"6a4f8ed0-9ab4-4e4e-8be7-9285952043d8","500":"afefbed2-0626-4961-9298-8ad1d83937ad"},"method":"get","type":"path","servers":["0d149369-f23f-44f6-af00-b3b2026dc053"],"security":["cae52148-006a-46c5-bc93-cc627ad96416"],"path":"/pages","baseUrlOptions":["https://api.awardee.com/v1"],"title":"List pages","codeSamples":[],"requestExampleLanguages":["bash","javascript","python"],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{"5c8882b1-580a-4a23-a06e-cda9215ff61b":{"name":"page","in":"query","required":false,"schema":{"type":"integer","minimum":1,"maximum":9007199254740991,"isRequired":false,"uniqueKey":"","typeLabel":"integer"}},"d1e07128-09b3-4d08-8964-d2ed19fc3812":{"name":"page_size","in":"query","required":false,"schema":{"type":"integer","minimum":1,"maximum":100,"isRequired":false,"uniqueKey":"","typeLabel":"integer"}},"7d7491bc-cc17-4032-ae58-8d20b774b464":{"name":"search","in":"query","required":false,"schema":{"type":"string","isRequired":false,"uniqueKey":"","typeLabel":"string"}},"4db0aec7-890a-4b0d-ab95-abc58d80952a":{"name":"status","in":"query","required":false,"schema":{"type":"string","enum":["draft","active","inactive","archived"],"isRequired":false,"uniqueKey":"","typeLabel":"enum\u003cstring>"}}},"responses":{"a961454f-8a05-45fa-9d92-da3e85211ccd":{"description":"Pages","content":{"application/json":{"schema":{"type":"object","properties":{"object":{"type":"string","const":"list","isRequired":true,"uniqueKey":"object","typeLabel":"string"},"total":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"isRequired":true,"uniqueKey":"total","typeLabel":"integer"},"page":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"isRequired":true,"uniqueKey":"page","typeLabel":"integer"},"page_size":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"isRequired":true,"uniqueKey":"page_size","typeLabel":"integer"},"data":{"type":"array","items":{"type":"object","properties":{"object":{"type":"string","const":"page","isRequired":true,"uniqueKey":"data.items.[INDEX].object","typeLabel":"string"},"id":{"type":"string","format":"uuid","isRequired":true,"uniqueKey":"data.items.[INDEX].id","typeLabel":"string\u003cuuid>"},"slug":{"type":"string","isRequired":true,"uniqueKey":"data.items.[INDEX].slug","typeLabel":"string"},"public_slug":{"type":"string","isRequired":true,"uniqueKey":"data.items.[INDEX].public_slug","typeLabel":"string"},"status":{"type":"string","enum":["draft","active","inactive","archived"],"isRequired":true,"uniqueKey":"data.items.[INDEX].status","typeLabel":"enum\u003cstring>"},"title":{"type":"string","isRequired":true,"uniqueKey":"data.items.[INDEX].title","typeLabel":"string"},"description":{"oneOf":[{"type":"string","isRequired":true,"uniqueKey":"data.items.[INDEX].description.oneOf.0","typeLabel":"string"},{"type":"null","isRequired":true,"uniqueKey":"data.items.[INDEX].description.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.items.[INDEX].description","typeLabel":"string | null"},"background":{"oneOf":[{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","const":"color","isRequired":true,"uniqueKey":"data.items.[INDEX].background.oneOf.0.type","typeLabel":"string"},"value":{"type":"string","isRequired":true,"uniqueKey":"data.items.[INDEX].background.oneOf.0.value","typeLabel":"string"}},"additionalProperties":false,"isRequired":true,"uniqueKey":"data.items.[INDEX].background.oneOf.0","typeLabel":"object"},{"type":"object","required":["type","value","animated"],"properties":{"type":{"type":"string","const":"gradient","isRequired":true,"uniqueKey":"data.items.[INDEX].background.oneOf.1.type","typeLabel":"string"},"value":{"type":"string","isRequired":true,"uniqueKey":"data.items.[INDEX].background.oneOf.1.value","typeLabel":"string"},"animated":{"default":false,"type":"boolean","isRequired":true,"uniqueKey":"data.items.[INDEX].background.oneOf.1.animated","typeLabel":"boolean"},"animatedStops":{"type":"array","items":{"type":"string","uniqueKey":"data.items.[INDEX].background.oneOf.1.animatedStops.items.[INDEX]","typeLabel":"string"},"uniqueKey":"data.items.[INDEX].background.oneOf.1.animatedStops","typeLabel":"string[]"}},"additionalProperties":false,"isRequired":true,"uniqueKey":"data.items.[INDEX].background.oneOf.1","typeLabel":"object"},{"type":"object","required":["type","assetId","url"],"properties":{"type":{"type":"string","const":"image","isRequired":true,"uniqueKey":"data.items.[INDEX].background.oneOf.2.type","typeLabel":"string"},"assetId":{"oneOf":[{"type":"string","format":"uuid","isRequired":true,"uniqueKey":"data.items.[INDEX].background.oneOf.2.assetId.oneOf.0","typeLabel":"string\u003cuuid>"},{"type":"null","isRequired":true,"uniqueKey":"data.items.[INDEX].background.oneOf.2.assetId.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.items.[INDEX].background.oneOf.2.assetId","typeLabel":"string\u003cuuid> | null"},"url":{"oneOf":[{"type":"string","isRequired":true,"uniqueKey":"data.items.[INDEX].background.oneOf.2.url.oneOf.0","typeLabel":"string"},{"type":"null","isRequired":true,"uniqueKey":"data.items.[INDEX].background.oneOf.2.url.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.items.[INDEX].background.oneOf.2.url","typeLabel":"string | null"},"overlayColor":{"type":"string","uniqueKey":"data.items.[INDEX].background.oneOf.2.overlayColor","typeLabel":"string"},"overlayOpacity":{"type":"number","minimum":0,"maximum":1,"uniqueKey":"data.items.[INDEX].background.oneOf.2.overlayOpacity","typeLabel":"number"}},"additionalProperties":false,"isRequired":true,"uniqueKey":"data.items.[INDEX].background.oneOf.2","typeLabel":"object"},{"type":"object","required":["type","assetId","url"],"properties":{"type":{"type":"string","const":"video","isRequired":true,"uniqueKey":"data.items.[INDEX].background.oneOf.3.type","typeLabel":"string"},"assetId":{"oneOf":[{"type":"string","format":"uuid","isRequired":true,"uniqueKey":"data.items.[INDEX].background.oneOf.3.assetId.oneOf.0","typeLabel":"string\u003cuuid>"},{"type":"null","isRequired":true,"uniqueKey":"data.items.[INDEX].background.oneOf.3.assetId.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.items.[INDEX].background.oneOf.3.assetId","typeLabel":"string\u003cuuid> | null"},"url":{"oneOf":[{"type":"string","isRequired":true,"uniqueKey":"data.items.[INDEX].background.oneOf.3.url.oneOf.0","typeLabel":"string"},{"type":"null","isRequired":true,"uniqueKey":"data.items.[INDEX].background.oneOf.3.url.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.items.[INDEX].background.oneOf.3.url","typeLabel":"string | null"},"posterAssetId":{"oneOf":[{"type":"string","format":"uuid","uniqueKey":"data.items.[INDEX].background.oneOf.3.posterAssetId.oneOf.0","typeLabel":"string\u003cuuid>"},{"type":"null","uniqueKey":"data.items.[INDEX].background.oneOf.3.posterAssetId.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.items.[INDEX].background.oneOf.3.posterAssetId","typeLabel":"string\u003cuuid> | null"},"posterUrl":{"oneOf":[{"type":"string","uniqueKey":"data.items.[INDEX].background.oneOf.3.posterUrl.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"data.items.[INDEX].background.oneOf.3.posterUrl.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.items.[INDEX].background.oneOf.3.posterUrl","typeLabel":"string | null"}},"additionalProperties":false,"isRequired":true,"uniqueKey":"data.items.[INDEX].background.oneOf.3","typeLabel":"object"}],"isRequired":true,"uniqueKey":"data.items.[INDEX].background","typeLabel":"object"},"island":{"type":"object","properties":{"color":{"default":"#ffffff","type":"string","isRequired":true,"uniqueKey":"data.items.[INDEX].island.color","typeLabel":"string"},"opacity":{"default":1,"type":"number","minimum":0,"maximum":1,"isRequired":true,"uniqueKey":"data.items.[INDEX].island.opacity","typeLabel":"number"},"shadow":{"default":"md","type":"string","enum":["none","sm","md","lg","xl"],"isRequired":true,"uniqueKey":"data.items.[INDEX].island.shadow","typeLabel":"enum\u003cstring>"},"roundness":{"default":"3xl","type":"string","enum":["none","sm","md","lg","xl","2xl","3xl"],"isRequired":true,"uniqueKey":"data.items.[INDEX].island.roundness","typeLabel":"enum\u003cstring>"}},"required":["color","opacity","shadow","roundness"],"additionalProperties":false,"isRequired":true,"uniqueKey":"data.items.[INDEX].island","typeLabel":"object"},"favicon_url":{"oneOf":[{"type":"string","isRequired":true,"uniqueKey":"data.items.[INDEX].favicon_url.oneOf.0","typeLabel":"string"},{"type":"null","isRequired":true,"uniqueKey":"data.items.[INDEX].favicon_url.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.items.[INDEX].favicon_url","typeLabel":"string | null"},"meta_title":{"oneOf":[{"type":"string","isRequired":true,"uniqueKey":"data.items.[INDEX].meta_title.oneOf.0","typeLabel":"string"},{"type":"null","isRequired":true,"uniqueKey":"data.items.[INDEX].meta_title.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.items.[INDEX].meta_title","typeLabel":"string | null"},"meta_description":{"oneOf":[{"type":"string","isRequired":true,"uniqueKey":"data.items.[INDEX].meta_description.oneOf.0","typeLabel":"string"},{"type":"null","isRequired":true,"uniqueKey":"data.items.[INDEX].meta_description.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.items.[INDEX].meta_description","typeLabel":"string | null"},"og_image_url":{"oneOf":[{"type":"string","isRequired":true,"uniqueKey":"data.items.[INDEX].og_image_url.oneOf.0","typeLabel":"string"},{"type":"null","isRequired":true,"uniqueKey":"data.items.[INDEX].og_image_url.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.items.[INDEX].og_image_url","typeLabel":"string | null"},"view_count":{"type":"integer","minimum":0,"maximum":9007199254740991,"isRequired":true,"uniqueKey":"data.items.[INDEX].view_count","typeLabel":"integer"},"created_at":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$","isRequired":true,"uniqueKey":"data.items.[INDEX].created_at","typeLabel":"string\u003cdate-time>"},"updated_at":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$","isRequired":true,"uniqueKey":"data.items.[INDEX].updated_at","typeLabel":"string\u003cdate-time>"}},"required":["object","id","slug","public_slug","status","title","description","background","island","favicon_url","meta_title","meta_description","og_image_url","view_count","created_at","updated_at"],"additionalProperties":false,"uniqueKey":"data.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"data","typeLabel":"object[]"}},"required":["object","total","page","page_size","data"],"additionalProperties":false,"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"object":"list","total":0,"page":0,"page_size":0,"data":[{"object":"page","id":"3c90c3cc-0d44-4b50-8888-8dd25736052a","slug":"\u003cstring>","public_slug":"\u003cstring>","status":"draft","title":"\u003cstring>","description":"\u003cstring>","background":{"type":"color","value":"\u003cstring>"},"island":{"color":"#ffffff","opacity":1,"shadow":"md","roundness":"3xl"},"favicon_url":"\u003cstring>","meta_title":"\u003cstring>","meta_description":"\u003cstring>","og_image_url":"\u003cstring>","view_count":4503599627370495,"created_at":"2023-11-07T05:31:56Z","updated_at":"2023-11-07T05:31:56Z"}]}}},"exampleType":"generated"}},"exampleType":"generated"},"7896212f-c421-4c00-80fb-69d04acc87d0":{"description":"Bad request","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","description":"Machine-readable error code.","isRequired":true,"uniqueKey":"error","typeLabel":"string"},"message":{"type":"string","isRequired":true,"uniqueKey":"message","typeLabel":"string"},"request_id":{"type":"string","uniqueKey":"request_id","typeLabel":"string"},"details":{"oneOf":[{}],"uniqueKey":"details","typeLabel":"any"},"retry_after":{"type":"number","uniqueKey":"retry_after","typeLabel":"number"}},"required":["error","message"],"additionalProperties":false,"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"error":"\u003cstring>","message":"\u003cstring>","request_id":"\u003cstring>","details":"\u003cunknown>","retry_after":123}}},"exampleType":"generated"}},"exampleType":"generated"},"165ff921-207c-4847-ad43-e5a7670e6a41":{"description":"Authentication failed","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","description":"Machine-readable error code.","isRequired":true,"uniqueKey":"error","typeLabel":"string"},"message":{"type":"string","isRequired":true,"uniqueKey":"message","typeLabel":"string"},"request_id":{"type":"string","uniqueKey":"request_id","typeLabel":"string"},"details":{"oneOf":[{}],"uniqueKey":"details","typeLabel":"any"},"retry_after":{"type":"number","uniqueKey":"retry_after","typeLabel":"number"}},"required":["error","message"],"additionalProperties":false,"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"error":"\u003cstring>","message":"\u003cstring>","request_id":"\u003cstring>","details":"\u003cunknown>","retry_after":123}}},"exampleType":"generated"}},"exampleType":"generated"},"bc99397b-78e9-447f-b450-2d6a37c88193":{"description":"Forbidden","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","description":"Machine-readable error code.","isRequired":true,"uniqueKey":"error","typeLabel":"string"},"message":{"type":"string","isRequired":true,"uniqueKey":"message","typeLabel":"string"},"request_id":{"type":"string","uniqueKey":"request_id","typeLabel":"string"},"details":{"oneOf":[{}],"uniqueKey":"details","typeLabel":"any"},"retry_after":{"type":"number","uniqueKey":"retry_after","typeLabel":"number"}},"required":["error","message"],"additionalProperties":false,"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"error":"\u003cstring>","message":"\u003cstring>","request_id":"\u003cstring>","details":"\u003cunknown>","retry_after":123}}},"exampleType":"generated"}},"exampleType":"generated"},"621d8f5c-dfea-47de-a41a-ce2755d7190c":{"description":"Not found","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","description":"Machine-readable error code.","isRequired":true,"uniqueKey":"error","typeLabel":"string"},"message":{"type":"string","isRequired":true,"uniqueKey":"message","typeLabel":"string"},"request_id":{"type":"string","uniqueKey":"request_id","typeLabel":"string"},"details":{"oneOf":[{}],"uniqueKey":"details","typeLabel":"any"},"retry_after":{"type":"number","uniqueKey":"retry_after","typeLabel":"number"}},"required":["error","message"],"additionalProperties":false,"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"error":"\u003cstring>","message":"\u003cstring>","request_id":"\u003cstring>","details":"\u003cunknown>","retry_after":123}}},"exampleType":"generated"}},"exampleType":"generated"},"6a4f8ed0-9ab4-4e4e-8be7-9285952043d8":{"description":"Rate limit exceeded","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","description":"Machine-readable error code.","isRequired":true,"uniqueKey":"error","typeLabel":"string"},"message":{"type":"string","isRequired":true,"uniqueKey":"message","typeLabel":"string"},"request_id":{"type":"string","uniqueKey":"request_id","typeLabel":"string"},"details":{"oneOf":[{}],"uniqueKey":"details","typeLabel":"any"},"retry_after":{"type":"number","uniqueKey":"retry_after","typeLabel":"number"}},"required":["error","message"],"additionalProperties":false,"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"error":"\u003cstring>","message":"\u003cstring>","request_id":"\u003cstring>","details":"\u003cunknown>","retry_after":123}}},"exampleType":"generated"}},"exampleType":"generated"},"afefbed2-0626-4961-9298-8ad1d83937ad":{"description":"Internal server error","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","description":"Machine-readable error code.","isRequired":true,"uniqueKey":"error","typeLabel":"string"},"message":{"type":"string","isRequired":true,"uniqueKey":"message","typeLabel":"string"},"request_id":{"type":"string","uniqueKey":"request_id","typeLabel":"string"},"details":{"oneOf":[{}],"uniqueKey":"details","typeLabel":"any"},"retry_after":{"type":"number","uniqueKey":"retry_after","typeLabel":"number"}},"required":["error","message"],"additionalProperties":false,"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"error":"\u003cstring>","message":"\u003cstring>","request_id":"\u003cstring>","details":"\u003cunknown>","retry_after":123}}},"exampleType":"generated"}},"exampleType":"generated"}},"security":{"cae52148-006a-46c5-bc93-cc627ad96416":{"api_key":{"type":"http","scheme":"bearer","bearerFormat":"aw_live_\u003chex>","description":"Send your API key as `Authorization: Bearer aw_live_…`. Manage keys in the dashboard under Settings → API Keys.","scopes":[]}}},"servers":{"0d149369-f23f-44f6-af00-b3b2026dc053":{"url":"https://api.awardee.com/v1","description":"Production"}},"processedSecurityOptions":[{"schemes":[{"scheme":{"type":"http","scheme":"bearer","bearerFormat":"aw_live_\u003chex>","description":"Send your API key as `Authorization: Bearer aw_live_…`. Manage keys in the dashboard under Settings → API Keys.","scopes":[]},"schema":{"title":"Bearer Auth","type":"string","isRequired":true,"description":"Send your API key as `Authorization: Bearer aw_live_…`. Manage keys in the dashboard under Settings → API Keys.","format":"bearer","typeLabel":"string\u003cbearer>","deprecated":false},"schemeName":"api_key","name":"Authorization"}],"title":"api_key"}]},"originalFileLocation":"openapi.json"},"subdomain":"awardee","siteName":"Awardee API Docs","title":"List pages - Awardee API Docs","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-10-05T10:05:04.234Z","originalFileLocation":"api-reference/pages/list-pages.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=\"light\"}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=\"Returns page metadata only — fetch /pages/{id} to walk the block tree.\">\u003cmeta data-mint-head name=\"application-name\" content=\"Awardee API Docs\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/awardee/zDXRVEiJfSlk9OQP/_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/awardee/zDXRVEiJfSlk9OQP/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/awardee/zDXRVEiJfSlk9OQP/_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/awardee/zDXRVEiJfSlk9OQP/_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/awardee/zDXRVEiJfSlk9OQP/_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/awardee/zDXRVEiJfSlk9OQP/_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/awardee/zDXRVEiJfSlk9OQP/_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/awardee/zDXRVEiJfSlk9OQP/_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/awardee/zDXRVEiJfSlk9OQP/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"List pages - Awardee API Docs\">\u003cmeta data-mint-head property=\"og:description\" content=\"Returns page metadata only — fetch /pages/{id} to walk the block tree.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Awardee API Docs\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.awardee.com/api-reference/pages/list-pages\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://awardee.mintlify.app/_mintlify/api/og/v2?division=Endpoints\u0026amp;title=List+pages\u0026amp;description=Returns+page+metadata+only+%E2%80%94+fetch+%60%2Fpages%2F%7Bid%7D%60+to+walk+the+block+tree.\u0026amp;theme=5814cdf6573aa1102c88c209\u0026amp;signature=179a963af05f3685000031b8439a4f03586012c31d8365aeb2658bd0c8b089c5\">\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 pages - Awardee API Docs\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Returns page metadata only — fetch /pages/{id} to walk the block tree.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://awardee.mintlify.app/_mintlify/api/og/v2?division=Endpoints\u0026amp;title=List+pages\u0026amp;description=Returns+page+metadata+only+%E2%80%94+fetch+%60%2Fpages%2F%7Bid%7D%60+to+walk+the+block+tree.\u0026amp;theme=5814cdf6573aa1102c88c209\u0026amp;signature=179a963af05f3685000031b8439a4f03586012c31d8365aeb2658bd0c8b089c5\">\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/awardee/zDXRVEiJfSlk9OQP/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Awardee API Docs\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#007495\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.awardee.com/api-reference/pages/list-pages\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api-reference/pages/list-pages.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.awardee.com/#organization\",\"name\":\"Awardee API Docs\",\"url\":\"https://docs.awardee.com\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/awardee/7I10fGCy_lj2kAK9/images/logo.png?fit=max\u0026auto=format\u0026n=7I10fGCy_lj2kAK9\u0026q=85\u0026s=bef1392e0027469937f4188e5805d952\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.awardee.com#website\",\"name\":\"Awardee API Docs\",\"url\":\"https://docs.awardee.com\",\"publisher\":{\"@id\":\"https://docs.awardee.com/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.awardee.com/api-reference/pages/list-pages#webpage\",\"url\":\"https://docs.awardee.com/api-reference/pages/list-pages\",\"name\":\"List pages\",\"description\":\"Returns page metadata only — fetch /pages/{id} to walk the block tree.\",\"dateModified\":\"2026-10-05T10:05:04.234Z\",\"isPartOf\":{\"@id\":\"https://docs.awardee.com#website\"},\"breadcrumb\":{\"@id\":\"https://docs.awardee.com/api-reference/pages/list-pages#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.awardee.com/api-reference/pages/list-pages#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Pages\",\"item\":\"https://docs.awardee.com/pages/overview\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"List pages\",\"item\":\"https://docs.awardee.com/api-reference/pages/list-pages\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.awardee.com/api-reference/pages/list-pages#apireference\",\"headline\":\"List pages\",\"name\":\"List pages\",\"description\":\"Returns page metadata only — fetch /pages/{id} to walk the block tree.\",\"url\":\"https://docs.awardee.com/api-reference/pages/list-pages\",\"mainEntityOfPage\":{\"@id\":\"https://docs.awardee.com/api-reference/pages/list-pages#webpage\"},\"dateModified\":\"2026-10-05T10:05:04.234Z\",\"publisher\":{\"@id\":\"https://docs.awardee.com/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.awardee.com#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Awardee API Docs\",\"creator\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","siteName":"Awardee API Docs","nav":{"global":null,"groups":[{"group":"Get started","pages":[{"title":"Awardee API","href":"/index"},{"title":"Quickstart","sidebarTitle":"Quickstart","href":"/quickstart"},{"title":"Verify your key","sidebarTitle":"Verify your key","href":"/verify"}]},{"group":"Identity","pages":[{"group":"Endpoints","pages":[{"title":"Get the current identity","deprecated":null,"version":null,"openapi":"/openapi.json get /me","href":"/api-reference/identity/get-the-current-identity"}]}]},{"group":"Concepts","pages":[{"title":"Authentication","sidebarTitle":"Authentication","href":"/concepts/authentication"},{"title":"Idempotency","sidebarTitle":"Idempotency","href":"/concepts/idempotency"},{"title":"Pagination","sidebarTitle":"Pagination","href":"/concepts/pagination"},{"title":"Rate limits","sidebarTitle":"Rate limits","href":"/concepts/rate-limits"},{"title":"Errors","sidebarTitle":"Errors","href":"/concepts/errors"},{"title":"Versioning","sidebarTitle":"Versioning","href":"/concepts/versioning"}]},{"group":"Webhooks","pages":[{"title":"Webhooks","sidebarTitle":"Overview","href":"/webhooks/overview"},{"title":"Event catalog","sidebarTitle":"Events","href":"/webhooks/events"},{"title":"Verify signatures","sidebarTitle":"Signing","href":"/webhooks/signing"},{"title":"Retries and ordering","sidebarTitle":"Retries","href":"/webhooks/retries"},{"title":"Delivery idempotency","sidebarTitle":"Idempotency","href":"/webhooks/idempotency"},{"title":"Testing webhooks","sidebarTitle":"Testing","href":"/webhooks/testing"},{"title":"Managing","href":"/webhooks/managing"},{"group":"Endpoints","pages":[{"title":"Create a webhook","deprecated":null,"version":null,"openapi":"/openapi.json post /webhooks","href":"/api-reference/webhooks/create-a-webhook"},{"title":"List webhooks","deprecated":null,"version":null,"openapi":"/openapi.json get /webhooks","href":"/api-reference/webhooks/list-webhooks"},{"title":"Get a webhook","deprecated":null,"version":null,"openapi":"/openapi.json get /webhooks/{id}","href":"/api-reference/webhooks/get-a-webhook"},{"title":"Update a webhook","deprecated":null,"version":null,"openapi":"/openapi.json patch /webhooks/{id}","href":"/api-reference/webhooks/update-a-webhook"},{"title":"Delete a webhook","deprecated":null,"version":null,"openapi":"/openapi.json delete /webhooks/{id}","href":"/api-reference/webhooks/delete-a-webhook"}]}]},{"group":"Chatbots","pages":[{"title":"Chatbots","href":"/chatbots/overview"},{"title":"The Chatbot object","href":"/chatbots/object"},{"title":"Scan-specific knowledge","href":"/chatbots/scan-specific-knowledge"},{"title":"Retrieval preview","href":"/chatbots/retrieval-preview"},{"title":"Models","href":"/chatbots/models"},{"group":"Endpoints","pages":[{"title":"Create a chatbot","deprecated":null,"version":null,"openapi":"/openapi.json post /chatbots","href":"/api-reference/chatbots/create-a-chatbot"},{"title":"List chatbots","deprecated":null,"version":null,"openapi":"/openapi.json get /chatbots","href":"/api-reference/chatbots/list-chatbots"},{"title":"Get a chatbot","deprecated":null,"version":null,"openapi":"/openapi.json get /chatbots/{id}","href":"/api-reference/chatbots/get-a-chatbot"},{"title":"Update a chatbot","deprecated":null,"version":null,"openapi":"/openapi.json patch /chatbots/{id}","href":"/api-reference/chatbots/update-a-chatbot"},{"title":"Delete a chatbot","deprecated":null,"version":null,"openapi":"/openapi.json delete /chatbots/{id}","href":"/api-reference/chatbots/delete-a-chatbot"},{"title":"Preview knowledge retrieval for a query","deprecated":null,"version":null,"openapi":"/openapi.json post /chatbots/{id}/retrieval-preview","href":"/api-reference/chatbots/preview-knowledge-retrieval-for-a-query"}]}]},{"group":"Customers","pages":[{"title":"Customers","href":"/customers/overview"},{"group":"Endpoints","pages":[{"title":"Upsert a customer","deprecated":null,"version":null,"openapi":"/openapi.json post /customers","href":"/api-reference/customers/upsert-a-customer"},{"title":"List customers","deprecated":null,"version":null,"openapi":"/openapi.json get /customers","href":"/api-reference/customers/list-customers"},{"title":"Get a customer","deprecated":null,"version":null,"openapi":"/openapi.json get /customers/{id}","href":"/api-reference/customers/get-a-customer"},{"title":"Update a customer","deprecated":null,"version":null,"openapi":"/openapi.json patch /customers/{id}","href":"/api-reference/customers/update-a-customer"},{"title":"Delete a customer","deprecated":null,"version":null,"openapi":"/openapi.json delete /customers/{id}","href":"/api-reference/customers/delete-a-customer"}]}]},{"group":"Articles","pages":[{"title":"Articles","href":"/articles/overview"},{"title":"The article object","href":"/articles/object"},{"title":"Publishing \u0026 indexing","href":"/articles/publishing"},{"title":"Translations","href":"/articles/translations"},{"title":"Versions","href":"/articles/versions"},{"title":"Relations","href":"/articles/relations"},{"title":"Chunks","href":"/articles/chunks"},{"group":"Endpoints","pages":[{"title":"Create an article","deprecated":null,"version":null,"openapi":"/openapi.json post /articles","href":"/api-reference/articles/create-an-article"},{"title":"List articles","deprecated":null,"version":null,"openapi":"/openapi.json get /articles","href":"/api-reference/articles/list-articles"},{"title":"Get an article","deprecated":null,"version":null,"openapi":"/openapi.json get /articles/{id}","href":"/api-reference/articles/get-an-article"},{"title":"Update an article","deprecated":null,"version":null,"openapi":"/openapi.json patch /articles/{id}","href":"/api-reference/articles/update-an-article"},{"title":"Delete an article","deprecated":null,"version":null,"openapi":"/openapi.json delete /articles/{id}","href":"/api-reference/articles/delete-an-article"},{"title":"List article versions","deprecated":null,"version":null,"openapi":"/openapi.json get /articles/{id}/versions","href":"/api-reference/articles/list-article-versions"},{"title":"Snapshot the current article body as a new version","deprecated":null,"version":null,"openapi":"/openapi.json post /articles/{id}/versions","href":"/api-reference/articles/snapshot-the-current-article-body-as-a-new-version"},{"title":"Get a specific version of an article","deprecated":null,"version":null,"openapi":"/openapi.json get /articles/{id}/versions/{version}","href":"/api-reference/articles/get-a-specific-version-of-an-article"},{"title":"Restore an article to a prior version","deprecated":null,"version":null,"openapi":"/openapi.json post /articles/{id}/versions/{version}/restore","href":"/api-reference/articles/restore-an-article-to-a-prior-version"},{"title":"List article translations","deprecated":null,"version":null,"openapi":"/openapi.json get /articles/{id}/translations","href":"/api-reference/articles/list-article-translations"},{"title":"Create a translation","deprecated":null,"version":null,"openapi":"/openapi.json post /articles/{id}/translations","href":"/api-reference/articles/create-a-translation"},{"title":"Get a translation","deprecated":null,"version":null,"openapi":"/openapi.json get /articles/{id}/translations/{language}","href":"/api-reference/articles/get-a-translation"},{"title":"Update a translation","deprecated":null,"version":null,"openapi":"/openapi.json patch /articles/{id}/translations/{language}","href":"/api-reference/articles/update-a-translation"},{"title":"Delete a translation","deprecated":null,"version":null,"openapi":"/openapi.json delete /articles/{id}/translations/{language}","href":"/api-reference/articles/delete-a-translation"},{"title":"List tags on an article","deprecated":null,"version":null,"openapi":"/openapi.json get /articles/{id}/tags","href":"/api-reference/articles/list-tags-on-an-article"},{"title":"Replace the set of tag assignments on an article","deprecated":null,"version":null,"openapi":"/openapi.json put /articles/{id}/tags","href":"/api-reference/articles/replace-the-set-of-tag-assignments-on-an-article"},{"title":"List related articles","deprecated":null,"version":null,"openapi":"/openapi.json get /articles/{id}/relations","href":"/api-reference/articles/list-related-articles"},{"title":"Add a related article","deprecated":null,"version":null,"openapi":"/openapi.json post /articles/{id}/relations","href":"/api-reference/articles/add-a-related-article"},{"title":"Set related articles (bulk)","deprecated":null,"version":null,"openapi":"/openapi.json put /articles/{id}/relations","href":"/api-reference/articles/set-related-articles-bulk"},{"title":"Remove a related-article link","deprecated":null,"version":null,"openapi":"/openapi.json delete /articles/{id}/relations/{relatedId}","href":"/api-reference/articles/remove-a-related-article-link"},{"title":"List an article's retrieval chunks","deprecated":null,"version":null,"openapi":"/openapi.json get /articles/{id}/chunks","href":"/api-reference/articles/list-an-articles-retrieval-chunks"},{"title":"Preview how a body would be chunked","deprecated":null,"version":null,"openapi":"/openapi.json post /articles/chunk-preview","href":"/api-reference/articles/preview-how-a-body-would-be-chunked"}]}]},{"group":"Article Categories","pages":[{"title":"Article Categories","href":"/article-categories/overview"},{"title":"The category object","href":"/article-categories/object"},{"group":"Endpoints","pages":[{"title":"Create an article category","deprecated":null,"version":null,"openapi":"/openapi.json post /article-categories","href":"/api-reference/article-categories/create-an-article-category"},{"title":"List article categories","deprecated":null,"version":null,"openapi":"/openapi.json get /article-categories","href":"/api-reference/article-categories/list-article-categories"},{"title":"Get an article category","deprecated":null,"version":null,"openapi":"/openapi.json get /article-categories/{id}","href":"/api-reference/article-categories/get-an-article-category"},{"title":"Update an article category","deprecated":null,"version":null,"openapi":"/openapi.json patch /article-categories/{id}","href":"/api-reference/article-categories/update-an-article-category"},{"title":"Delete an article category","deprecated":null,"version":null,"openapi":"/openapi.json delete /article-categories/{id}","href":"/api-reference/article-categories/delete-an-article-category"}]}]},{"group":"Article Tags","pages":[{"title":"Article Tags","href":"/article-tags/overview"},{"group":"Endpoints","pages":[{"title":"Create an article tag","deprecated":null,"version":null,"openapi":"/openapi.json post /article-tags","href":"/api-reference/article-tags/create-an-article-tag"},{"title":"List article tags","deprecated":null,"version":null,"openapi":"/openapi.json get /article-tags","href":"/api-reference/article-tags/list-article-tags"},{"title":"Delete an article tag","deprecated":null,"version":null,"openapi":"/openapi.json delete /article-tags/{id}","href":"/api-reference/article-tags/delete-an-article-tag"}]}]},{"group":"Knowledge Bases","pages":[{"title":"Knowledge Bases","href":"/knowledge-bases/overview"},{"title":"The knowledge base object","href":"/knowledge-bases/object"},{"group":"Endpoints","pages":[{"title":"List knowledge bases","deprecated":null,"version":null,"openapi":"/openapi.json get /knowledge-bases","href":"/api-reference/knowledge-bases/list-knowledge-bases"},{"title":"Get a knowledge base","deprecated":null,"version":null,"openapi":"/openapi.json get /knowledge-bases/{id}","href":"/api-reference/knowledge-bases/get-a-knowledge-base"}]}]},{"group":"Conversations","pages":[{"title":"Conversations","sidebarTitle":"Overview","href":"/conversations/overview"},{"title":"The Conversation object","sidebarTitle":"Object","href":"/conversations/object"},{"title":"Posting agent replies","sidebarTitle":"Agent replies","href":"/conversations/agent-replies"},{"title":"Conversation lifecycle","sidebarTitle":"Lifecycle","href":"/conversations/lifecycle"},{"group":"Endpoints","pages":[{"title":"List conversations","deprecated":null,"version":null,"openapi":"/openapi.json get /conversations","href":"/api-reference/conversations/list-conversations"},{"title":"Get a conversation","deprecated":null,"version":null,"openapi":"/openapi.json get /conversations/{id}","href":"/api-reference/conversations/get-a-conversation"},{"title":"Update a conversation","deprecated":null,"version":null,"openapi":"/openapi.json patch /conversations/{id}","href":"/api-reference/conversations/update-a-conversation"},{"title":"List messages in a conversation","deprecated":null,"version":null,"openapi":"/openapi.json get /conversations/{id}/messages","href":"/api-reference/conversations/list-messages-in-a-conversation"},{"title":"Send an agent message (human-takeover only)","deprecated":null,"version":null,"openapi":"/openapi.json post /conversations/{id}/messages","href":"/api-reference/conversations/send-an-agent-message-human-takeover-only"},{"title":"List internal notes on a conversation","deprecated":null,"version":null,"openapi":"/openapi.json get /conversations/{id}/notes","href":"/api-reference/conversations/list-internal-notes-on-a-conversation"},{"title":"Add an internal note to a conversation","deprecated":null,"version":null,"openapi":"/openapi.json post /conversations/{id}/notes","href":"/api-reference/conversations/add-an-internal-note-to-a-conversation"},{"title":"List tags assigned to a conversation","deprecated":null,"version":null,"openapi":"/openapi.json get /conversations/{id}/tags","href":"/api-reference/conversations/list-tags-assigned-to-a-conversation"},{"title":"Replace the full set of tag assignments","deprecated":null,"version":null,"openapi":"/openapi.json put /conversations/{id}/tags","href":"/api-reference/conversations/replace-the-full-set-of-tag-assignments"}]}]},{"group":"Conversation Tags","pages":[{"title":"Conversation Tags","sidebarTitle":"Overview","href":"/conversation-tags/overview"},{"group":"Endpoints","pages":[{"title":"Create a conversation tag","deprecated":null,"version":null,"openapi":"/openapi.json post /conversation-tags","href":"/api-reference/conversation-tags/create-a-conversation-tag"},{"title":"List conversation tags","deprecated":null,"version":null,"openapi":"/openapi.json get /conversation-tags","href":"/api-reference/conversation-tags/list-conversation-tags"},{"title":"Delete a conversation tag","deprecated":null,"version":null,"openapi":"/openapi.json delete /conversation-tags/{id}","href":"/api-reference/conversation-tags/delete-a-conversation-tag"}]}]},{"group":"Submissions","pages":[{"title":"Submissions","sidebarTitle":"Overview","href":"/submissions/overview"},{"title":"The Submission object","sidebarTitle":"Object","href":"/submissions/object"},{"group":"Endpoints","pages":[{"title":"List form submissions","deprecated":null,"version":null,"openapi":"/openapi.json get /submissions","href":"/api-reference/submissions/list-form-submissions"},{"title":"Get a submission","deprecated":null,"version":null,"openapi":"/openapi.json get /submissions/{id}","href":"/api-reference/submissions/get-a-submission"},{"title":"Update a submission","deprecated":null,"version":null,"openapi":"/openapi.json patch /submissions/{id}","href":"/api-reference/submissions/update-a-submission"},{"title":"Get a submission's activity timeline","deprecated":null,"version":null,"openapi":"/openapi.json get /submissions/{id}/events","href":"/api-reference/submissions/get-a-submissions-activity-timeline"}]}]},{"group":"Pages","pages":[{"title":"Pages","sidebarTitle":"Overview","href":"/pages/overview"},{"title":"The Page object","sidebarTitle":"Object","href":"/pages/object"},{"title":"Page blocks","sidebarTitle":"Blocks","description":"The block envelope and the config shape for every block type.","href":"/pages/blocks"},{"group":"Endpoints","pages":[{"title":"List pages","deprecated":null,"version":null,"openapi":"/openapi.json get /pages","href":"/api-reference/pages/list-pages"},{"title":"Get a page","description":"Returns the page metadata plus its ordered `blocks` array. Each block's `config` shape depends on its `type` (26+ block variants).","deprecated":null,"version":null,"openapi":"/openapi.json get /pages/{id}","href":"/api-reference/pages/get-a-page"}]}]},{"group":"QR Codes","pages":[{"title":"QR Codes","sidebarTitle":"Overview","href":"/qr-codes/overview"},{"title":"The QR Code object","sidebarTitle":"Object","href":"/qr-codes/object"},{"group":"Endpoints","pages":[{"title":"List QR codes","deprecated":null,"version":null,"openapi":"/openapi.json get /qr-codes","href":"/api-reference/qr-codes/list-qr-codes"},{"title":"Get a QR code","deprecated":null,"version":null,"openapi":"/openapi.json get /qr-codes/{id}","href":"/api-reference/qr-codes/get-a-qr-code"},{"title":"Update a QR code","deprecated":null,"version":null,"openapi":"/openapi.json patch /qr-codes/{id}","href":"/api-reference/qr-codes/update-a-qr-code"},{"title":"Render a QR code image","deprecated":null,"version":null,"openapi":"/openapi.json get /qr-codes/{id}/image","href":"/api-reference/qr-codes/render-a-qr-code-image"},{"title":"List QR code properties","deprecated":null,"version":null,"openapi":"/openapi.json get /qr-codes/{id}/properties","href":"/api-reference/qr-codes/list-qr-code-properties"},{"title":"Replace QR code properties","deprecated":null,"version":null,"openapi":"/openapi.json put /qr-codes/{id}/properties","href":"/api-reference/qr-codes/replace-qr-code-properties"},{"title":"List QR code URL params","deprecated":null,"version":null,"openapi":"/openapi.json get /qr-codes/{id}/url-params","href":"/api-reference/qr-codes/list-qr-code-url-params"},{"title":"Replace QR code URL params","deprecated":null,"version":null,"openapi":"/openapi.json put /qr-codes/{id}/url-params","href":"/api-reference/qr-codes/replace-qr-code-url-params"},{"title":"List QR code scans","deprecated":null,"version":null,"openapi":"/openapi.json get /qr-codes/{id}/scans","href":"/api-reference/qr-codes/list-qr-code-scans"}]}]},{"group":"QR Groups","pages":[{"title":"QR Groups","sidebarTitle":"Overview","href":"/qr-groups/overview"},{"title":"The QR Group object","sidebarTitle":"Object","href":"/qr-groups/object"},{"group":"Endpoints","pages":[{"title":"Create a QR group","deprecated":null,"version":null,"openapi":"/openapi.json post /qr-groups","href":"/api-reference/qr-groups/create-a-qr-group"},{"title":"List QR groups","deprecated":null,"version":null,"openapi":"/openapi.json get /qr-groups","href":"/api-reference/qr-groups/list-qr-groups"},{"title":"Get a QR group","deprecated":null,"version":null,"openapi":"/openapi.json get /qr-groups/{id}","href":"/api-reference/qr-groups/get-a-qr-group"},{"title":"Update a QR group","deprecated":null,"version":null,"openapi":"/openapi.json patch /qr-groups/{id}","href":"/api-reference/qr-groups/update-a-qr-group"},{"title":"Delete a QR group","deprecated":null,"version":null,"openapi":"/openapi.json delete /qr-groups/{id}","href":"/api-reference/qr-groups/delete-a-qr-group"},{"title":"List QR group properties","deprecated":null,"version":null,"openapi":"/openapi.json get /qr-groups/{id}/properties","href":"/api-reference/qr-groups/list-qr-group-properties"},{"title":"Replace QR group properties","deprecated":null,"version":null,"openapi":"/openapi.json put /qr-groups/{id}/properties","href":"/api-reference/qr-groups/replace-qr-group-properties"}]}]},{"group":"Products","pages":[{"title":"Products","sidebarTitle":"Overview","href":"/products/overview"},{"title":"The Product object","sidebarTitle":"Object","href":"/products/object"},{"group":"Endpoints","pages":[{"title":"Create a product","deprecated":null,"version":null,"openapi":"/openapi.json post /products","href":"/api-reference/products/create-a-product"},{"title":"List products","deprecated":null,"version":null,"openapi":"/openapi.json get /products","href":"/api-reference/products/list-products"},{"title":"Get a product","deprecated":null,"version":null,"openapi":"/openapi.json get /products/{id}","href":"/api-reference/products/get-a-product"},{"title":"Update a product","deprecated":null,"version":null,"openapi":"/openapi.json patch /products/{id}","href":"/api-reference/products/update-a-product"},{"title":"Delete a product","deprecated":null,"version":null,"openapi":"/openapi.json delete /products/{id}","href":"/api-reference/products/delete-a-product"},{"title":"Lookup a product by GTIN","deprecated":null,"version":null,"openapi":"/openapi.json get /products/by-gtin/{gtin}","href":"/api-reference/products/lookup-a-product-by-gtin"},{"title":"List product properties","deprecated":null,"version":null,"openapi":"/openapi.json get /products/{id}/properties","href":"/api-reference/products/list-product-properties"},{"title":"Replace product properties","deprecated":null,"version":null,"openapi":"/openapi.json put /products/{id}/properties","href":"/api-reference/products/replace-product-properties"},{"title":"List product images","deprecated":null,"version":null,"openapi":"/openapi.json get /products/{id}/images","href":"/api-reference/products/list-product-images"},{"title":"Attach a product image by URL","deprecated":null,"version":null,"openapi":"/openapi.json post /products/{id}/images","href":"/api-reference/products/attach-a-product-image-by-url"},{"title":"Delete a product image","deprecated":null,"version":null,"openapi":"/openapi.json delete /products/{id}/images/{imageId}","href":"/api-reference/products/delete-a-product-image"}]}]},{"group":"Objects","pages":[{"title":"Objects","href":"/objects/overview"},{"title":"The Object object","href":"/objects/object"},{"title":"Examples","href":"/objects/examples"},{"group":"Endpoints","pages":[{"title":"Create or upsert an object","deprecated":null,"version":null,"openapi":"/openapi.json post /objects","href":"/api-reference/objects/create-or-upsert-an-object"},{"title":"List objects","deprecated":null,"version":null,"openapi":"/openapi.json get /objects","href":"/api-reference/objects/list-objects"},{"title":"Get an object","deprecated":null,"version":null,"openapi":"/openapi.json get /objects/{id}","href":"/api-reference/objects/get-an-object"},{"title":"Update an object","deprecated":null,"version":null,"openapi":"/openapi.json patch /objects/{id}","href":"/api-reference/objects/update-an-object"},{"title":"Delete an object","deprecated":null,"version":null,"openapi":"/openapi.json delete /objects/{id}","href":"/api-reference/objects/delete-an-object"},{"title":"List object properties","deprecated":null,"version":null,"openapi":"/openapi.json get /objects/{id}/properties","href":"/api-reference/objects/list-object-properties"},{"title":"Replace object properties","deprecated":null,"version":null,"openapi":"/openapi.json put /objects/{id}/properties","href":"/api-reference/objects/replace-object-properties"},{"title":"List object URL params","deprecated":null,"version":null,"openapi":"/openapi.json get /objects/{id}/url-params","href":"/api-reference/objects/list-object-url-params"},{"title":"Replace object URL params","deprecated":null,"version":null,"openapi":"/openapi.json put /objects/{id}/url-params","href":"/api-reference/objects/replace-object-url-params"}]}]},{"group":"Custom Domains","pages":[{"title":"Custom Domains","sidebarTitle":"Overview","href":"/custom-domains/overview"},{"title":"The Custom Domain object","sidebarTitle":"Object","href":"/custom-domains/object"},{"title":"DNS verification","href":"/custom-domains/verification"},{"group":"Endpoints","pages":[{"title":"Connect a custom domain","deprecated":null,"version":null,"openapi":"/openapi.json post /custom-domains","href":"/api-reference/custom-domains/connect-a-custom-domain"},{"title":"List custom domains","deprecated":null,"version":null,"openapi":"/openapi.json get /custom-domains","href":"/api-reference/custom-domains/list-custom-domains"},{"title":"Get a custom domain","deprecated":null,"version":null,"openapi":"/openapi.json get /custom-domains/{id}","href":"/api-reference/custom-domains/get-a-custom-domain"},{"title":"Delete a custom domain","deprecated":null,"version":null,"openapi":"/openapi.json delete /custom-domains/{id}","href":"/api-reference/custom-domains/delete-a-custom-domain"},{"title":"Re-check verification","deprecated":null,"version":null,"openapi":"/openapi.json post /custom-domains/{id}/verify","href":"/api-reference/custom-domains/re-check-verification"}]}]},{"group":"Custom Domain Routes","pages":[{"title":"Custom Domain Routes","sidebarTitle":"Overview","href":"/custom-domain-routes/overview"},{"title":"The Custom Domain Route object","sidebarTitle":"Object","href":"/custom-domain-routes/object"},{"group":"Endpoints","pages":[{"title":"Create a route","deprecated":null,"version":null,"openapi":"/openapi.json post /custom-domain-routes","href":"/api-reference/custom-domain-routes/create-a-route"},{"title":"List routes for a domain","deprecated":null,"version":null,"openapi":"/openapi.json get /custom-domain-routes","href":"/api-reference/custom-domain-routes/list-routes-for-a-domain"},{"title":"Get a route","deprecated":null,"version":null,"openapi":"/openapi.json get /custom-domain-routes/{id}","href":"/api-reference/custom-domain-routes/get-a-route"},{"title":"Update a route","deprecated":null,"version":null,"openapi":"/openapi.json patch /custom-domain-routes/{id}","href":"/api-reference/custom-domain-routes/update-a-route"},{"title":"Delete a route","deprecated":null,"version":null,"openapi":"/openapi.json delete /custom-domain-routes/{id}","href":"/api-reference/custom-domain-routes/delete-a-route"}]}]},{"group":"Team","pages":[{"title":"Team","href":"/team/overview"},{"title":"Members","href":"/team/members"},{"title":"Invitations","href":"/team/invitations"},{"group":"Endpoints","pages":[{"title":"List members","deprecated":null,"version":null,"openapi":"/openapi.json get /team/members","href":"/api-reference/team/list-members"},{"title":"Get a member","deprecated":null,"version":null,"openapi":"/openapi.json get /team/members/{id}","href":"/api-reference/team/get-a-member"},{"title":"Change a member's role","deprecated":null,"version":null,"openapi":"/openapi.json patch /team/members/{id}","href":"/api-reference/team/change-a-members-role"},{"title":"Remove a member","deprecated":null,"version":null,"openapi":"/openapi.json delete /team/members/{id}","href":"/api-reference/team/remove-a-member"},{"title":"List pending invitations","deprecated":null,"version":null,"openapi":"/openapi.json get /team/invitations","href":"/api-reference/team/list-pending-invitations"},{"title":"Create an invitation","deprecated":null,"version":null,"openapi":"/openapi.json post /team/invitations","href":"/api-reference/team/create-an-invitation"},{"title":"Get an invitation","deprecated":null,"version":null,"openapi":"/openapi.json get /team/invitations/{id}","href":"/api-reference/team/get-an-invitation"},{"title":"Revoke an invitation","deprecated":null,"version":null,"openapi":"/openapi.json delete /team/invitations/{id}","href":"/api-reference/team/revoke-an-invitation"}]}]}]},"title":"List pages - Awardee API Docs","buildId":"dpl_EnxDqhjaNc9a8MVa833TGULPd9uJ","deploymentId":"dpl_EnxDqhjaNc9a8MVa833TGULPd9uJ","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-26-lDe7V.js","utils-CWQmgYtH.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-4-Aw3rSD.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-C2zjXYA5.js","snippetPresets-DFmpFA7C.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","ApiExamples-FJpQavWq.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-D_GvPF7k.js","shallow-Bs2ZB0NO.js","getApiPlaygroundDisplay-DCcqJJk-.js","CodeSnippet-DzDxawVe.js","CodeSnippets-aUr7fU-7.js","Page-CT9uE8Ip.js","getPastedJson-Y1fKsj_I.js","icon-DI4zTsDr.js","MethodPill-C0nDlmSQ.js","DuplicateIcon-NUXbx2nQ.js","createIcon-BdTHrPAi.js","DynamicMarkdown-CtpgKJwj.js","SectionHeading-B3x35tOt.js","axios-vUo_bRtp.js","Markdown-3OmurJMP.js","clsx-DMKzROTp.js","lib-DuNMoZ05.js","lib-B8HbPgcC.js","html-void-elements-mCSPHezU.js","dist-1ms6tsT-.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","AssistantPageLink-Ke9xIMFx.js"]}