Sign in

v8

latestOpenAPI 3.0.0raw.githubusercontent.com2026-08-01421779.8 KB
Role

Returns info about specified role.

get/role/{id}

Path parameters

idinteger required

Role ID

Response

OK

namestring
descriptionstring
{"stackTrail":"paths:/role/{id}:get:responses:200:content:application/json:schema:properties:min_available","oasType":"schema","type":"unknown","example":1}
{"stackTrail":"paths:/role/{id}:get:responses:200:content:application/json:schema:properties:max_available","oasType":"schema","type":"unknown","example":3}
finalisedboolean

Whether this role has been finalised (e.g. max available number)

Example response

{
  "name": "Chief Mouser",
  "description": "Larry the cat gone missing! now we need someone else to handle the rat issues at 10th Downing st.",
  "min_available": 1,
  "max_available": 3
}