{"__v":1,"_id":"54db804b1a143121003139cf","category":{"__v":7,"_id":"54fdad6e660db63700c23b82","pages":["55fbef82af72eb0d0007df93","55fbf623e013770d008fcba8","5617bd3a26e3db230054fba4","5617c4a6f8c9632100ac74f5","561ed6fd0a04340d00d8a0b0","562156adf4e0352100cbf268","562a5c846049f20d0032520b"],"project":"54d0fd1d095c470d00d1646d","version":"54d0fd1e095c470d00d16470","sync":{"url":"","isSync":false},"reference":true,"createdAt":"2015-03-09T14:25:50.133Z","from_sync":false,"order":2,"slug":"api-reference","title":"API Reference"},"editedParams":true,"editedParams2":true,"project":"54d0fd1d095c470d00d1646d","user":"54db525474dfff3700f161e9","version":{"__v":20,"_id":"54d0fd1e095c470d00d16470","project":"54d0fd1d095c470d00d1646d","createdAt":"2015-02-03T16:53:50.090Z","releaseDate":"2015-02-03T16:53:50.090Z","categories":["54d0fd1e095c470d00d16471","54d8b5e68934140d00496544","54db6361c6a4d40d0034b8f7","54db638208ea010d00ab1fdd","54db639008ea010d00ab1fde","54db6547c6a4d40d0034b8fd","54db83482092743700ea6ee1","54db84afc6a4d40d0034b93c","54db8805c6a4d40d0034b93f","54db8de9c6a4d40d0034b961","54db931ac6a4d40d0034b96d","54e49219e4365521006fd9ee","54e74fcc652d7c1900cbe737","54e74ffd3c1e111700d05762","54e77e0a523b1b2f00e6f313","54e784affdabe62500fcddcf","54e784fa523b1b2f00e6f319","54e785de8ae8911900cd42c5","54fdad6e660db63700c23b82","54fdff31f7b1202100a25e06"],"is_deprecated":false,"is_hidden":false,"is_beta":false,"is_stable":true,"codename":"","version_clean":"1.0.0","version":"1.0"},"updates":[],"next":{"pages":[],"description":""},"createdAt":"2015-02-11T16:16:11.096Z","link_external":false,"link_url":"","githubsync":"","sync_unique":"","hidden":false,"api":{"results":{"codes":[{"name":"","code":"[\n  {\n    \"city\": \"Chicago\",\n    \"name\": \"John\",\n    \"age\": 38\n  },\n  {\n    \"city\": \"Los Angeles\",\n    \"name\": \"Marie\",\n    \"age\": 38\n  }\n]","language":"json","status":200}]},"auth":"required","params":[{"_id":"54db9db9c6a4d40d0034b983","ref":"","in":"path","required":true,"desc":"Name or id of the database.","default":"","type":"string","name":"database_id"},{"_id":"54db9db9c6a4d40d0034b982","ref":"","in":"path","required":true,"desc":"Name or id of the collection.","default":"","type":"string","name":"collection_id"},{"_id":"54db804b1a143121003139d3","ref":"","in":"query","required":false,"desc":"Number of the recovered page. It must be greater than 1. If the page number is greater than the total number of pages, it is returned to first page. The total number of pages is calculated from the parameter limit (Number of database / limit).","default":"1","type":"int","name":"page"},{"_id":"54db804b1a143121003139d2","ref":"","in":"query","required":false,"desc":"Number of objects recovered per page. It must be greater than 1 and less than 30.","default":"10","type":"int","name":"limit"},{"_id":"54db804b1a143121003139d1","ref":"","in":"query","required":false,"desc":"The name of the attribute that will be used as reference when ordering.","default":"","type":"string","name":"sort"},{"_id":"54db804b1a143121003139d0","ref":"","in":"query","required":false,"desc":"Relational filter from ElasticSearch (http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/query-dsl-query-string-query.html)","default":"","type":"string","name":"q"}],"url":"/databases/:database_id/collections/:collection_id/documents"},"isReference":true,"order":15,"body":"Retrieve a list of documents of a collection. You can sort the results by some attributes of the document. For this reason, you simply send on the parameter *:sort* (optional) of the request the name of the attribute that will be used as reference when ordering.\n\nThe document list can be filtered according to some restriction sent by parameter *:q* (optional). The platform uses the [Query String](http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/query-dsl-query-string-query.html) feature from ElasticSearch to carry out the consultation on documents from the collection.\n\nA JSON is returned containing all documents found. The **geom** attribute of each document is **not** returned.\n\n### Sample Request\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"curl --user <API-KEY>:\\\"\\\" -k -H \\\"Content-Type: application/json\\\" -XGET \\\\\\n\\\"https://api.gogeo.io/1.0/databases/my_database/collections/my_collection/documents?sort=name&q=age:38\\\"\",\n      \"language\": \"curl\"\n    }\n  ]\n}\n[/block]\n### Sample Response\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"[\\n  {\\n    \\\"city\\\": \\\"Chicago\\\",\\n    \\\"name\\\": \\\"John\\\",\\n    \\\"age\\\": 38\\n  },\\n  {\\n    \\\"city\\\": \\\"Los Angeles\\\",\\n    \\\"name\\\": \\\"Marie\\\",\\n    \\\"age\\\": 38\\n  }\\n]\",\n      \"language\": \"json\"\n    }\n  ]\n}\n[/block]\n\n[block:html]\n{\n  \"html\": \"<div class=\\\"panel panel-info teste\\\" >\\n  <div class=\\\"panel-body\\\">\\n    This endpoint requires an API key. See <a href=\\\"basic-auth\\\">Basic Authentication</a> for more information about the goGeo authentication system.\\n\\t\\t<br><br>\\n\\t  If you don't have an access key yet, <a href=\\\"https://console.gogeo.io/signup\\\">sign up</a> and take yours!\\n  </div>\\n</div>\\n\"\n}\n[/block]\n---\n[block:html]\n{\n  \"html\": \"<div class='div-middle'> \\n  <a href='#'>\\n    Top page &spades; </div>\\n  </a>\\n</div>\\n\\n<div class='div-back'> \\n  <a href='/v1.0/docs/insert-a-json-document'>\\n    &laquo; Back \\n  </a>\\n</div>\\n\\n<div class='div-forward'> \\n  <a href='/v1.0/docs/query-documents'>\\n    Next &raquo; </div>\\n  </a>\\n</div>\\n\\n<style>\\n\\t.div-back {\\n  \\tpadding-left: 15px;\\n\\t\\tmargin-top: -20px;\\n  }\\n  \\n  .div-middle {\\n  \\ttext-align: center;\\n\\t\\tmargin-top: -15px;\\n  }\\n  \\n  .div-forward {\\n  \\tfloat: right;\\n    padding-right: 15px;\\n\\t\\tmargin-top: -20px;\\n  }\\n</style>\"\n}\n[/block]","excerpt":"Retrieve a list of documents of a collection.","slug":"list-all-collections-documents","type":"get","title":"List documents"}

getList documents

Retrieve a list of documents of a collection.

Definition

{{ api_url }}{{ page_api_url }}

Parameters

Path Params

database_id:
required
string
Name or id of the database.
collection_id:
required
string
Name or id of the collection.

Query Params

page:
integer1
Number of the recovered page. It must be greater than 1. If the page number is greater than the total number of pages, it is returned to first page. The total number of pages is calculated from the parameter limit (Number of database / limit).
limit:
integer10
Number of objects recovered per page. It must be greater than 1 and less than 30.
sort:
string
The name of the attribute that will be used as reference when ordering.
q:
string
Relational filter from ElasticSearch (http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/query-dsl-query-string-query.html)

Result Format


Documentation

Retrieve a list of documents of a collection. You can sort the results by some attributes of the document. For this reason, you simply send on the parameter *:sort* (optional) of the request the name of the attribute that will be used as reference when ordering. The document list can be filtered according to some restriction sent by parameter *:q* (optional). The platform uses the [Query String](http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/query-dsl-query-string-query.html) feature from ElasticSearch to carry out the consultation on documents from the collection. A JSON is returned containing all documents found. The **geom** attribute of each document is **not** returned. ### Sample Request [block:code] { "codes": [ { "code": "curl --user <API-KEY>:\"\" -k -H \"Content-Type: application/json\" -XGET \\\n\"https://api.gogeo.io/1.0/databases/my_database/collections/my_collection/documents?sort=name&q=age:38\"", "language": "curl" } ] } [/block] ### Sample Response [block:code] { "codes": [ { "code": "[\n {\n \"city\": \"Chicago\",\n \"name\": \"John\",\n \"age\": 38\n },\n {\n \"city\": \"Los Angeles\",\n \"name\": \"Marie\",\n \"age\": 38\n }\n]", "language": "json" } ] } [/block] [block:html] { "html": "<div class=\"panel panel-info teste\" >\n <div class=\"panel-body\">\n This endpoint requires an API key. See <a href=\"basic-auth\">Basic Authentication</a> for more information about the goGeo authentication system.\n\t\t<br><br>\n\t If you don't have an access key yet, <a href=\"https://console.gogeo.io/signup\">sign up</a> and take yours!\n </div>\n</div>\n" } [/block] --- [block:html] { "html": "<div class='div-middle'> \n <a href='#'>\n Top page &spades; </div>\n </a>\n</div>\n\n<div class='div-back'> \n <a href='/v1.0/docs/insert-a-json-document'>\n &laquo; Back \n </a>\n</div>\n\n<div class='div-forward'> \n <a href='/v1.0/docs/query-documents'>\n Next &raquo; </div>\n </a>\n</div>\n\n<style>\n\t.div-back {\n \tpadding-left: 15px;\n\t\tmargin-top: -20px;\n }\n \n .div-middle {\n \ttext-align: center;\n\t\tmargin-top: -15px;\n }\n \n .div-forward {\n \tfloat: right;\n padding-right: 15px;\n\t\tmargin-top: -20px;\n }\n</style>" } [/block]

User Information

Try It Out

get
{{ tryResults.results }}
Method{{ tryResults.method }}
Request Headers
{{ tryResults.requestHeaders }}
URL{{ tryResults.url }}
Request Data
{{ tryResults.data }}
Status
Response Headers
{{ tryResults.responseHeaders }}