Skip to main content
GET
/
roles
/
{slug}
Buscar Papel
curl --request GET \
  --url https://api.example.com/roles/{slug} \
  --header 'Authorization: <authorization>'
{
  "roleId": "1",
  "organizationId": null,
  "slug": "admin",
  "name": "Admin",
  "description": "Full access",
  "type": "ENVIRONMENT_ROLE",
  "permissions": ["users:read", "users:write"],
  "inherited": true,
  "createdAt": "2026-01-15T10:00:00.000Z",
  "updatedAt": "2026-01-15T10:00:00.000Z"
}
Requer permissao roles:read.

​
Headers

​
Authorization
string
required
Bearer token.

​
Parametros de Path

​
slug
string
required
Slug do papel.

​
Parametros de Query

​
organizationId
string
O UUID da organizacao.

​
Resposta

{
  "roleId": "1",
  "organizationId": null,
  "slug": "admin",
  "name": "Admin",
  "description": "Full access",
  "type": "ENVIRONMENT_ROLE",
  "permissions": ["users:read", "users:write"],
  "inherited": true,
  "createdAt": "2026-01-15T10:00:00.000Z",
  "updatedAt": "2026-01-15T10:00:00.000Z"
}

​
Exemplos de Codigo

curl https://api.awsales.io/admin/roles/admin \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN"

​
Codigos de Erro

StatusCodigoDescricao
400validation_errorEntrada invalida ou campos obrigatorios ausentes
401unauthorizedAutenticacao ausente ou invalida
403forbiddenPermissoes insuficientes
404role.not_foundPapel nao encontrado
500internal_server_errorOcorreu um erro inesperado