curl --request GET \
--url https://api.example.com/api/v1/bko/roles/{roleId} \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.example.com/api/v1/bko/roles/{roleId}"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.example.com/api/v1/bko/roles/{roleId}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.example.com/api/v1/bko/roles/{roleId}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.example.com/api/v1/bko/roles/{roleId}"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.example.com/api/v1/bko/roles/{roleId}")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/api/v1/bko/roles/{roleId}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"roleId": "0195e7a1-8b5c-7d3e-9f4a-2c6b8d0e1f3a",
"organizationId": "0195e7a1-8b5c-7d3e-9f4a-2c6b8d0e1f3a",
"type": "ORGANIZATION",
"name": "Administrador",
"permissions": [
"read:trip",
"create:trip"
],
"createdAt": "2026-01-01T00:00:00.000Z",
"updatedAt": "2026-01-01T00:00:00.000Z",
"description": "Acesso total à organização",
"createdBy": "0195e7a1-8b5c-7d3e-9f4a-2c6b8d0e1f3a",
"updatedBy": "0195e7a1-8b5c-7d3e-9f4a-2c6b8d0e1f3a",
"deletedBy": null,
"deletedAt": null
}{
"errors": [
{
"message": "required",
"path": "name"
}
],
"message": "Bad Request Error",
"statusCode": 400
}{
"message": "Missing or invalid access token",
"statusCode": 401
}{
"message": "Insufficient permissions",
"statusCode": 403
}{
"message": "Internal Server Error",
"statusCode": 500
}Get Role
Returns a role.
curl --request GET \
--url https://api.example.com/api/v1/bko/roles/{roleId} \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.example.com/api/v1/bko/roles/{roleId}"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.example.com/api/v1/bko/roles/{roleId}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.example.com/api/v1/bko/roles/{roleId}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.example.com/api/v1/bko/roles/{roleId}"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.example.com/api/v1/bko/roles/{roleId}")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/api/v1/bko/roles/{roleId}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"roleId": "0195e7a1-8b5c-7d3e-9f4a-2c6b8d0e1f3a",
"organizationId": "0195e7a1-8b5c-7d3e-9f4a-2c6b8d0e1f3a",
"type": "ORGANIZATION",
"name": "Administrador",
"permissions": [
"read:trip",
"create:trip"
],
"createdAt": "2026-01-01T00:00:00.000Z",
"updatedAt": "2026-01-01T00:00:00.000Z",
"description": "Acesso total à organização",
"createdBy": "0195e7a1-8b5c-7d3e-9f4a-2c6b8d0e1f3a",
"updatedBy": "0195e7a1-8b5c-7d3e-9f4a-2c6b8d0e1f3a",
"deletedBy": null,
"deletedAt": null
}{
"errors": [
{
"message": "required",
"path": "name"
}
],
"message": "Bad Request Error",
"statusCode": 400
}{
"message": "Missing or invalid access token",
"statusCode": 401
}{
"message": "Insufficient permissions",
"statusCode": 403
}{
"message": "Internal Server Error",
"statusCode": 500
}Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Path Parameters
Role identifier
"0195e7a1-8b5c-7d3e-9f4a-2c6b8d0e1f3a"
Query Parameters
Comma-separated list of fields to include in the response. Supports dot notation for nested projection (e.g. id,name,user.email,trips.route.id). Unknown fields are silently dropped.
Response
OK
Role
Role identifier
"0195e7a1-8b5c-7d3e-9f4a-2c6b8d0e1f3a"
Organization identifier
"0195e7a1-8b5c-7d3e-9f4a-2c6b8d0e1f3a"
Role type
INTERNAL, ENVIRONMENT, ORGANIZATION "ORGANIZATION"
Role name
"Administrador"
Granted permissions
Assignable permission identifier
read:profile, update:profile, read:organization, create:organization, update:organization, delete:organization, read:role, create:role, update:role, delete:role, read:member, create:member, update:member, delete:member, read:employee, create:employee, update:employee, read:cooperative, read:user, update:user, read:benefit_category, create:benefit_category, update:benefit_category, delete:benefit_category, read:benefit_request, update:benefit_request, read:benefit_document, update:benefit_document, read:benefit_usage_history, read:invite, create:invite, delete:invite, read:audit, read:support_case, create:support_case, update:support_case, read:export, create:export, update:export, read:notification, update:notification, delete:notification, read:vehicle, create:vehicle, update:vehicle, delete:vehicle, read:seat-type, read:driver, create:driver, update:driver, delete:driver, read:driver_transport_operator, update:driver_transport_operator, read:vehicle_transport_operator, update:vehicle_transport_operator, read:point, create:point, update:point, delete:point, read:transport_operator, create:transport_operator, update:transport_operator, approve:transport_operator, block:transport_operator, reject:transport_operator, unblock:transport_operator, delete:transport_operator, read:route, create:route, update:route, delete:route, read:route_approval, update:route_approval, approve:route_approval, reject:route_approval, read:transport_operator_route, create:transport_operator_route, update:transport_operator_route, approve:transport_operator_route, reject:transport_operator_route, suspend:transport_operator_route, reactivate:transport_operator_route, read:transport_operator_route_policy, create:transport_operator_route_policy, update:transport_operator_route_policy, delete:transport_operator_route_policy, read:trip, create:trip, update:trip, delete:trip, read:trip_schedule, create:trip_schedule, update:trip_schedule, delete:trip_schedule, create:trip_event, read:trip_review, update:trip_review, read:checkout, read:order, create:order, update:order, read:ticket, create:ticket, update:ticket, delete:ticket, read:payment, read:cash_settlement, update:cash_settlement, read:cooperative_payment_settings, update:cooperative_payment_settings, read:transport_operator_subsidy_settlement, update:transport_operator_subsidy_settlement, approve:transport_operator_subsidy_settlement, mark_paid:transport_operator_subsidy_settlement, reject:transport_operator_subsidy_settlement, read:balance, read:receivable, read:transfer, create:transfer, read:company_credit_account, read:company_credit_purchase, create:company_credit_purchase, read:credit_grant, create:credit_grant, update:credit_grant, read:webhook, retry:webhook ["read:trip", "create:trip"]
Created at
"2026-01-01T00:00:00.000Z"
Updated at
"2026-01-01T00:00:00.000Z"
Role description
"Acesso total à organização"
Creator user identifier
"0195e7a1-8b5c-7d3e-9f4a-2c6b8d0e1f3a"
Updater user identifier
"0195e7a1-8b5c-7d3e-9f4a-2c6b8d0e1f3a"
Remover user identifier
null
Deleted at
null