{"_id":"56c50631bdcde80d004986a8","editedParams":true,"editedParams2":true,"project":"54774d9af3736008009e9e0e","category":{"_id":"56c50628bdcde80d0049863e","pages":["56c50631bdcde80d004986a8","56c50631bdcde80d004986a9","56c50631bdcde80d004986aa","56c50631bdcde80d004986ab","56c50631bdcde80d004986ac"],"project":"54774d9af3736008009e9e0e","__v":1,"version":"56c50626bdcde80d00498635","sync":{"url":"","isSync":false},"reference":true,"createdAt":"2015-03-17T14:18:28.079Z","from_sync":false,"order":10,"slug":"administrators","title":"Administrators"},"parentDoc":null,"githubsync":"","user":"54774c47f3736008009e9e0c","__v":0,"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":"2015-02-11T13:23:44.795Z","link_external":false,"link_url":"","sync_unique":"","hidden":false,"api":{"method":"get","results":{"codes":[{"name":"","status":200,"language":"json","code":"{\n  \"prev\": null,\n  \"objects\": [\n    {\n      \"first_name\": \"Meve\",\n      \"last_name\": \"Of Lyria and Rivia\",\n      \"links\": {\n        \"self\": \"/v1.1/instances/rivia/admins/8/\"\n      },\n      \"email\": \"meve:::at:::lyria-and-rivia.com\",\n      \"role\": \"full\",\n      \"id\": 8\n    }\n  ],\n  \"next\": null\n}"},{"status":403,"language":"json","code":"{\n  \"detail\": \"No such API Key.\"\n}"},{"code":"{\n  \"detail\": \"Instance was not found.\"\n}","status":404,"language":"json"}]},"settings":"56c50c06d1b8770d00922288","examples":{"codes":[{"language":"curl","code":"curl -X GET \\\n-H \"X-API-KEY: <ACCOUNT_KEY>\" \\\n\"https://api.syncano.io/v1.1/instances/<instance_name>/admins/\"","name":""},{"language":"python","code":"import syncano \nfrom syncano.models import Admin\n\nsyncano.connect(api_key='your_api_key', instance_name=\"INSTANCE_NAME\")\n\nadmins = Admin.please.list()\n\nfor admin in admins:\n    print(admin.last_name)\n"},{"name":"JavaScript","language":"javascript","code":"var Syncano = require(\"syncano\");\nvar connection = Syncano({accountKey: \"ACCOUNT_KEY\"});\nvar Admin = connection.Admin;\n\nAdmin.please().list({instanceName: \"INSTANCE_NAME\"}).then(callback)"}]},"auth":"required","params":[{"_id":"54d8b350628f540d00f3e4ae","ref":"","in":"path","required":true,"desc":"Instance name","default":"","type":"string","name":"instance"}],"url":"/instances/:instance/admins/"},"isReference":true,"order":0,"body":"Returns a list of Admins associated with the Instance. \n\nAdmins can be invited to an Instance with a POST method to the [/instances/:instance/invitations/](invitations-add) endpoint.","excerpt":"","slug":"admins-list","type":"endpoint","title":"Administrator - list"}

getAdministrator - list


Definition

{{ api_url }}{{ page_api_url }}

Parameters

Path Params

instance:
required
string
Instance name

Examples


Result Format


Documentation

Returns a list of Admins associated with the Instance. Admins can be invited to an Instance with a POST method to the [/instances/:instance/invitations/](invitations-add) endpoint.

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