VUIT

GET/api/v1/people

Listar Pessoas

Lista pessoas com paginação e filtros opcionais

Parâmetros de Query

pagenumber

padrão: 1

Número da página (deve ser ≥ 1)

pageSizenumber

padrão: 20

Itens por página (entre 1 e 100)

searchstring

Busca textual por nome, CPF ou email

companyIdstring

Filtrar por ID específico da empresa

typestring

Filtrar por tipo de pessoa (valores: humano ou remoto)

statusstring

Filtrar por status (valores: ativo, afastado, removido). Pode usar múltiplos valores separados por vírgula

Exemplo de Requisição

curl -X GET "/api/v1/people?page=1&status=ativo" \
  -H "Authorization: SEU_TOKEN"

Exemplo de Resposta

{
  "success": true,
  "data": [
    {
      "_id": "...",
      "name": "João Silva",
      "cpf": "12345678901",
      "birthdate": "1990-05-15T00:00:00.000Z",
      "city": "São Paulo",
      "uf": "SP",
      "type": "humano",
      "status": "ativo",
      "email": "joao@example.com",
      "company": {
        "companyId": "...",
        "name": "Empresa LTDA",
        "cnpj": "12345678000190",
        "teamId": "..."
      }
    }
  ],
  "pagination": {
    "currentPage": 1,
    "pageSize": 20,
    "totalCount": 45,
    "totalPages": 3,
    "hasMore": true
  }
}

Carregando