{"_id":"5739caf41f4b740e00b06e0d","category":{"_id":"5739ca371f4b740e00b06e09","__v":0,"project":"54774d9af3736008009e9e0e","version":"56c50626bdcde80d00498635","sync":{"url":"","isSync":false},"reference":true,"createdAt":"2016-05-16T13:25:11.536Z","from_sync":false,"order":4,"slug":"data-endpoints","title":"Data Endpoints"},"parentDoc":null,"__v":1,"user":"5718db25f8f7de1900683f8c","editedParams2":true,"project":"54774d9af3736008009e9e0e","editedParams":true,"githubsync":"","version":{"_id":"56c50626bdcde80d00498635","project":"54774d9af3736008009e9e0e","__v":10,"createdAt":"2016-02-17T23:45:42.869Z","releaseDate":"2016-02-17T23:45:42.869Z","categories":["56c50628bdcde80d00498636","56c50628bdcde80d00498637","56c50628bdcde80d00498638","56c50628bdcde80d00498639","56c50628bdcde80d0049863a","56c50628bdcde80d0049863b","56c50628bdcde80d0049863c","56c50628bdcde80d0049863d","56c50628bdcde80d0049863e","56c50628bdcde80d0049863f","56c50628bdcde80d00498640","56c50628bdcde80d00498641","56c50628bdcde80d00498642","56c50628bdcde80d00498643","56c50628bdcde80d00498644","56c50628bdcde80d00498645","56c50628bdcde80d00498646","56c50628bdcde80d00498647","56c506a018f0c90d002808de","56c6b0baf795cf0d003ec13e","56fe58eb5a08190e00085149","571764513cf2960e0009a635","571fc008ffbc6a2000b25bb5","5739ca371f4b740e00b06e09","577522f197a3830e004bcc1b","57753d5ffecd260e00d86ce6","57adb71efaa7a10e004495b6"],"is_deprecated":true,"is_hidden":false,"is_beta":false,"is_stable":false,"codename":"API v1.1","version_clean":"0.1.1","version":"0.1.1"},"metadata":{"title":"","description":"","image":[]},"updates":[],"next":{"pages":[],"description":""},"createdAt":"2016-05-16T13:28:20.982Z","link_external":false,"link_url":"","sync_unique":"","hidden":false,"api":{"examples":{"codes":[{"code":"curl -X GET \\\n-H \"X-API-KEY: API_KEY\" \\\n\"https://api.syncano.io/v1.1/instances/INSTANCE_NAME/endpoints/data/\"","language":"curl"},{"language":"javascript","code":"var Syncano = require('syncano');\nvar connection = Syncano({apiKey: 'API_KEY',\n                          userKey: 'USER_KEY', \n                          defaults: { \n                                      instanceName: \"INSTANCE_NAME\"\n                                    }\n                         });                                    \nvar DataEndpoint = connection.DataEndpoint;\n\nDataEndpoint\n  .please()\n  .list()\n  .then(function(res) { \n      console.log(res);\n  });"}]},"method":"get","results":{"codes":[{"code":"{\n    \"name\": \"employees\", \n    \"description\": \"Gets list of available employees in company\", \n    \"query\": {\n        \"age\": {\n            \"_eq\": \"20\"\n        }\n    }, \n    \"excluded_fields\": \"surname\", \n    \"order_by\": \"name\", \n    \"page_size\": 5, \n    \"expand\": \"team\", \n    \"links\": {\n        \"rename\": \"/v1.1/instances/INSTANCE_NAME/endpoints/data/employees/rename/\", \n        \"self\": \"/v1.1/instances/INSTANCE_NAME/endpoints/data/employees/\", \n        \"clear_cache\": \"/v1.1/instances/INSTANCE_NAME/endpoints/data/employees/clear_cache/\", \n        \"get\": \"/v1.1/instances/INSTANCE_NAME/endpoints/data/employees/get/\"\n    }, \n    \"class\": \"employee\"\n}","language":"json","status":200,"name":""}]},"settings":"56c50c06d1b8770d00922288","auth":"required","params":[{"_id":"5739cdb4ae304e2900c6822b","ref":"","in":"path","required":true,"desc":"Instance name","default":"","type":"string","name":"instance_name"}],"url":"/instances/:instance_name/endpoints/data/"},"isReference":true,"order":0,"body":"","excerpt":"","slug":"data-endpoints-list","type":"endpoint","title":"Data Endpoints - list"}

getData Endpoints - list


Definition

{{ api_url }}{{ page_api_url }}

Parameters

Path Params

instance_name:
required
string
Instance name

Examples


Result Format


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 }}