Skip to main content
GET
/
v3
/
roles
/
definitions
/
{definition}
Read Role Definition
curl --request GET \
  --url http://localhost/api/v3/roles/definitions/{definition}
{
  "data": {
    "id": 123,
    "name": "<string>",
    "handle": "<string>",
    "description": "<string>",
    "short_description": "<string>",
    "icon": "<string>",
    "image_url": "<string>",
    "timezone": "<string>",
    "period": 123,
    "period_type": "<string>",
    "absolute_expiry": "<string>",
    "group_name": "<string>",
    "group_handle": "<string>",
    "notes": "<string>",
    "meta": [
      "<unknown>"
    ],
    "custom_fields": {},
    "created_at": "<string>",
    "updated_at": "<string>"
  }
}

Documentation Index

Fetch the complete documentation index at: https://docs.omneo.io/llms.txt

Use this file to discover all available pages before exploring further.

Path Parameters

definition
integer
required

The definition ID

Response

RoleDefinition

data
RoleDefinition · object
required