📋 Listar Funcionários

📖 Descrição

Lista todos os funcionários da empresa com paginação e busca.

🔍 Funcionalidade de Busca Inteligente

O parâmetro search busca em múltiplos campos simultaneamente via scopeSearch:

Nome (name e social_name)

Documento (CPF)

Email

Telefone

ID Interno (internal_id)

🎯 Busca por Internal ID (Não há endpoint GET dedicado)

Pergunta: Como buscar funcionário pelo internal_id?
Resposta: Use a query de busca, pois o scopeSearch inclui internal_id.

Exemplo Prático:

Retorna: Funcionário com internal_id = "6000001" (resultado paginado)

{
  "data": [
    {
      "id": "uuid-do-funcionario",
      "name": "João Silva",
      "internal_id": "6000001",  // ⭐ Campo encontrado
      "document": "12345678901",
      "email": "joao@empresa.com"
    }
  ],
  "meta": {
    "total": 1,
    "current_page": 1
  }
}

🔍 Outros Exemplos de Busca

📄 Paginação

10 registros por página (padrão do paginate(10))

Links de navegação automáticos

Metadados de total e páginas

Busca sempre retorna resultados paginados

🔗 Documentação Relacionada

Criar Funcionário - Para obter o UUID retornado

Visualizar Funcionário - Usar UUID específico

Sistema de Fields

Forneça seu token bearer no cabeçalho

Authorization

ao fazer requisições para recursos protegidos.

Exemplo:

Authorization: Bearer ********************

Exemplos de Requisição

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

Respostas

🟢200OK

application/json

✅ Lista de funcionários retornada com sucesso

Body

Exemplo

{
    "data": [
        {
            "id": "9c73a4aa-8094-4241-ad05-658436f471fe",
            "name": "João Silva Santos",
            "social_name": "João Silva",
            "email": "joao@empresa.com",
            "phone": "5511987654321",
            "document": "12345678901",
            "internal_id": "EMP001",
            "language": "pt_BR",
            "birthdate": "1990-01-01T00:00:00+00:00",
            "hiring_date": "2020-01-01T00:00:00+00:00",
            "firing_date": null,
            "is_voluntary_firing": null,
            "reason_firing": null,
            "is_on_leave": false,
            "fields": [
                {
                    "id": "filter-uuid-dept",
                    "value": "TI"
                },
                {
                    "id": "filter-uuid-cargo",
                    "value": "Desenvolvedor"
                }
            ],
            "created_at": "2024-01-01T00:00:00+00:00",
            "updated_at": "2024-01-01T00:00:00+00:00"
        }
    ],
    "links": {
        "first": "https://api.winx.ai/v1/employees?page=1",
        "last": "https://api.winx.ai/v1/employees?page=10",
        "prev": null,
        "next": "https://api.winx.ai/v1/employees?page=2"
    },
    "meta": {
        "current_page": 1,
        "per_page": 10,
        "total": 100,
        "last_page": 10
    }
}

📖 Descrição#

🔍 Funcionalidade de Busca Inteligente#

🎯 Busca por Internal ID (Não há endpoint GET dedicado)#

🔍 Outros Exemplos de Busca#

📄 Paginação#

🔗 Documentação Relacionada#

Requisição