{"metadata":{"image":[],"title":"","description":""},"api":{"url":"/instances/:instance/invitations/:invitation_id/","auth":"required","method":"get","params":[{"name":"instance","type":"string","default":"","desc":"Instance name","required":true,"in":"path","ref":"","_id":"54d4d54ff6c48a0d00f0f028"},{"name":"invitation_id","type":"int","default":"","desc":"Invitation ID","required":true,"in":"path","ref":"","_id":"54d4e13ef6c48a0d00f0f038"}],"results":{"codes":[{"status":200,"language":"json","code":"{\n    \"created_at\": \"2015-05-27T16:11:23.611631Z\",\n    \"email\": \"coen:::at:::povis.ciri\",\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}","name":""},{"language":"json","code":"{\n  \"detail\": \"No such API Key.\"\n}","status":403},{"code":"{\n  \"detail\": \"Not found\"\n}","language":"json","status":404}]},"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/<invitation_id>/\"","language":"curl"},{"code":"import syncano \nfrom syncano.models import InstanceInvitation \n\nsyncano.connect(api_key='ACCOUNT_KEY', instance_name=\"INSTANCE_NAME\")\n\ninvitation = InstanceInvitation.please.get(id=IVITATION_ID)\n\nprint(invitation.email)\n","language":"python"},{"code":"var Syncano = require(\"syncano\");\nvar connection = Syncano({accountKey: \"ACCOUNT_KEY\"});\nvar InstanceInvitation = connection.InstanceInvitation;\n\nInstanceInvitation.please().get({instanceName: \"INSTANCE_NAME\", pk: 7}).then(callback)","language":"javascript"}]}},"next":{"description":"","pages":[]},"title":"Invitation - details","type":"endpoint","slug":"invitations-detail","excerpt":"","body":"Allows you to see the details of an invitation (inside a chosen instance) that you sent to the new Administrator. \n\nYou can read more about Admin invitations in the [Administrators chapter](http://docs.syncano.com/docs/administrators).","updates":[],"order":1,"isReference":true,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"_id":"56c50632bdcde80d004986ae","createdAt":"2015-02-06T15:42:19.464Z","githubsync":"","version":{"version":"0.1.1","version_clean":"0.1.1","codename":"API v1.1","is_stable":false,"is_beta":false,"is_hidden":false,"is_deprecated":true,"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"],"_id":"56c50626bdcde80d00498635","project":"54774d9af3736008009e9e0e","__v":10,"createdAt":"2016-02-17T23:45:42.869Z","releaseDate":"2016-02-17T23:45:42.869Z"},"project":"54774d9af3736008009e9e0e","__v":0,"category":{"sync":{"isSync":false,"url":""},"pages":["56c50632bdcde80d004986ad","56c50632bdcde80d004986ae","56c50632bdcde80d004986af","56c50632bdcde80d004986b0","56c50632bdcde80d004986b1"],"title":"Invitations (Sent)","slug":"invitations-sent","order":11,"from_sync":false,"reference":true,"_id":"56c50628bdcde80d0049863f","project":"54774d9af3736008009e9e0e","version":"56c50626bdcde80d00498635","__v":1,"createdAt":"2015-03-17T14:17:51.437Z"},"editedParams2":true,"user":"54774c47f3736008009e9e0c","editedParams":true,"parentDoc":null}

getInvitation - details


Definition

{{ api_url }}{{ page_api_url }}

Parameters

Path Params

instance:
required
string
Instance name
invitation_id:
required
integer
Invitation ID

Examples


Result Format


Documentation

Allows you to see the details of an invitation (inside a chosen instance) that you sent to the new Administrator. You can read more about Admin invitations 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 }}