Consultar lote de colaboradores

GET /api/v1/valepix/employees/batch/{batch_id}

Lista os itens processados de um lote para revisão antes do commit.

Autenticação

Envie um API token ativo no header Authorization.

Authorization: Bearer <VALEPIX_API_TOKEN>
Accept: application/json

Path params

Parâmetro	Tipo	Obrigatório	Descrição
batch_id	string	Sim	Identificador do lote retornado no upload

Query params

Parâmetro	Tipo	Obrigatório	Descrição
page	number	Não	Página atual; mínimo 1 e padrão 1
limit	number	Não	Quantidade de itens por página; padrão 10 e máximo 100

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/batch/$BATCH_ID?page=1&limit=10"

Response

HTTP 200 OK.

{
  "success": "success",
  "data": {
    "items": [
      {
        "id": "00000000-0000-4000-8000-000000000101",
        "line": 2,
        "name": "maria exemplo santos",
        "document": "12345678909",
        "birth_date": "1990-05-20",
        "phone": "5511999999999",
        "email": "maria.exemplo@empresa.test",
        "cbo": "411005",
        "situation": "active",
        "admission_date": "2024-02-01",
        "is_valid": true
      }
    ],
    "total": 1,
    "page": 1,
    "total_pages": 1
  }
}

validation_errors aparece quando a linha possui erros. Em uma página vazia, listas e campos numéricos iguais a zero podem ser omitidos; trate items ausente como lista vazia e totais ausentes como 0.

Erros comuns

HTTP	Quando acontece	Ação recomendada
400	batch_id em formato inválido	Corrigir o identificador
401	Token ausente, inválido, expirado ou revogado	Conferir token
403	Token sem acesso ao recurso solicitado	Confirmar token com a ValePix
404	Lote não encontrado	Conferir batch_id
429	Limite de chamadas excedido	Reduzir a frequência e aplicar backoff
500, 502, 503, 504	Falha temporária na consulta	Tentar novamente com backoff