{"_id":"56c50632bdcde80d004986ad","parentDoc":null,"project":"54774d9af3736008009e9e0e","user":"54774c47f3736008009e9e0c","__v":0,"editedParams2":true,"githubsync":"","category":{"_id":"56c50628bdcde80d0049863f","project":"54774d9af3736008009e9e0e","version":"56c50626bdcde80d00498635","__v":1,"pages":["56c50632bdcde80d004986ad","56c50632bdcde80d004986ae","56c50632bdcde80d004986af","56c50632bdcde80d004986b0","56c50632bdcde80d004986b1"],"sync":{"url":"","isSync":false},"reference":true,"createdAt":"2015-03-17T14:17:51.437Z","from_sync":false,"order":11,"slug":"invitations-sent","title":"Invitations (Sent)"},"editedParams":true,"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-06T15:37:56.244Z","link_external":false,"link_url":"","sync_unique":"","hidden":false,"api":{"results":{"codes":[{"status":200,"language":"json","code":"{\n  \"next\": null,\n  \"objects\": [\n    {\n      \"created_at\": \"2015-05-27T01:37:12.361679Z\",\n      \"email\": \"foltest:::at:::temeria.ciri\",\n      \"id\": 18,\n      \"key\": \"529c0cfbc2c64646971e1f79511f47cbef3b393f\",\n      \"links\": {\n        \"resend\": \"/v1.1/instances/rivia/invitations/18/resend/\",\n        \"self\": \"/v1.1/instances/rivia/invitations/18/\"\n      },\n      \"role\": \"write\",\n      \"state\": \"new\",\n      \"updated_at\": \"2015-05-27T01:37:12.361713Z\"\n    },\n    {\n      \"created_at\": \"2015-05-27T16:11:23.611631Z\",\n      \"email\": \"[email protected]\",\n      \"id\": 20,\n      \"key\": \"54b09c4a194f269a8f71f3e582c94fa431ee28b8\",\n      \"links\": {\n        \"resend\": \"/v1.1/instances/rivia/invitations/20/resend/\",\n        \"self\": \"/v1.1/instances/rivia/invitations/20/\"\n      },\n      \"role\": \"full\",\n      \"state\": \"new\",\n      \"updated_at\": \"2015-05-27T16:11:23.611669Z\"\n    }\n  ],\n  \"prev\": null\n}","name":""},{"status":403,"language":"json","code":"{\n  \"detail\": \"No such API Key.\"\n}"},{"status":404,"language":"json","code":"{\n  \"detail\": \"Instance was not found.\"\n}"}]},"settings":"56c50c06d1b8770d00922288","examples":{"codes":[{"name":"","code":"curl -X GET \\\n-H \"X-API-KEY: <ACCOUNT_KEY>\" \\\n\"https://api.syncano.io/v1.1/instances/<instance_name>/invitations/\"","language":"curl"},{"code":"import syncano \nfrom syncano.models import InstanceInvitation \n\nsyncano.connect(api_key='ACCOUNT_KEY', instance_name=\"INSTANCE_NAME\")\n\ninvitations = InstanceInvitation.please.list()\n\nfor invite in invitations:\n    print(invite.email)\n","language":"python"},{"code":"var Syncano = require(\"syncano\");\nvar connection = Syncano({accountKey: \"ACCOUNT_KEY\"});\nvar InstanceInvitation = connection.InstanceInvitation;\n\nInstanceInvitation.please().list({instanceName: \"INSTANCE_NAME\"}).then(callback);","language":"javascript"}]},"method":"get","auth":"required","params":[{"_id":"54d4d54ff6c48a0d00f0f028","ref":"","in":"path","required":true,"desc":"Instance name","default":"","type":"string","name":"instance"}],"url":"/instances/:instance/invitations/"},"isReference":true,"order":0,"body":"Allows you to list the invitations (inside a chosen instance) that you sent to the new Administrators. \n\nYou can read more about Admin invitations and in the [Administrators chapter](http://docs.syncano.com/docs/administrators).","excerpt":"","slug":"invitations-list","type":"endpoint","title":"Invitation - list"}

getInvitation - list


Definition

{{ api_url }}{{ page_api_url }}

Parameters

Path Params

instance:
required
string
Instance name

Examples


Result Format


Documentation

Allows you to list the invitations (inside a chosen instance) that you sent to the new Administrators. You can read more about Admin invitations and in the [Administrators chapter](http://docs.syncano.com/docs/administrators).

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