Winx - API Integração
  1. Employees
Winx - API Integração
  • Raiz
    • Documentação de Integração
    • Companies
      • 📋 Listar Empresas
    • Filters
      • 📋 Listar Filtros
      • ➕ Criar Filtro
      • 🔍 Visualizar Filtro
      • ✏️ Atualizar Filtro
      • 🗑️ Excluir Filtro
    • Employees
      • 📋 Listar Funcionários
        GET
      • ➕ Criar Funcionário
        POST
      • 🔍 Visualizar Funcionário
        GET
      • ✏️ Atualizar Funcionário
        PUT
      • 🗑️ Excluir Funcionário
        DELETE
    • Users
      • Permissions
        • 📋 Listar Permissões
        • ➕ Criar Permissão
        • 🔍 Visualizar Permissão
        • 🗑️ Excluir Permissão
      • Profile
        • 📋 Listar Perfis
        • ➕ Criar Perfil
        • 🔍 Visualizar Perfil
        • ✏️ Atualizar Perfil
        • 🗑️ Excluir Perfil
      • 📋 Listar Usuários
      • ➕ Criar Usuário
      • 🔍 Visualizar Usuário
      • ✏️ Atualizar Usuário
      • 🗑️ Excluir Usuário
  • Esquemas
    • Schemas
      • UserCreate
      • User
      • CampaignAccess
      • UserCollection
      • PermissionCreate
      • PermissionUpdate
      • ProfileCreate
      • Profile
      • ProfileCollection
      • Company
      • Filter
      • FilterCreate
      • FilterUpdate
      • EmployeeField
      • PaginationLinks
      • PaginationMeta
      • ErrorResponse
      • ValidationErrorResponse
    • Response
      • Unauthorized
      • Forbidden
      • NotFound
      • ValidationError
  1. Employees

📋 Listar Funcionários

GET
/v1/employees

📖 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

Requisição

Authorization
Forneça seu token bearer no cabeçalho
Authorization
ao fazer requisições para recursos protegidos.
Exemplo:
Authorization: Bearer ********************
Parâmetros de Consulta

Parâmetros Header

Exemplos de Requisição

Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request GET 'https://scenic-tokyo-3bje4ahyb4rd.on-vapor.com/api/v1/employees?search=João Silva&page&is_on_leave=true' \
--header 'Resource-Id: 9c73a4aa-8094-4241-ad05-658436f471fe' \
--header 'Authorization: Bearer <token>'

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
    }
}
Modificado em 2025-11-06 17:27:52
Página anterior
🗑️ Excluir Filtro
Próxima página
➕ Criar Funcionário
Built with