Get custom role

Gets a single custom role.

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

Authorization

AuthorizationBearer token · headerrequired

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

Path parameters

team_slugstringrequired

app_slugstringrequired

custom_role_idstring<uuid>required

Responses

200

dataCustomRolerequired

Show properties

idUUIDrequired

slugstringrequired

namestringrequired

is_defaultbooleanrequired

created_atstring<date-time>required

updated_atstring<date-time> | null

400

Request-level failure

errorErrorBodyrequired

Show properties

messagestringrequired

detailsstring[]required

401

Request-level failure

errorErrorBodyrequired

Show properties

messagestringrequired

detailsstring[]required

403

Request-level failure

errorErrorBodyrequired

Show properties

messagestringrequired

detailsstring[]required

404

Request-level failure

errorErrorBodyrequired

Show properties

messagestringrequired

detailsstring[]required

500

Request-level failure

errorErrorBodyrequired

Show properties

messagestringrequired

detailsstring[]required

Try it

Server

Base URLCustom base URLOverrides the selected server when set.

Authorization

Bearer tokenRemember on this deviceInclude my values in samples

Parameters

team_slugpath*app_slugpath*custom_role_idpath*

Request

curl -X GET 'https://api.enad.io/api/v2/string/string/custom-roles/497f6eca-6276-4993-bfeb-53cbbbba6f08' \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'Accept: application/json'

const response = await fetch("https://api.enad.io/api/v2/string/string/custom-roles/497f6eca-6276-4993-bfeb-53cbbbba6f08", {
  method: "GET",
  headers: {
    "Authorization": "Bearer YOUR_TOKEN",
    "Accept": "application/json"
  }
});

import requests

response = requests.get(
    "https://api.enad.io/api/v2/string/string/custom-roles/497f6eca-6276-4993-bfeb-53cbbbba6f08",
    headers={
        "Authorization": "Bearer YOUR_TOKEN",
        "Accept": "application/json"
    },
)

Response

{
  "data": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "slug": "string",
    "name": "string",
    "is_default": true,
    "created_at": "2019-08-24T14:15:22Z",
    "updated_at": "2019-08-24T14:15:22Z"
  }
}

{
  "error": {
    "message": "string",
    "details": [
      "string"
    ]
  }
}

{
  "error": {
    "message": "string",
    "details": [
      "string"
    ]
  }
}

{
  "error": {
    "message": "string",
    "details": [
      "string"
    ]
  }
}

{
  "error": {
    "message": "string",
    "details": [
      "string"
    ]
  }
}

{
  "error": {
    "message": "string",
    "details": [
      "string"
    ]
  }
}