Winx - API Integração
  1. Companies
Winx - API Integração
  • Raiz
    • Documentação de Integração
    • Companies
      • 📋 Listar Empresas
        GET
    • 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
        • ➕ 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. Companies

📋 Listar Empresas

GET
/v1/companies

📖 Descrição#

Lista todas as empresas acessíveis ao usuário autenticado.

🔗 Documentação Relacionada#

Autenticação
Rate Limiting
Formato de Resposta

⚙️ Regras de Negócio#

Retorna apenas empresas onde o usuário tem acesso
Inclui informações do administrador principal
Mostra configurações como identify_key e has_form_otp

🎯 Casos de Uso#

Seleção de empresa em dashboards
Verificação de configurações da empresa
Listagem para usuários multi-empresa

Requisição

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

Respostas

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

Exemplo
{
    "data": [
        {
            "id": "9c73a4aa-8094-4241-ad05-658436f471fe",
            "identify_key": "document",
            "has_form_otp": true,
            "name": "Winx Tecnologia",
            "form_name": "Pesquisa de Clima",
            "company_name": "Winx Tech Ltda",
            "article": "a",
            "email": "contato@winx.ai",
            "phone": "+5511999999999",
            "document": "12345678000199",
            "logo": "https://example.com/logo.png",
            "language": "pt_BR",
            "admin": {
                "name": "João Silva",
                "email": "joao@winx.ai"
            },
            "created_at": "2024-01-01T00:00:00+00:00",
            "updated_at": "2024-01-01T00:00:00+00:00"
        }
    ]
}
🟠401Não Autorizado
🟠403Proibido
Modificado em 2025-08-27 22:27:08
Página anterior
Documentação de Integração
Próxima página
📋 Listar Filtros
Built with