Retrieve a Role

get

/api/v2/roles/{id}/

Make GET request to this resource to retrieve a single role record containing the following fields:

  • id: Database ID for this role. (integer)
  • type: Data type for this role. (choice)
  • url: URL for this role. (string)
  • related: Data structure with URLs of related resources. (object)
  • summary_fields: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)
  • name: Name of this role. (field)
  • description: Optional description of this role. (field)

Request

Supported Media Types
Path Parameters
Query Parameters
Back to Top

Response

200 Response

Back to Top