{"templateId":"markdown","sharedDataIds":{"sidebar":"sidebar-rest/sidebars.yaml"},"props":{"metadata":{"markdoc":{"tagList":[]},"type":"markdown"},"seo":{"title":"Pagination","llmstxt":{"hide":false,"sections":[{"title":"Table of contents","includeFiles":["**/*"],"excludeFiles":[]}],"excludeFiles":[]}},"dynamicMarkdocComponents":[],"compilationErrors":[],"ast":{"$$mdtype":"Tag","name":"article","attributes":{},"children":[{"$$mdtype":"Tag","name":"Heading","attributes":{"level":1,"id":"pagination","__idx":0},"children":["Pagination"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["All endpoints that return large result sets will support pagination. The ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["pageSize"]}," and ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["pageNumber"]}," parameters will be used for these endpoints. For example, if you want the next batch of items the url would look like this: ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["https://fetch.yellowdogsoftware.com/api/v3/items?pageNumber=2&pageSize=100"]}," ","If the endpoint supports pagination the response header will contain the ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["X-Pagination"]}," key. The value of this key will be json which will include the next page link ( ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["nextPageLink"]}," ). If there aren't anymore pages left the ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["nextPageLink"]}," value will be empty."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"example","__idx":1},"children":["Example"]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":4,"id":"additional-pages","__idx":2},"children":["Additional Pages"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"json","header":{"controls":{"copy":{}}},"source":"{\n  \"pageSize\": 100,\n  \"currentPage\": 1,\n  \"currentPageElements\": 100,\n  \"nextPageLink\": \"https://fetch.yellowdogsoftware.com/api/v3/dimensions?pageNumber=2&pageSize=100\"\n}\n","lang":"json"},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":4,"id":"no-additional-pages","__idx":3},"children":["No Additional Pages"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"json","header":{"controls":{"copy":{}}},"source":"{\n\"pageSize\": 100,\n\"currentPage\": 6,\n\"currentPageElements\": 3,\n\"nextPageLink\": \"\"\n}\n","lang":"json"},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"defaults-and-limits","__idx":4},"children":["Defaults and Limits"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["When specified, ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["pageSize"]}," must be greater than zero with a maximum value of ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["500"]},"."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["When not specified, ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["pageSize"]}," will default to ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["100"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["When specified, ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["pageNumber"]}," must be an integer greater than zero."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["If ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["pageNumber"]}," is larger than the number of pages available, the response will be empty."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["When not specified, ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["pageNumber"]}," will default to ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["1"]},"."]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]}]}]},"headings":[{"value":"Pagination","id":"pagination","depth":1},{"value":"Example","id":"example","depth":3},{"value":"Additional Pages","id":"additional-pages","depth":4},{"value":"No Additional Pages","id":"no-additional-pages","depth":4},{"value":"Defaults and Limits","id":"defaults-and-limits","depth":3}],"frontmatter":{"seo":{"title":"Pagination"}},"lastModified":"2026-04-07T19:31:18.000Z","pagePropGetterError":{"message":"","name":""}},"slug":"/rest/user-guide/04-headers-params/pagination","userData":{"isAuthenticated":false,"teams":["anonymous"]},"isPublic":true}