Page through list endpoints with limit and offset.
List endpoints return a page of items plus a continuation flag:
{ "data": [ /* items */ ], "hasMore": true }
Pass limit (page size) and offset (zero-based) in the JSON body. When
hasMore is true, request the next page with offset increased by the
number of items returned.
{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"Breakroom Open API","colors":{"primary":"#5E57F2","light":"#4DA9FF","dark":"#262456"},"logo":{"light":"https://mintcdn.com/breakroom/mtdy7-sZrdorrRlb/logo/light.svg?fit=max\u0026auto=format\u0026n=mtdy7-sZrdorrRlb\u0026q=85\u0026s=6d63247a9afa74babfe9bff20b340580","dark":"https://mintcdn.com/breakroom/mtdy7-sZrdorrRlb/logo/dark.svg?fit=max\u0026auto=format\u0026n=mtdy7-sZrdorrRlb\u0026q=85\u0026s=1105e8c4cb71afd6c83f84cf2783a6dd"},"favicon":"https://mintcdn.com/breakroom/mtdy7-sZrdorrRlb/favicon.svg?fit=max\u0026auto=format\u0026n=mtdy7-sZrdorrRlb\u0026q=85\u0026s=540bd4fa6b0ab4b601d57dbe18d7dc1e","api":{"mdx":{"auth":{"method":"bearer"},"server":"https://api.breakroomapp.com/functions/v1"}},"appearance":{"default":"light","strict":true},"navbar":{"links":[{"href":"https://www.breakroomapp.com","label":"Breakroom"}]},"contextual":{"options":["copy","view","chatgpt","claude","perplexity","mcp","cursor","vscode"],"display":"header"},"styling":{"latex":false},"navigation":{"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"breakroom","hasAudioNarration":false,"actualSubdomain":"breakroom","customDomains":["docs.breakroomapp.com"],"gitSource":{"type":"github","owner":"johto-breakroom","repo":"breakroom-docs","deployBranch":"main","contentDirectory":"","isPrivate":true,"mountPath":"","label":"","_id":"6ae7f4fe034da7e3c6310108"},"chroma":{"latestBuiltDeploymentHistoryId":"6ae7fb37348e269909a7bb15","collectionId":"b6ecfe4a-210b-404c-9002-8cc640eea01b","liveDeploymentHistoryId":"6ae7fb37348e269909a7bb15","schemaVersion":"v3"},"entitlements":{"AI_CHAT":{"status":"ENABLED"},"WEB_MCP":{"status":"ENABLED"},"NARRATION":{"status":"ENABLED"}},"buildId":"6aead68bc7293b824be4ec7a","clientVersion":"0.0.4054","searchFilterCounts":[{"language":"default","tag":"API Reference","count":7},{"language":"default","tag":"Webhooks","count":7},{"language":"default","tag":"Guides","count":6},{"language":"default","tag":"Time Off Events","count":5},{"language":"default","tag":"Getting started","count":4},{"language":"default","tag":"Conversations","count":1},{"language":"default","tag":"Time off","count":1}]},"assistantConfig":{"enableAskAiButton":false,"enableStarterQuestions":false,"enableContextualStarterQuestions":false,"enableAskAiSearchBar":true},"basePath":"","hasChatPermissions":false,"hasWebMcpPermissions":true,"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":"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":"llms-txt-v2","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":"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":"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":"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}],"googleFontsInlined":false},"customCss":[],"page":{"pagePath":"guides/pagination","slug":"/guides/pagination","pageMetadata":{"title":"Pagination","description":"Page through list endpoints with limit and offset.","href":"/guides/pagination"},"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: \"Page through list endpoints with limit and offset.\"\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`,..._provideComponents(),...props.components},{CodeBlock}=_components;if(!CodeBlock)_missingMdxReference(`CodeBlock`,true);return _jsxs(_Fragment,{children:[_jsx(_components.p,{children:`List endpoints return a page of items plus a continuation flag:`}),`\n`,_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:`\"data\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: [ `}),_jsx(_components.span,{style:{color:`#6E7781`,\"--shiki-dark\":`#6A9955`},children:`/* items */`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` ], `}),_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:`\"hasMore\"`}),_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`]})})}),`\n`,_jsxs(_components.p,{children:[`Pass `,_jsx(_components.code,{children:`limit`}),` (page size) and `,_jsx(_components.code,{children:`offset`}),` (zero-based) in the JSON body. When\n`,_jsx(_components.code,{children:`hasMore`}),` is `,_jsx(_components.code,{children:`true`}),`, request the next page with `,_jsx(_components.code,{children:`offset`}),` increased by the\nnumber of items returned.`]})]})}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":{"config":{},"pageMetadata":{"title":"Pagination","description":"Page through list endpoints with limit and offset.","href":"/guides/pagination"}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":[],"subdomain":"breakroom","siteName":"Breakroom Open API","title":"Pagination - Breakroom Open API","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-11-02T02:47:05.236Z","originalFileLocation":"guides/pagination.mdx"},"headHtml":"\u003cscript data-mint-head>(function(){var d=document.documentElement,p=\"light\";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=\"Page through list endpoints with limit and offset.\">\u003cmeta data-mint-head name=\"application-name\" content=\"Breakroom Open API\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/breakroom/C91_-Vecmbn2h6-V/_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/breakroom/C91_-Vecmbn2h6-V/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/breakroom/C91_-Vecmbn2h6-V/_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/breakroom/C91_-Vecmbn2h6-V/_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/breakroom/C91_-Vecmbn2h6-V/_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/breakroom/C91_-Vecmbn2h6-V/_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/breakroom/C91_-Vecmbn2h6-V/_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/breakroom/C91_-Vecmbn2h6-V/_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/breakroom/C91_-Vecmbn2h6-V/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Pagination - Breakroom Open API\">\u003cmeta data-mint-head property=\"og:description\" content=\"Page through list endpoints with limit and offset.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Breakroom Open API\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.breakroomapp.com/guides/pagination\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://breakroom.mintlify.app/_mintlify/api/og/v2?division=Getting+started\u0026amp;title=Pagination\u0026amp;description=Page+through+list+endpoints+with+limit+and+offset.\u0026amp;theme=9f101094800a0fdef0d11a23\u0026amp;signature=a92d29cde876736149d4826888130378fcd3b5acb960b3997a47a5fe31d9d4d9\">\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=\"Pagination - Breakroom Open API\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Page through list endpoints with limit and offset.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://breakroom.mintlify.app/_mintlify/api/og/v2?division=Getting+started\u0026amp;title=Pagination\u0026amp;description=Page+through+list+endpoints+with+limit+and+offset.\u0026amp;theme=9f101094800a0fdef0d11a23\u0026amp;signature=a92d29cde876736149d4826888130378fcd3b5acb960b3997a47a5fe31d9d4d9\">\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/breakroom/C91_-Vecmbn2h6-V/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Breakroom Open API\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#5E57F2\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.breakroomapp.com/guides/pagination\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/guides/pagination.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.breakroomapp.com/#organization\",\"name\":\"Breakroom Open API\",\"url\":\"https://docs.breakroomapp.com\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/breakroom/mtdy7-sZrdorrRlb/logo/light.svg?fit=max\u0026auto=format\u0026n=mtdy7-sZrdorrRlb\u0026q=85\u0026s=6d63247a9afa74babfe9bff20b340580\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.breakroomapp.com#website\",\"name\":\"Breakroom Open API\",\"url\":\"https://docs.breakroomapp.com\",\"publisher\":{\"@id\":\"https://docs.breakroomapp.com/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.breakroomapp.com/guides/pagination#webpage\",\"url\":\"https://docs.breakroomapp.com/guides/pagination\",\"name\":\"Pagination\",\"description\":\"Page through list endpoints with limit and offset.\",\"dateModified\":\"2026-11-02T02:47:05.236Z\",\"isPartOf\":{\"@id\":\"https://docs.breakroomapp.com#website\"},\"breadcrumb\":{\"@id\":\"https://docs.breakroomapp.com/guides/pagination#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.breakroomapp.com/guides/pagination#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Getting started\",\"item\":\"https://docs.breakroomapp.com/guides/overview\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Pagination\",\"item\":\"https://docs.breakroomapp.com/guides/pagination\"}]},{\"@type\":[\"Article\",\"TechArticle\"],\"@id\":\"https://docs.breakroomapp.com/guides/pagination#article\",\"headline\":\"Pagination\",\"name\":\"Pagination\",\"description\":\"Page through list endpoints with limit and offset.\",\"url\":\"https://docs.breakroomapp.com/guides/pagination\",\"mainEntityOfPage\":{\"@id\":\"https://docs.breakroomapp.com/guides/pagination#webpage\"},\"dateModified\":\"2026-11-02T02:47:05.236Z\",\"publisher\":{\"@id\":\"https://docs.breakroomapp.com/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.breakroomapp.com#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Breakroom Open API\",\"creator\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","siteName":"Breakroom Open API","nav":{"global":null,"tabs":[{"tab":"Guides","groups":[{"group":"Getting started","pages":[{"title":"Overview","href":"/guides/overview"},{"title":"Authentication","href":"/guides/authentication"},{"title":"Errors","description":"Shared error body and common status codes.","href":"/guides/errors"},{"title":"Pagination","href":"/guides/pagination"}]},{"group":"Webhooks","pages":[{"title":"Overview","description":"How Breakroom delivers webhook events to your endpoint.","href":"/guides/webhooks/overview"},{"title":"Time off webhook","href":"/guides/webhooks/time-off"}]}]},{"tab":"API Reference","pages":[{"title":"API Reference","href":"/api-reference/conversations/get-member-messages"}]}]},"basePath":"","title":"Pagination - Breakroom Open API","buildId":"dpl_345ReqzYaAjzS9QpeJemsKdb7KDj","deploymentId":"dpl_345ReqzYaAjzS9QpeJemsKdb7KDj","dynamics":[],"chunks":[]}