1. Campaigns
Winx - API Integração
  • Raiz
    • Documentação de Integração
    • Companies
      • 📋 Listar Empresas
    • Campaigns
      • 📋 Listar Pesquisas
        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
    • Relatórios
      • 📋 Magic
      • 📋 Clusters de Engajamento
      • 📋 Clusters de Attrition
      • 📋 Maturidade da Liderança
      • 📋 eNPS
      • 📋 LNPS
      • 📋 Dimensões
      • 📋 Dimensões de Engajamento
      • 📋 Jornada do Colaborador
      • 📋 Dimensão Família
      • 📋 Dimensão Psicológica
      • 📋 Dimensão Psicossocial
      • 📋 Ranking por Perguntas
      • 📋 Ranking por Filtros
      • 📋 Participação
  • Esquemas
    • Schemas
      • UserCreate
      • User
      • CampaignAccess
      • UserCollection
      • PermissionCreate
      • PermissionUpdate
      • ProfileCreate
      • Profile
      • ProfileCollection
      • Company
      • Filter
      • FilterCreate
      • FilterUpdate
      • Employee
      • EmployeeField
      • EmployeeCreate
      • EmployeeUpdate
      • PaginationLinks
      • PaginationMeta
      • ErrorResponse
      • ValidationErrorResponse
    • Response
      • Unauthorized
      • Forbidden
      • NotFound
      • ValidationError
  1. Campaigns

📋 Listar Pesquisas

🧪 Servidor de Sandbox
https://scenic-tokyo-3bje4ahyb4rd.on-vapor.com/api
🧪 Servidor de Sandbox
https://scenic-tokyo-3bje4ahyb4rd.on-vapor.com/api
GET
/v1/campaigns

📖 Descrição#

Lista, de forma paginada, as pesquisas da empresa autenticada (exclui os subtipos offboarding e onboarding), ordenadas pela data de início (mais recentes primeiro).

🔗 Documentação Relacionada#

Autenticação
Rate Limiting
Formato de Resposta

⚙️ Regras de Negócio#

Retorna apenas as pesquisas da empresa autenticada (escopo por empresa; use o header Resource-Id para escopar uma subempresa)
Exclui os subtipos offboarding e onboarding
Inclui pesquisas canceladas (identificadas pelo status = cancelled)
Paginação fixa de 10 itens por página, ordenada pela data de início (mais recentes primeiro)
Suporta busca via parâmetro search (por título da descrição ou nome da pesquisa)
O status é calculado dinamicamente: cancelled, finished, in_progress, building ou scheduled

🎯 Casos de Uso#

Listagem de pesquisas em dashboards
Acompanhamento do andamento das pesquisas (contadores em meta: finished, in_progress, scheduled)
Busca e filtragem de pesquisas por nome

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 'https://scenic-tokyo-3bje4ahyb4rd.on-vapor.com/api/v1/campaigns?search=undefined&page=1&status=in_progress' \
--header 'Authorization: Bearer <token>'

Respostas

🟢200OK
application/json
✅ Lista de pesquisas retornada com sucesso
Bodyapplication/json

Examples
{
    "data": [
        {
            "id": "9b1c3f2a-8d4e-4c1a-9f7b-2e5d6a7c8b90",
            "type": "boosterh",
            "subtype": "family",
            "status": "in_progress",
            "survey_id": "9b1d4a3b-7e2f-4d0c-8a6e-1f3c5b9d2e47",
            "surveyName": "Pesquisa de Clima 2026",
            "default_survey_id": 12,
            "article": "male",
            "has_notification": true,
            "notification_frequency": 3,
            "respondents": 120,
            "forms_count": 340,
            "starts_at": "01/07/2026",
            "finishes_at": "31/07/2026",
            "disclosure_at": "03/08/2026",
            "include_inactive_employees": false,
            "audiences": [
                {
                    "id": "9b1e5c4d-6f3a-4b2e-9d8c-7a1b2c3d4e5f",
                    "type": "filter",
                    "audience": {
                        "department": {
                            "name": "Departamento",
                            "value": [
                                "TI",
                                "RH"
                            ]
                        }
                    },
                    "created_at": "2026-06-20T13:00:00+00:00",
                    "updated_at": "2026-06-20T13:00:00+00:00"
                }
            ],
            "descriptions": {
                "title": "Pesquisa de Clima",
                "description": "Queremos ouvir você sobre o ambiente de trabalho.",
                "language": "pt_br",
                "pt": "Queremos ouvir você sobre o ambiente de trabalho.",
                "en": "We want to hear from you about the work environment.",
                "es": "Queremos escucharte sobre el ambiente de trabajo."
            },
            "email_texts": {
                "pt": "Olá! Sua opinião é muito importante para a Winx.",
                "en": "Hi! Your opinion is very important to Winx.",
                "es": "¡Hola! Tu opinión es muy importante para Winx."
            },
            "created_at": "2026-06-20T13:00:00+00:00",
            "updated_at": "2026-06-25T09:30:00+00:00"
        },
        {
            "id": "9b2f7e6d-5c4b-4a3e-8d2c-1f0b9a8c7d6e",
            "type": "diagnosis",
            "subtype": "default",
            "status": "scheduled",
            "survey_id": "9b3a8f7e-4d3c-4b2a-9e1d-2c3b4a5d6e7f",
            "surveyName": "Diagnóstico Organizacional",
            "default_survey_id": null,
            "article": "female",
            "has_notification": false,
            "notification_frequency": 3,
            "respondents": 0,
            "forms_count": 0,
            "starts_at": "10/08/2026",
            "finishes_at": "10/09/2026",
            "disclosure_at": null,
            "include_inactive_employees": true,
            "audiences": [
                {
                    "id": "9b4b9a8c-3d2e-4c1b-8a9d-0e1f2a3b4c5d",
                    "type": "all",
                    "audience": [],
                    "created_at": "2026-07-01T10:15:00+00:00",
                    "updated_at": "2026-07-01T10:15:00+00:00"
                }
            ],
            "descriptions": {
                "title": "Diagnóstico Organizacional",
                "description": "Avaliação geral da organização.",
                "language": "pt_br",
                "pt": "Avaliação geral da organização.",
                "en": "General assessment of the organization.",
                "es": "Evaluación general de la organización."
            },
            "email_texts": {
                "pt": "Olá! Participe do nosso diagnóstico organizacional.",
                "en": "Hi! Take part in our organizational diagnosis.",
                "es": "¡Hola! Participa en nuestro diagnóstico organizacional."
            },
            "created_at": "2026-07-01T10:15:00+00:00",
            "updated_at": "2026-07-01T10:15:00+00:00"
        }
    ],
    "links": {
        "first": "https://api.winx.ai/api/v1/campaigns?page=1",
        "last": "https://api.winx.ai/api/v1/campaigns?page=5",
        "prev": null,
        "next": "https://api.winx.ai/api/v1/campaigns?page=2"
    },
    "meta": {
        "current_page": 1,
        "from": 1,
        "last_page": 5,
        "path": "https://api.winx.ai/api/v1/campaigns",
        "per_page": 10,
        "to": 10,
        "total": 48,
        "finished": 12,
        "in_progress": 8,
        "scheduled": 3
    }
}
🟠401Não Autorizado
🟠403Proibido
Modificado em 2026-07-17 15:16:48
Página anterior
📋 Listar Empresas
Próxima página
📋 Listar Filtros
Built with