Skip to main content
GET
/
api
/
roles
/
{id}
Get AccessRole by ID
curl --request GET \
  --url https://platform.kodexa.ai/api/roles/{id} \
  --header 'x-api-key: <api-key>'
{
  "changeSequence": 123,
  "createdOn": "2023-11-07T05:31:56Z",
  "description": "<string>",
  "displayName": "<string>",
  "id": "<string>",
  "name": "<string>",
  "systemDefined": true,
  "updatedOn": "2023-11-07T05:31:56Z",
  "uuid": "<string>"
}

Authorizations

​
x-api-key
string
header
required

API key for authentication. Create one from the Kodexa platform UI under Settings > Access Tokens.

Path Parameters

​
id
string<uuid>
required

Unique identifier (UUID) of the resource.

Response

The AccessRole

​
changeSequence
integer<int32>
​
createdOn
string<date-time>
​
description
string
​
displayName
string
​
id
string
​
name
string
​
systemDefined
boolean
​
updatedOn
string<date-time>
​
uuid
string