Winx - API Integração
  1. Profile
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
      • ➕ 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
          GET
        • ➕ Criar Perfil
          POST
        • 🔍 Visualizar Perfil
          GET
        • ✏️ Atualizar Perfil
          PUT
        • 🗑️ Excluir Perfil
          DELETE
      • 📋 Listar Usuários
        GET
      • ➕ Criar Usuário
        POST
      • 🔍 Visualizar Usuário
        GET
      • ✏️ Atualizar Usuário
        PUT
      • 🗑️ Excluir Usuário
        DELETE
  • 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. Profile

📋 Listar Perfis

GET
/v1/profiles

📖 Descrição#

Lista todos os perfis de permissão da empresa com paginação e busca.

🔍 Funcionalidade de Busca Inteligente#

O parâmetro search busca no campo nome.

🔍 Exemplos de Busca#

📄 Paginação#

10 registros por página
Links de navegação automáticos
Metadados de total e páginas
Busca sempre retorna resultados paginados

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

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/profiles?search' \
--header 'Authorization: Bearer <token>'

Respostas

🟢200Sucesso
application/json
Body

Exemplo
{
    "data": [
        {
            "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
            "name": "string",
            "fields": [
                {
                    "filter": "string",
                    "values": [
                        "string"
                    ]
                }
            ],
            "created_at": "2019-08-24T14:15:22Z",
            "updated_at": "2019-08-24T14:15:22Z"
        }
    ],
    "links": {
        "first": "http://example.com",
        "last": "http://example.com",
        "prev": "http://example.com",
        "next": "http://example.com"
    },
    "meta": {
        "current_page": 1,
        "last_page": 1,
        "from": 1,
        "to": 1,
        "per_page": 1,
        "total": 1,
        "path": "http://example.com",
        "links": [
            {
                "url": "http://example.com",
                "label": "string",
                "active": true
            }
        ]
    }
}
🟠400Erro Padrão
🟠401Não Autenticado
🟠403Não Autorizado
🟠404Não Encontrado
🟠422Entidade Improcessável
Modificado em 2025-12-05 14:44:07
Página anterior
🗑️ Excluir Permissão
Próxima página
➕ Criar Perfil
Built with