Listar colaboradores

GET /api/v1/valepix/employees

Lista colaboradores com paginação e filtros opcionais.

Autenticação

Envie um API token ativo no header Authorization.

Authorization: Bearer <VALEPIX_API_TOKEN>
Accept: application/json

Path params

Esta rota não possui path params.

Query params

Parâmetro	Tipo	Obrigatório	Descrição
page	number	Não	Página atual. Padrão recomendado: 1
limit	number	Não	Quantidade de itens por página. Padrão recomendado: 10
situation	string	Não	Filtra pela situação. Use um value retornado por Situações de colaboradores
search	string	Não	Busca por nome ou documento

Exemplo curl

curl --request GET \
  --header "Authorization: Bearer $VALEPIX_API_TOKEN" \
  --header "Accept: application/json" \
  --url "https://routes.valepix.com.br/api/v1/valepix/employees?page=1&limit=10&situation=active"

Response

{
  "success": "success",
  "data": {
    "employees": [
      {
        "id": "00000000-0000-4000-8000-000000000001",
        "name": "Maria Exemplo Santos",
        "document": "***",
        "email": "maria.exemplo@empresa.test",
        "phone": "***",
        "birth_date": "1990-05-20T00:00:00.000Z",
        "benefit": {
          "id": "00000000-0000-4000-8000-000000000030",
          "name": "Benefício Exemplo",
          "description": "Plano exemplo"
        },
        "cbo": "4110-05",
        "situation": "active",
        "admission_date": "2024-02-01T00:00:00.000Z",
        "status": "active",
        "has_account": false
      }
    ],
    "meta": {
      "total": 1,
      "current_page": 1,
      "last_page": 1,
      "limit": 10
    }
  }
}

Os campos sensíveis acima estão mascarados apenas no exemplo. A resposta real pode retornar os valores conforme o contrato da integração.

Erros comuns

HTTP	Quando acontece	Ação recomendada
400	Parâmetros inválidos	Corrigir query string
401	Token ausente, inválido, expirado ou revogado	Conferir token
403	Token sem acesso ao recurso solicitado	Confirmar token com a ValePix
500	Erro interno temporário	Tentar novamente com backoff