{"metadata":{"image":[],"title":"","description":""},"api":{"url":"","auth":"required","results":{"codes":[]},"settings":"","params":[]},"next":{"description":"","pages":[]},"title":"Parameters","type":"basic","slug":"parameters","excerpt":"","body":"## Common parameters\n\n+ limit (integer, optional) `number` of records to return.\n    + Default: `10`\n+ offset (integer, optional) Record `number` to start at.\n    + Default: `0`\n+ fields (string, optional) Comma-separated `string` of fieds to return.\n    + Example: `SpecCode,Vulnerability`\n\nAbove parameters common to all routes except:\n\n* [root](#root)\n* [heartbeat](#heartbeat)\n* [docs](#docs)\n\nIn addition, these routes do not support `limit` or `offset`:\n\n* [listfields](#listfields)\n\n## Additional parameters\n\nRight now, any field that is returned from a route can also be queried on, except for the [/taxa route](#taxa), which only accepts `species` and `genus` in addition to the common parameters. All of the fields from each route are too long to list here - inspect data returned from a small data request, then change your query as desired.\n\nRight now, parameters that are not found are silently dropped. For example, if you query with `/species?foo=bar` in a query, and `foo` is not a field in `species` route, then the `foo=bar` part is ignored. We may in the future error when parameters are not found.","updates":[],"order":12,"isReference":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"_id":"5a0e5075c96bc7001288e554","project":"5508a8940f146f3500b031c9","version":{"version":"1.0","version_clean":"1.0.0","codename":"","is_stable":true,"is_beta":false,"is_hidden":false,"is_deprecated":false,"categories":["5508a8950f146f3500b031cd","5a0e2e283bb0d9001c09e3e1","5a0e2f9844969800124f4d3a","5a0e2fdcc96bc7001288e17d"],"_id":"5508a8950f146f3500b031cc","__v":4,"createdAt":"2015-03-17T22:20:05.001Z","releaseDate":"2015-03-17T22:20:05.001Z","project":"5508a8940f146f3500b031c9"},"category":{"sync":{"isSync":false,"url":""},"pages":["5508a8960f146f3500b031cf"],"title":"Documentation","slug":"documentation","order":0,"from_sync":false,"reference":false,"_id":"5508a8950f146f3500b031cd","version":"5508a8950f146f3500b031cc","__v":1,"createdAt":"2015-03-17T22:20:05.520Z","project":"5508a8940f146f3500b031c9"},"user":"5508a87b99a1832100bf9569","createdAt":"2017-11-17T02:59:01.023Z","githubsync":"","__v":0,"parentDoc":null}
## Common parameters + limit (integer, optional) `number` of records to return. + Default: `10` + offset (integer, optional) Record `number` to start at. + Default: `0` + fields (string, optional) Comma-separated `string` of fieds to return. + Example: `SpecCode,Vulnerability` Above parameters common to all routes except: * [root](#root) * [heartbeat](#heartbeat) * [docs](#docs) In addition, these routes do not support `limit` or `offset`: * [listfields](#listfields) ## Additional parameters Right now, any field that is returned from a route can also be queried on, except for the [/taxa route](#taxa), which only accepts `species` and `genus` in addition to the common parameters. All of the fields from each route are too long to list here - inspect data returned from a small data request, then change your query as desired. Right now, parameters that are not found are silently dropped. For example, if you query with `/species?foo=bar` in a query, and `foo` is not a field in `species` route, then the `foo=bar` part is ignored. We may in the future error when parameters are not found.