Contar colaboradores

GET /api/v1/valepix/employees/count

Retorna a quantidade de colaboradores ativos da empresa vinculada ao API token.

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

Esta rota não possui query params.

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/count"

Response

HTTP 200 OK.

{
  "success": "success",
  "data": {
    "total": 42
  }
}

Campo	Tipo	Descrição
total	number	Quantidade de colaboradores ativos da empresa

Quando não há colaboradores ativos, total pode ser omitido de data; trate sua ausência como 0.

Como usar o resultado

• Use esta rota quando precisar apenas do total de colaboradores ativos.
• Para consultar colaboradores de outras situações, use Listar colaboradores com o filtro situation.

Erros comuns

HTTP	Quando acontece	Ação recomendada
401	Token ausente, inválido, expirado ou revogado	Conferir token
403	Token sem acesso ao recurso solicitado	Confirmar token com a ValePix
429	Limite de requisições excedido	Aplicar backoff e respeitar o rate limit
500, 502, 503, 504	Falha temporária na consulta	Tentar novamente com backoff