{"_id":"553591ce63cc650d00312930","__v":13,"category":{"_id":"553591cd63cc650d00312926","__v":1,"pages":["553591ce63cc650d00312929","553591ce63cc650d0031292a","553591ce63cc650d0031292b","553591ce63cc650d0031292c","553591ce63cc650d0031292d","553591ce63cc650d0031292e","553591ce63cc650d0031292f","553591ce63cc650d00312930"],"project":"55357364e02d480d0003c6d3","version":"553591cd63cc650d00312925","sync":{"url":"","isSync":false},"reference":false,"createdAt":"2015-04-20T21:45:09.762Z","from_sync":false,"order":0,"slug":"api","title":"API"},"user":"55356ede6040a20d00454508","version":{"_id":"553591cd63cc650d00312925","project":"55357364e02d480d0003c6d3","__v":13,"forked_from":"55357365e02d480d0003c6d6","createdAt":"2015-04-20T23:54:53.134Z","releaseDate":"2015-04-20T23:54:53.134Z","categories":["553591cd63cc650d00312926","553591cd63cc650d00312927","5536e4d39f7f2d0d00b1cd54","5536e55c20d5ca0d0001580a","5536e6bf7fe60f0d000fd1c0","5536f5bba171250d00c00556","553a974369c2630d00a8562e","553a97c60074c80d00621c2a","553a98332af5f20d000fc32a","553a9b9869c2630d00a85642","556e0f23d02e0b190042f13d","563249b1dcc27a1700823650","5639113f049e420d00476b03","59a5dd94aaa11d003334edb4"],"is_deprecated":false,"is_hidden":false,"is_beta":false,"is_stable":true,"codename":"","version_clean":"2.0.0","version":"2"},"project":"55357364e02d480d0003c6d3","parentDoc":null,"updates":[],"next":{"pages":[],"description":""},"createdAt":"2015-04-20T23:46:23.752Z","link_external":false,"link_url":"","githubsync":"","sync_unique":"","hidden":false,"api":{"settings":"","results":{"codes":[]},"auth":"required","params":[],"url":""},"isReference":false,"order":6,"body":"Requests for lists of items are paged to minimize response sizes.\n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"Page Size\"\n}\n[/block]\nBy default, the API only shows 25 items per page.  This value can be adjusted by setting the `?pageSize`, query parameter.  The maximum value for this parameter is 100 items per page.\n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"Getting the further results (Page Number)\"\n}\n[/block]\nYou can request subsequent items on requesting a different page using the `?pageNumber`, query string parameter.\n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"Navigating the pages\"\n}\n[/block]\nNavigation can be achieved by reading the Link Headers provided in the response.  There can be up to 4 links (first, previous, next, last).\n\nSample Link Header in Response:\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"{\\n\\\"link\\\": \\\"<https://api.goformz.com/v2/formz?pageNumber=1&pageSize=25>; rel=\\\\\\\"first\\\\\\\", <https://api.goformz.com/v2/formz?pageNumber=1&pageSize=25>; rel=\\\\\\\"previous\\\\\\\", <https://api.goformz.com/v2/formz?pageNumber=3&pageSize=25>; rel=\\\\\\\"next\\\\\\\", <https://api.goformz.com/v2/formz?pageNumber=4&pageSize=25>; rel=\\\\\\\"last\\\\\\\"\\\"\\n}\",\n      \"language\": \"http\"\n    }\n  ]\n}\n[/block]\nSample Response Header including Link Headers:\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \" {\\n   \\\"pragma\\\": \\\"no-cache\\\",\\n   \\\"date\\\": \\\"Thu, 09 Apr 2015 16:39:56 GMT\\\",\\n   \\\"content-type\\\": \\\"application/json; charset=utf-8\\\",\\n   \\\"cache-control\\\": \\\"no-cache\\\",\\n   \\\"link\\\": \\\"<https://api.goformz.com/v2/formz?pageNumber=1&pageSize=25>; rel=\\\\\\\"first\\\\\\\", <https://api.goformz.com/v2/formz?pageNumber=1&pageSize=25>; rel=\\\\\\\"previous\\\\\\\", <https://api.goformz.com/v2/formz?pageNumber=3&pageSize=25>; rel=\\\\\\\"next\\\\\\\", <https://api.goformz.com/v2/formz?pageNumber=4&pageSize=25>; rel=\\\\\\\"last\\\\\\\"\\\",\\n   \\\"content-length\\\": \\\"100\\\",\\n   \\\"x-total-count\\\": \\\"\\\",\\n   \\\"expires\\\": \\\"-1\\\"\\n }\",\n      \"language\": \"http\"\n    }\n  ]\n}\n[/block]\n\n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"Total Count\"\n}\n[/block]\nThe total number of results for the specified query parameters is provided in the form of a custom header.\n\nSample Total Count Header:\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"{\\n\\\"x-total-count\\\": 737\\n}\",\n      \"language\": \"http\"\n    }\n  ]\n}\n[/block]","excerpt":"","slug":"pagination","type":"basic","title":"Pagination"}
Requests for lists of items are paged to minimize response sizes. [block:api-header] { "type": "basic", "title": "Page Size" } [/block] By default, the API only shows 25 items per page. This value can be adjusted by setting the `?pageSize`, query parameter. The maximum value for this parameter is 100 items per page. [block:api-header] { "type": "basic", "title": "Getting the further results (Page Number)" } [/block] You can request subsequent items on requesting a different page using the `?pageNumber`, query string parameter. [block:api-header] { "type": "basic", "title": "Navigating the pages" } [/block] Navigation can be achieved by reading the Link Headers provided in the response. There can be up to 4 links (first, previous, next, last). Sample Link Header in Response: [block:code] { "codes": [ { "code": "{\n\"link\": \"<https://api.goformz.com/v2/formz?pageNumber=1&pageSize=25>; rel=\\\"first\\\", <https://api.goformz.com/v2/formz?pageNumber=1&pageSize=25>; rel=\\\"previous\\\", <https://api.goformz.com/v2/formz?pageNumber=3&pageSize=25>; rel=\\\"next\\\", <https://api.goformz.com/v2/formz?pageNumber=4&pageSize=25>; rel=\\\"last\\\"\"\n}", "language": "http" } ] } [/block] Sample Response Header including Link Headers: [block:code] { "codes": [ { "code": " {\n \"pragma\": \"no-cache\",\n \"date\": \"Thu, 09 Apr 2015 16:39:56 GMT\",\n \"content-type\": \"application/json; charset=utf-8\",\n \"cache-control\": \"no-cache\",\n \"link\": \"<https://api.goformz.com/v2/formz?pageNumber=1&pageSize=25>; rel=\\\"first\\\", <https://api.goformz.com/v2/formz?pageNumber=1&pageSize=25>; rel=\\\"previous\\\", <https://api.goformz.com/v2/formz?pageNumber=3&pageSize=25>; rel=\\\"next\\\", <https://api.goformz.com/v2/formz?pageNumber=4&pageSize=25>; rel=\\\"last\\\"\",\n \"content-length\": \"100\",\n \"x-total-count\": \"\",\n \"expires\": \"-1\"\n }", "language": "http" } ] } [/block] [block:api-header] { "type": "basic", "title": "Total Count" } [/block] The total number of results for the specified query parameters is provided in the form of a custom header. Sample Total Count Header: [block:code] { "codes": [ { "code": "{\n\"x-total-count\": 737\n}", "language": "http" } ] } [/block]