Winx - API Integração
  1. Filters
Winx - API Integração
  • Raiz
    • Documentação de Integração
    • Companies
      • 📋 Listar Empresas
    • Filters
      • 📋 Listar Filtros
        GET
      • ➕ Criar Filtro
        POST
      • 🔍 Visualizar Filtro
        GET
      • ✏️ Atualizar Filtro
        PUT
      • 🗑️ Excluir Filtro
        DELETE
    • Employees
      • 📋 Listar Funcionários
      • ➕ Criar Funcionário
      • 🔍 Visualizar Funcionário
      • ✏️ Atualizar Funcionário
      • 🗑️ Excluir Funcionário
    • 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. Filters

📋 Listar Filtros

GET
/v1/filters

📖 Descrição#

Lista todos os filtros da empresa autenticada.

🔗 Documentação Relacionada#

Sistema de Fields
Employees - Criação

⚙️ Como Funcionam os Filtros#

Filtros são usados para categorizar funcionários:
Departamento: TI, RH, Vendas
Cargo: Analista, Gerente, Diretor
Localização: São Paulo, Rio de Janeiro

🔄 Relação com Employees#

Quando você cria um funcionário, deve fornecer valores para os filtros no campo fields:
{
  "fields": [
    {
      "id": "uuid-filter-departamento",
      "value": "TI"
    }
  ]
}

Requisição

Authorization
Forneça seu token bearer no cabeçalho
Authorization
ao fazer requisições para recursos protegidos.
Exemplo:
Authorization: Bearer ********************
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/filters' \
--header 'Resource-Id: 9c73a4aa-8094-4241-ad05-658436f471fe' \
--header 'Authorization: Bearer <token>'

Respostas

🟢200OK
application/json
✅ Lista de filtros retornada com sucesso
Body

Exemplo
{
    "data": [
        {
            "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
            "key": "string",
            "default_value": "string",
            "is_required": true,
            "is_filterable": true,
            "is_default": true,
            "language": "string",
            "created_at": "2019-08-24T14:15:22Z",
            "updated_at": "2019-08-24T14:15:22Z"
        }
    ]
}
Modificado em 2025-08-27 22:28:02
Página anterior
📋 Listar Empresas
Próxima página
➕ Criar Filtro
Built with