Listar unidades operacionais

Rota: GET /os/v1/operation-units

Campos obrigatórios

Nenhum.

Campos opcionais (query)

externalCode: Filtro por código externo com match exato. Sem correspondência → data vazio e total 0 (HTTP 200, não 404).
page: Número da página. Padrão: 1.
maxPageSize: Máximo por página. Padrão: 10. Mínimo: 1, máximo: 100.

Resposta de sucesso (200)

{
  "result": {
    "data": [
      {
        "uuid": "550e8400-e29b-41d4-a716-446655440000",
        "name": "Matriz São Paulo",
        "externalCode": "SP-001",
        "address": "Av. Paulista, 1000",
        "businessRegistrationNumber": "96925786000127",
        "company": { "uuid": "...", "name": "..." },
        "parent": { "externalCode": "ROOT-001", "name": "Matriz" }
      }
    ],
    "page": 1,
    "maxPageSize": 10,
    "total": 1,
    "totalPages": 1
  }
}

Exemplo de requisição (cURL)

curl --request GET \
     --url 'https://api.gupy.io/os/v1/operation-units?page=1&maxPageSize=10&externalCode=SP-001' \
     --header 'accept: application/json' \
     --header 'Authorization: Bearer bearer_token_value_here'

Atenção: Forneça o token no cabeçalho Authorization.

Possíveis erros

Parâmetros inválidos (400)

Query params fora dos limites (ex.: maxPageSize > 100).

Não autenticado (401)

Token ausente ou inválido.