GET https://api.vidyard.com/dashboard/v1/roles/:id
Get a role within the current organization by id

Get a role within the current organization by id

Supported Formats

json

Errors

Code Description
400 Bad Request: body has wrong syntax or unable to handle request
401 Unauthorized: auth_token omitted or authentication failed
403 Forbidden: This action cannot be performed
404 Not Found: The requested resource could not be found
406 Not Acceptable: Accept or Content-Type headers must be application/json, text/csv or application/vnd.openxmlformats-officedocument.spreadsheetml.sheet

Examples

REQUEST
Accept: application/json

RESPONSE
200 (OK)
{
  "id": 2,
  "name": "Admin",
  "auth_token": "<MY_AUTH_TOKEN>",
  "can_create_players": true,
  "can_edit_players": true,
  "can_edit_player_style_and_restrictions": true,
  "can_view_billing": true,
  "can_invite_users": true,
  "can_access_analytics": true,
  "can_create_roles": true,
  "can_push_to_youtube": true,
  "can_invite_child_account_users": true,
  "can_create_child_accounts": true
}

Params

Param name Description
auth_token
optional

API token needed to authorize requests
This can appear as an attribute in the body of the request or the query parameters on the URL

Validations:

  • Must be a String