Skip to main content
GET
/
api
/
v1
/
bko
/
points
/
{pointId}
Get Point
curl --request GET \
  --url https://api.example.com/api/v1/bko/points/{pointId} \
  --header 'Authorization: Bearer <token>'
{
  "pointId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "name": "<string>",
  "description": "<string>",
  "lat": 123,
  "lng": 123,
  "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

pointId
string<uuid>
required

Point 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

Catálogo global de localidades reutilizáveis (terminais, cidades, pontos de embarque) referenciadas por Routes

pointId
string<uuid>
required

Identificador único

name
string
required

Nome do local

description
string | null
required

Descrição complementar (opcional)

lat
number | null
required

Latitude (opcional, -90 a 90)

lng
number | null
required

Longitude (opcional, -180 a 180)

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