Listar itens

GET /api/v1/valepix/distributions/{distribution_id}/items

Lista os colaboradores e valores incluídos na distribuição.

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
distribution_id	string	Sim	Identificador da distribuição

Query params

Parâmetro	Tipo	Obrigatório	Descrição
page	number	Não	Página atual; padrão 1
limit	number	Não	Itens por página; padrão 10
search	string	Não	Busca colaboradores ativos pelo nome

Exemplo curl

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

Response

HTTP 200 OK.

{
  "success": "success",
  "data": {
    "distribution": {
      "distribution_id": "00000000-0000-4000-8000-000000000801",
      "total_amount": 50000,
      "total_employees": 1,
      "created_at": "2026-07-23T12:00:00Z"
    },
    "employees": [
      {
        "id": "00000000-0000-4000-8000-000000000811",
        "employee_id": "00000000-0000-4000-8000-000000000001",
        "employee_name": "Maria Exemplo Santos",
        "document": "12345678909",
        "status": "pending",
        "is_in_list": true,
        "values": {
          "alimentacao": {
            "id": "00000000-0000-4000-8000-000000000201",
            "amount": 50000
          }
        }
      }
    ],
    "meta": {
      "total": 1,
      "last_page": 1,
      "limit": 10
    }
  }
}

Os campos amount e total_amount são valores em centavos. A resposta informa last_page e limit; controle a página pelo parâmetro enviado.

Sem search, a rota lista os colaboradores já incluídos. Com search, ela procura pelo nome entre os colaboradores ativos e pode retornar também pessoas ainda não incluídas. Quando is_in_list aparece como true, o colaborador já pertence à distribuição; o campo pode ser omitido para quem ainda não pertence.

Revise esta resposta imediatamente antes da finalização.

Erros comuns

HTTP	Quando acontece	Ação recomendada
400	distribution_id em formato inválido	Corrigir o identificador
401	Token ausente, inválido, expirado ou revogado	Conferir o header Authorization
403	Distribuição não disponível para a integração	Conferir o distribution_id, o ambiente e o token
429	Limite de chamadas excedido	Reduzir a frequência das consultas e aplicar backoff
500, 502, 503, 504	Falha temporária na consulta	Tentar novamente com backoff