Skip to main content
GET
/
api
/
v1
/
bko
/
organizations
/
{organizationId}
Get Organization
curl --request GET \
  --url https://api.example.com/api/v1/bko/organizations/{organizationId} \
  --header 'Authorization: Bearer <token>'
{
  "organizationId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "name": "<string>",
  "document": "<string>",
  "logo": "<string>",
  "phoneIso": "<string>",
  "phoneDdi": "<string>",
  "phoneNumber": "<string>",
  "phoneVerified": true,
  "email": "<string>",
  "emailVerified": true,
  "createdBy": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "createdAt": "2023-11-07T05:31:56Z",
  "updatedBy": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "updatedAt": "2023-11-07T05:31:56Z",
  "deletedBy": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "deletedAt": "2023-11-07T05:31:56Z"
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

​
organizationId
string<uuid>
required

Organization identifier

Example:

"0195e7a1-8b5c-7d3e-9f4a-2c6b8d0e1f3a"

Query Parameters

​
fields
string

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

Entidade base de tenant para RBAC, cooperativas e empresas

​
organizationId
string<uuid>
required

Identificador único

​
type
enum<string>
required

Tipo da organização

Available options:
COOPERATIVE,
COMPANY
​
name
string
required

Razão social ou nome fantasia

​
document
string
required

CNPJ da organização

​
documentType
enum<string>
required

Tipo do documento

Available options:
CPF,
CNPJ,
RG
​
logo
string | null
required

Chave do objeto de armazenamento do logotipo

​
phoneIso
string | null
required

Código ISO do país do telefone

​
phoneDdi
string | null
required

DDI do telefone

​
phoneNumber
string | null
required

Número do telefone

​
phoneVerified
boolean
required

Indica se o telefone foi verificado

​
email
string | null
required

Email de contato da organização

​
emailVerified
boolean
required

Indica se o email foi verificado

​
status
enum<string>
required

Status operacional da organização

Available options:
ACTIVE,
INACTIVE,
BLOCKED
​
createdBy
string<uuid> | null
required

Usuário que criou o registro, quando aplicável

​
createdAt
string<date-time>
required

Data de criação

​
updatedBy
string<uuid> | null
required

Usuário que fez a última atualização, quando aplicável

​
updatedAt
string<date-time>
required

Data da última atualização

​
deletedBy
string<uuid> | null
required

Usuário que removeu o registro, quando aplicável

​
deletedAt
string<date-time> | null
required

Data de remoção