Buscar posições

Este endpoint permite buscar todas as posições ativas na estrutura organizacional, com suporte à paginação.

Funcionalidade:

• Retorna a lista completa de posições.
• Aplica paginação (pagination) para gerenciar grandes volumes de dados de forma eficiente.

Uso:

• Utilize os parâmetros de paginação (geralmente page e limit) na requisição para controlar a quantidade de registros retornados e o deslocamento.

Exemplo de requisição (cURL)

curl --request GET \
     --url 'https://api.gupy.io/os/v1/positions?page=1&maxPageSize=10' \
     --header 'accept: application/json'

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

Possíveis erros

Número máximo de items por página

Acontece quando o número máximo de itens por página recebido é maior do que 100.

`
{
  "statusCode": 400,
  "timestamp": "2025-05-29T21:00:00.000Z",
  "path": "/os/v1/positions",
  "method": "GET",
  "title": "BadRequestException",
  "message": "Validation failed",
  "errors": [
    {
      "code": "BadRequestException",
      "target": "ValidationPipe",
      "message": "maxPageSize must not be greater than 100"
    }
  ]
}