Situações de colaboradores

GET /api/v1/valepix/employees/situations

Lista as situações válidas para o campo situation em rotas de colaboradores.

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 documentados.

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

Response

{
  "success": "success",
  "data": {
    "situations": [
      {
        "label": "Ativo",
        "value": "active",
        "url": "ativo"
      },
      {
        "label": "Bloqueado",
        "value": "blocked",
        "url": "bloqueado"
      },
      {
        "label": "Férias",
        "value": "vacation",
        "url": "ferias"
      },
      {
        "label": "Afastado",
        "value": "sick_leave",
        "url": "afastado"
      },
      {
        "label": "Licença Maternidade",
        "value": "maternity_leave",
        "url": "licenca-maternidade"
      },
      {
        "label": "Desligado",
        "value": "dismissed",
        "url": "desligado"
      }
    ]
  }
}

Use sempre o campo value no payload de criação, atualização, listagem ou arquivo de lote. Os campos label e url são úteis para exibição em interfaces.

Erros comuns

HTTP	Quando acontece	Ação recomendada
401	Token ausente, inválido, expirado ou revogado	Conferir token
403	Token sem acesso à API	Confirmar token com a ValePix
500	Erro interno temporário	Tentar novamente com backoff