{"__v":9,"_id":"54d8b60b8934140d00496545","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":"54d0fc4b7493b40d00400243","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-09T13:28:43.100Z","link_external":false,"link_url":"","githubsync":"","sync_unique":"","hidden":false,"api":{"results":{"codes":[{"status":200,"language":"json","code":"{[\n  {\n    \"database_name\": \"db01\",\n    \"description\": \"Database 01\",\n    \"user_id\": \"5335d4e377656254e6000001\",\n    \"id\": \"5335d84b7765625460000001\"\n  },\n  {\n    \"database_name\": \"db02\",\n    \"description\": \"\",\n    \"user_id\": \"5335d4e377656254e6000001\",\n    \"id\": \"467bef467764413260150001\"\n  }\n]}","name":""}]},"auth":"required","params":[{"_id":"54db5aa108ea010d00ab1fcd","ref":"","in":"query","required":false,"desc":"Starting page of items to return.","default":"1","type":"int","name":"page"},{"_id":"54db5aa108ea010d00ab1fcc","ref":"","in":"query","required":false,"desc":"Number of items per page that are returned. Must be a number between 1 and 30.","default":"10","type":"int","name":"limit"}],"url":"/databases"},"isReference":true,"order":2,"body":"List all databases. The *page* parameter defines where the presented list is going to start and *limit* will define how many items should be returned at most.\n\nA page start is defined by (*page* - 1) * limit. Starting from there, at most *limit* elements will be returned. \n\n### Sample Request\n\nThis request will return the two first databases from the user associated to API key.\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?page=1&limit=2\\\"\",\n      \"language\": \"shell\"\n    }\n  ]\n}\n[/block]\n### Sample Response\n\nThe two databases are returned in an array, with elements containing the information about a database.\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"[\\n  {\\n    \\\"database_name\\\": \\\"db01\\\",\\n    \\\"description\\\": \\\"Database 01\\\",\\n    \\\"user_id\\\": \\\"5335d4e377656254e6000001\\\",\\n    \\\"id\\\": \\\"5335d84b7765625460000001\\\"\\n  },\\n  {\\n    \\\"database_name\\\": \\\"db02\\\",\\n    \\\"description\\\": \\\"\\\",\\n    \\\"user_id\\\": \\\"5335d4e377656254e6000001\\\",\\n    \\\"id\\\": \\\"467bef467764413260150001\\\"\\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/create-a-database'>\\n    &laquo; Back \\n  </a>\\n</div>\\n\\n<div class='div-forward'> \\n  <a href='/v1.0/docs/get-a-database'>\\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":"List all your databases","slug":"sample-docs","type":"get","title":"List databases"}

getList databases

List all your databases

Definition

{{ api_url }}{{ page_api_url }}

Parameters

Query Params

page:
integer1
Starting page of items to return.
limit:
integer10
Number of items per page that are returned. Must be a number between 1 and 30.

Result Format


Documentation

List all databases. The *page* parameter defines where the presented list is going to start and *limit* will define how many items should be returned at most. A page start is defined by (*page* - 1) * limit. Starting from there, at most *limit* elements will be returned. ### Sample Request This request will return the two first databases from the user associated to API key. [block:code] { "codes": [ { "code": "curl --user <API-KEY>:\"\" -k -H \"Content-Type: application/json\" -XGET \\\n\"https://api.gogeo.io/1.0/databases?page=1&limit=2\"", "language": "shell" } ] } [/block] ### Sample Response The two databases are returned in an array, with elements containing the information about a database. [block:code] { "codes": [ { "code": "[\n {\n \"database_name\": \"db01\",\n \"description\": \"Database 01\",\n \"user_id\": \"5335d4e377656254e6000001\",\n \"id\": \"5335d84b7765625460000001\"\n },\n {\n \"database_name\": \"db02\",\n \"description\": \"\",\n \"user_id\": \"5335d4e377656254e6000001\",\n \"id\": \"467bef467764413260150001\"\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/create-a-database'>\n &laquo; Back \n </a>\n</div>\n\n<div class='div-forward'> \n <a href='/v1.0/docs/get-a-database'>\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 }}