Winx - API Integração
  1. Users
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
        • āž• Criar Perfil
        • šŸ” Visualizar Perfil
        • āœļø Atualizar Perfil
        • šŸ—‘ļø Excluir Perfil
      • šŸ“‹ 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. Users

šŸ“‹ Listar UsuĆ”rios

GET
/v1/users

šŸ“– Descrição#

Lista todos os usuÔrios da empresa com paginação e busca.

šŸ” Funcionalidade de Busca Inteligente#

O parâmetro search busca em múltiplos campos simultaneamente:
Nome
Email

šŸ” 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/users?search&role&page' \
--header 'Authorization: Bearer <token>'

Respostas

🟢200Sucesso
application/json
Body

Exemplo
{
    "data": [
        {
            "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
            "name": "string",
            "email": "string",
            "phone": "stringstrings",
            "role": "admin",
            "pda": "admin",
            "language": "pt_br",
            "onboarding": true,
            "offboarding": true,
            "campaign_accesses": [
                {
                    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
                    "campaign_id": "78614b6c-fe7c-41e2-8e25-c9b3a3c91904",
                    "type": "boosterh",
                    "subtype": "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": 0,
        "per_page": 0,
        "total": 0,
        "last_page": 0,
        "path": "http://example.com",
        "admin": 0,
        "manager": 0,
        "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:43:53
PƔgina anterior
šŸ—‘ļø Excluir Perfil
Próxima pÔgina
āž• Criar UsuĆ”rio
Built with