Get a custom role

Get a custom role that can be set on users.

GET/api/v1/{team_slug}/{app_slug}/custom-roles/{custom_role_id}

Authorization

AuthorizationBearer token · headerrequired

Management API token, sent as Authorization: Bearer <token>.

Path parameters

app_slugstringrequired

App slug

team_slugstringrequired

Team slug

custom_role_idstringrequired

Custom Role ID

Responses

200

Got Custom role successfully

datainternal_pkg_webserver_v1.CustomRolerequired

Show properties

app_idstring

created_atstring

idstring

is_defaultboolean

namestring

slugstring

updated_atstring

detailsstring[]

Additional contextual information about the response. Used to provide supplementary details beyond the main data payload, such as validation warnings or processing notes

successbooleanrequired

400

Invalid request (e.g. id not uuid)

detailsstring[]

messagestring

successbooleanrequired

401

Unauthorized access

detailsstring[]

messagestring

successbooleanrequired

404

Not found

detailsstring[]

messagestring

successbooleanrequired

500

Internal server error

detailsstring[]

messagestring

successbooleanrequired

Try it

Server

Base URLCustom base URLOverrides the selected server when set.

Authorization

Bearer tokenRemember on this deviceInclude my values in samples

Parameters

app_slugpath*App slugteam_slugpath*Team slugcustom_role_idpath*Custom Role ID

Request

curl -X GET 'https://api.enad.io/api/v1/string/string/custom-roles/string' \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'Accept: application/json'

const response = await fetch("https://api.enad.io/api/v1/string/string/custom-roles/string", {
  method: "GET",
  headers: {
    "Authorization": "Bearer YOUR_TOKEN",
    "Accept": "application/json"
  }
});

import requests

response = requests.get(
    "https://api.enad.io/api/v1/string/string/custom-roles/string",
    headers={
        "Authorization": "Bearer YOUR_TOKEN",
        "Accept": "application/json"
    },
)

Response

{
  "data": {
    "app_id": "string",
    "created_at": "string",
    "id": "string",
    "is_default": true,
    "name": "string",
    "slug": "string",
    "updated_at": "string"
  },
  "details": [
    "string"
  ],
  "success": true
}

{
  "details": [
    "string"
  ],
  "message": "string",
  "success": true
}

{
  "details": [
    "string"
  ],
  "message": "string",
  "success": true
}

{
  "details": [
    "string"
  ],
  "message": "string",
  "success": true
}

{
  "details": [
    "string"
  ],
  "message": "string",
  "success": true
}