Roles

Retrieve Role

Retrieve the details of an existing Role.

get/roles/{id}

Request

Path parameters

idstring required

The id of the relevant record

Response

OK

idinteger
created_atstring date-time required

The date and time at which this record was created.

updated_atstring date-time required

The date and time at which this record was most recently updated.

namestring required

The name of this Role.

descriptionstring nullable required

The description of this Role.

defaultboolean required

Whether this Role is applied as the default Role for new Users.

type'StandardRole' | 'CustomRole' required

Indicates whether this role is a standard Fleetio role, or created by a user.

Example response

{
  "created_at": "2023-03-14T13:46:27-06:00",
  "updated_at": "2023-03-14T13:46:27-06:00"
}

Changes

No recorded changes to this operation across all 6 revisions of this API.