{"metadata":{"image":[],"title":"","description":""},"api":{"url":"/instances/:instance_name/groups/:group_id/","auth":"required","examples":{"codes":[{"name":"","code":"curl -X GET \\\n-H \"X-API-KEY: <API_KEY>\" \\\n\"https://api.syncano.io/v1/instances/<instance_name>/groups/<group_id>/\"","language":"curl"},{"code":"import syncano\nfrom syncano.models import Group\n\nsyncano.connect(api_key=\"API_KEY\", instance_name=\"INSTANCE_NAME\")\n\n_group = Group.please.get(id=GROUP_ID)\n\nprint(group.label)\n","language":"python"},{"code":"var Syncano = require(\"syncano\");\nvar connection = Syncano({accountKey: \"ACCOUNT_KEY\"});\nvar Group = connection.Group;\n\nGroup.please().get({instanceName: \"INSTANCE_NAME\", id: 7}).then(callback);","language":"javascript"}]},"method":"get","params":[{"name":"instance_name","type":"string","default":"","desc":"Name of an instance.","required":true,"in":"path","ref":"","_id":"552e30172594f70d001b2c7e"},{"name":"group_id","type":"int","default":"","desc":"ID of a group.","required":true,"in":"path","ref":"","_id":"552ee3445d4baa0d00783763"}],"results":{"codes":[{"name":"","code":"{\n  \"description\": \"\",\n  \"id\": 1,\n  \"links\": {\n    \"self\": \"/v1.1/instances/rivia/groups/1/\",\n    \"users\": \"/v1.1/instances/rivia/groups/1/users/\"\n  },\n  \"label\": \"witchers\"\n}","language":"json","status":200},{"language":"json","status":403,"code":"{\n  \"detail\": \"No such API Key.\"\n}"},{"code":"{\n  \"detail\": \"Not found\"\n}","language":"json","status":404}]},"settings":"56c50c06d1b8770d00922288"},"next":{"description":"","pages":[]},"title":"Groups - details","type":"endpoint","slug":"groups-detail","excerpt":"","body":"Lists details of a chosen Group that belongs to a given Instance.","updates":[],"order":1,"isReference":true,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"_id":"56c50635bdcde80d004986d9","project":"54774d9af3736008009e9e0e","editedParams2":true,"githubsync":"","category":{"sync":{"isSync":false,"url":""},"pages":["56c50635bdcde80d004986d8","56c50635bdcde80d004986d9","56c50635bdcde80d004986da","56c50635bdcde80d004986db","56c50635bdcde80d004986dc","56c50635bdcde80d004986dd","56c50635bdcde80d004986de","56c50635bdcde80d004986df","56c50635bdcde80d004986e0","56c50635bdcde80d004986e1"],"title":"Groups","slug":"groups","order":15,"from_sync":false,"reference":true,"_id":"56c50628bdcde80d00498643","version":"56c50626bdcde80d00498635","createdAt":"2015-04-15T09:29:39.602Z","project":"54774d9af3736008009e9e0e","__v":1},"editedParams":true,"parentDoc":null,"user":"54774c47f3736008009e9e0c","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"},"__v":0,"createdAt":"2015-04-15T22:16:36.449Z"}

getGroups - details


Definition

{{ api_url }}{{ page_api_url }}

Parameters

Path Params

instance_name:
required
string
Name of an instance.
group_id:
required
integer
ID of a group.

Examples


Result Format


Documentation

Lists details of a chosen Group that belongs to a given Instance.

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