{"_id":"57624356653c2d2200fec7d9","user":"55c8cf9471d7580d0063a5e4","__v":1,"category":{"_id":"57624356653c2d2200fec79d","project":"55c8cff571d7580d0063a5e5","__v":0,"version":"57624356653c2d2200fec79c","sync":{"url":"","isSync":false},"reference":false,"createdAt":"2015-08-10T16:23:18.580Z","from_sync":false,"order":0,"slug":"documentation","title":"Getting Started"},"githubsync":"","parentDoc":null,"project":"55c8cff571d7580d0063a5e5","version":{"_id":"57624356653c2d2200fec79c","__v":21,"project":"55c8cff571d7580d0063a5e5","createdAt":"2016-06-16T06:12:38.244Z","releaseDate":"2016-06-16T06:12:38.244Z","categories":["57624356653c2d2200fec79d","57624356653c2d2200fec79e","57624356653c2d2200fec79f","57624356653c2d2200fec7a0","57624356653c2d2200fec7a1","57624356653c2d2200fec7a2","57624356653c2d2200fec7a3","57624356653c2d2200fec7a4","57624356653c2d2200fec7a5","57624356653c2d2200fec7a6","57624356653c2d2200fec7a7","57624356653c2d2200fec7a8","57624356653c2d2200fec7a9","57624356653c2d2200fec7aa","5779ca1b99b40b0e005abb3a","5779d198aea88b0e00f63277","5797d3ab17ced017003c4be4","57ac170ef1cdae0e0053cdfc","57dbfc723ed3450e00dc9e6d","5804d12d16161c0f0077df9b","5841064b652e5b0f0015a7c8","588b5e5f2966b2230009cbf9","58a68ebf3239fa0f00857619","58c23c8b4922930f0050ac91","58fd1460809fc30f00f2ee07","5934eaf5328680002d77de6a","594bf91601cfe6000f40f4c5","595c4ed696b447001ba0cf6d","596524495cee50001575f5be","5970d4f1313162004dd303b5","59780fac24dbd1001a1fa057","59a8cfd3ead78a002d63cafe","59e0323d93da1f001c9ec170","5b0c16f2be9fcb0003e28222"],"is_deprecated":false,"is_hidden":false,"is_beta":true,"is_stable":true,"codename":"","version_clean":"4.0.0","version":"4"},"updates":[],"next":{"pages":[],"description":""},"createdAt":"2015-08-10T18:52:05.972Z","link_external":false,"link_url":"","sync_unique":"","hidden":false,"api":{"results":{"codes":[]},"settings":"","auth":"required","params":[],"url":""},"isReference":false,"order":4,"body":"Many API services return paginated lists of objects.  We follow a consistent convention for all of our lists, which is compatible with the Mason format.  Following is an example list output:\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"{\\n    \\\"filters\\\": {},\\n    \\\"sort\\\": {},\\n    \\\"total\\\": 42,\\n    \\\"offset\\\": 0,\\n    \\\"limit\\\": 3,\\n    \\\"items\\\": [\\n        {\\n            \\\"id\\\": 123,\\n            \\\"name\\\": \\\"Human\\\"\\n        },\\n        {\\n            \\\"id\\\": 456,\\n            \\\"name\\\": \\\"Vulcan\\\"\\n        },\\n        {\\n            \\\"id\\\": 789,\\n            \\\"name\\\": \\\"Ferengi\\\"\\n        }\\n    ]\\n}\",\n      \"language\": \"json\"\n    }\n  ]\n}\n[/block]\nEach property is defined below.\n[block:parameters]\n{\n  \"data\": {\n    \"0-0\": \"`filters`\",\n    \"h-0\": \"Property\",\n    \"h-1\": \"Data Type\",\n    \"0-1\": \"Object\",\n    \"h-2\": \"Description\",\n    \"0-2\": \"Filter options that were requested, if any. See [List Inputs](doc:list-inputs) for details.\",\n    \"3-0\": \"`offset`\",\n    \"3-1\": \"Integer\",\n    \"3-2\": \"Number of items skipped. See [List Inputs](doc:list-inputs) for details.\",\n    \"4-0\": \"`limit`\",\n    \"4-1\": \"Integer\",\n    \"4-2\": \"Maximum number of items shown in this page of results. See [List Inputs](doc:list-inputs) for details.\",\n    \"5-0\": \"`items`\",\n    \"5-1\": \"Array\",\n    \"5-2\": \"List of objects included in this page of results\",\n    \"2-0\": \"`total`\",\n    \"2-1\": \"Integer\",\n    \"2-2\": \"Grand total of all items found\",\n    \"1-0\": \"`sort`\",\n    \"1-1\": \"Object\",\n    \"1-2\": \"Sorting options that were requested, if any. See [List Inputs](doc:list-inputs) for details.\"\n  },\n  \"cols\": 3,\n  \"rows\": 6\n}\n[/block]","excerpt":"","slug":"list-outputs","type":"basic","title":"List Outputs"}
Many API services return paginated lists of objects. We follow a consistent convention for all of our lists, which is compatible with the Mason format. Following is an example list output: [block:code] { "codes": [ { "code": "{\n \"filters\": {},\n \"sort\": {},\n \"total\": 42,\n \"offset\": 0,\n \"limit\": 3,\n \"items\": [\n {\n \"id\": 123,\n \"name\": \"Human\"\n },\n {\n \"id\": 456,\n \"name\": \"Vulcan\"\n },\n {\n \"id\": 789,\n \"name\": \"Ferengi\"\n }\n ]\n}", "language": "json" } ] } [/block] Each property is defined below. [block:parameters] { "data": { "0-0": "`filters`", "h-0": "Property", "h-1": "Data Type", "0-1": "Object", "h-2": "Description", "0-2": "Filter options that were requested, if any. See [List Inputs](doc:list-inputs) for details.", "3-0": "`offset`", "3-1": "Integer", "3-2": "Number of items skipped. See [List Inputs](doc:list-inputs) for details.", "4-0": "`limit`", "4-1": "Integer", "4-2": "Maximum number of items shown in this page of results. See [List Inputs](doc:list-inputs) for details.", "5-0": "`items`", "5-1": "Array", "5-2": "List of objects included in this page of results", "2-0": "`total`", "2-1": "Integer", "2-2": "Grand total of all items found", "1-0": "`sort`", "1-1": "Object", "1-2": "Sorting options that were requested, if any. See [List Inputs](doc:list-inputs) for details." }, "cols": 3, "rows": 6 } [/block]