Listar áreas

Este endpoint permite listar áreas da empresa com paginação e filtro opcional.


Campos obrigatórios

Nenhum.

Campos opcionais (query)

  • externalCode: Filtro por parte do código externo (case-insensitive). Sem match → data vazio e total 0.
  • page: Número da página. Padrão: 1.
  • maxPageSize: Máximo por página. Padrão: 10. Mínimo: 1, máximo: 100.

A resposta inclui códigos de departamento e centro de custo quando houver vínculo.

Exemplo de requisição (cURL)

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

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

Possíveis erros

Não autenticado (401)

Token ausente ou inválido.

Número máximo de itens por página (400)

Ocorre quando maxPageSize é maior que 100.