Skip to main content
GET
/
api
/
security
/
roles
/
{id}
Get one Role
curl --request GET \
  --url https://spaces.nexudus.com/api/security/roles/{id} \
  --header 'Authorization: Basic <encoded-value>'
{
  "Name": "<string>",
  "UserRoles": [
    123
  ],
  "Id": 123,
  "UniqueId": "<string>",
  "CreatedOn": "<string>",
  "UpdatedOn": "<string>",
  "UpdatedBy": "<string>",
  "IsNew": true,
  "SystemId": "<string>"
}
A Role defines a set of permissions that can be assigned to administrators. Roles control what areas of the system a user can access and what actions they can perform.

​
Authentication

This endpoint requires OAuth2 authentication. Include a valid bearer token in the Authorization header. The authenticated user must be a full unrestricted administrator or have the Role-Read role.

​
Path Parameters

​
id
integer
required
The Id of the Role record to retrieve.

​
Code Examples

curl -X GET \
  "https://spaces.nexudus.com/api/security/roles/87654321" \
  -H "Authorization: Bearer YOUR_TOKEN"

​
Response

​
200

​
Name
string
The name value for this role.
​
UserRoles
integer[]
List of user roles linked to this record.
​
Id
integer
Unique record identifier.
​
UniqueId
string
UUID of the record.
​
CreatedOn
string
Date and time the record was created (ISO 8601).
​
UpdatedOn
string
Date and time the record was last updated (ISO 8601).
​
UpdatedBy
string
Email of the user who last updated this record.
​
IsNew
boolean
Whether the record was recently created.
​
SystemId
string
External system identifier.
Example Response
{
  "Name": "",
  "UserRoles": [],
  "Id": 87654321,
  "UpdatedOn": "2025-01-15T10:30:00Z",
  "CreatedOn": "2025-01-10T08:00:00Z",
  "UniqueId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
  "UpdatedBy": "admin@example.com",
  "IsNew": false,
  "SystemId": null,
  "ToStringText": "Role Example",
  "LocalizationDetails": null,
  "CustomFields": null
}