> ## Documentation Index > Fetch the complete documentation index at: https://nexus-docs.ticto.dev/llms.txt > Use this file to discover all available pages before exploring further. # Buscar usuário por e-mail > Busca um usuário pelo endereço de e-mail. Retorna apenas usuários vinculados ao cliente autenticado. ## OpenAPI ````yaml /api-reference/openapi.yaml get /users/search openapi: 3.0.3 info: title: Nexus version: 1.0.2 description: > API para integração entre Ticto e clientes externos # Autenticação Para autenticar as solicitações aos endpoints descritos a seguir, por favor, siga os passos abaixo: 1. **Solicite** seu cadastro como cliente através do e-mail **infraestrutura@ticto.com.br** para obter seu `client_id` e `token`. 2. **Use** seu token e ID de cliente para fazer login no Nexus e obter seu `client_token`. 3. **Em todas as outras requisições**, envie seu `client_token` no header como `X-Api-Client-Token`. 4. **Crie** seus usuários na rota de criação de usuário. Para cada usuário, será retornado um `public_token` único. 5. **Para endpoints que não estão em public.php**, adicione o `public_token` do usuário no cabeçalho **Authorization** utilizando o formato: ```http Authorization: Bearer {public_token} ``` ## Restrição de origem O acesso a esta API não está disponível para todos os sellers. Seu uso é estritamente permitido para parceiros comerciais que a utilizarão em cenários específicos. Por este motivo, o acesso será restrito a endereços IP e domínios previamente informados por esses parceiros. Essa medida visa proporcionar um ambiente mais controlado e seguro para todos os nossos usuários e parceiros. ### O que isso significa para os desenvolvedores? - **Acesso Limitado:** Somente os IPs e domínios pré-autorizados poderão realizar chamadas à API. Qualquer tentativa de acesso de um IP ou domínio não listado será automaticamente rejeitada. - **Processo de Autorização:** Para garantir a continuidade do acesso à API sem interrupções, é essencial que os desenvolvedores enviem os endereços IP ou domínios que necessitam de acesso diretamente à nossa equipe de suporte. - **Como Solicitar Acesso:** Envie um e-mail para **liberacao@ticto.com.br** com o assunto _"Solicitação de Acesso à API de pagamentos"_, incluindo: - Nome da empresa ou do desenvolvedor - Endereços IP ou domínios a serem autorizados - Justificativa para o acesso - Informações de contato para eventuais esclarecimentos ## Alterações e/ou inclusão de novos domínios e IPs Recomendamos que solicitações de adição ou alteração de IPs/domínios sejam feitas o mais breve possível para garantir uma transição suave. Em casos de alterações, os domínios e/ou IPs anteriores serão imediatamente bloqueados após sua remoção. ## Suporte e Dúvidas Para dúvidas ou suporte adicional, entre em contato conosco através do e-mail **liberacao@ticto.com.br**. Estamos comprometidos em auxiliar neste processo e garantir a melhor experiência possível. servers: - url: https://nexus.ticto.com.br/api/v1 description: Produção security: [] tags: - name: Autenticação - name: Configurações do Cliente - name: Usuários - name: Onboarding de usuário - name: Contas Bancárias - name: Faixas de Taxa description: >- Endpoints para consulta de faixas de taxa personalizadas e histórico de alterações. - name: Frete - name: Financeiro - name: PIX Automático description: >- Consulta, cancelamento e nova tentativa de cobrança de assinaturas com PIX Automático (débito recorrente autorizado pelo pagador). - name: Produtos - name: Integrações - name: 'Webhooks: Usuários' description: Eventos relacionados a cadastro e atualização de usuários. - name: 'Webhooks: Contas Bancárias' description: Eventos relacionados a contas bancárias dos sellers. - name: 'Webhooks: Produtos e Ofertas' description: Eventos relacionados a produtos, ofertas, afiliados e coprodutores. - name: 'Webhooks: Financeiro' description: Eventos de reembolso, saque e antecipação. - name: 'Webhooks: Faixas de Taxa' description: Eventos de criação, atualização e exclusão de faixas de taxa. - name: 'Webhooks: Pedidos' description: Eventos de criação e atualização de pedidos. - name: 'Webhooks: Cobranças' description: >- Eventos de criação e mudança de status de cobranças (transações), na primeira compra e nas renovações. - name: 'Webhooks: Assinaturas' description: Eventos do ciclo de vida de assinaturas, cobranças e trial. paths: /users/search: get: tags: - Usuários summary: Buscar usuário por e-mail description: | Busca um usuário pelo endereço de e-mail. Retorna apenas usuários vinculados ao cliente autenticado. operationId: searchUserByEmail parameters: - name: email in: query required: true description: E-mail do usuário a ser buscado schema: type: string format: email example: joao@email.com responses: '200': description: Usuário encontrado content: application/json: schema: type: object properties: status: type: string example: success message: type: string example: Recurso encontrado com sucesso. data: $ref: '#/components/schemas/ResponseUser' example: status: success message: Recurso encontrado com sucesso. data: name: João Silva code: JXAWHIB2HN1756369698 status: approved is_approved: true is_registration_completed: true type: person email: joao@email.com public_token: 1|abc123token created_at: 28/08/2025 08:28:20 cpf: '12345678909' '401': description: Não autorizado '404': description: Usuário não encontrado content: application/json: schema: type: object properties: status: type: string example: error message: type: string example: Recurso não encontrado. '422': description: Parâmetro de e-mail ausente ou inválido content: application/json: schema: type: object properties: errors: type: array items: type: string example: - The email field is required. '500': description: Erro interno do servidor security: - ApiClientToken: [] components: schemas: ResponseUser: type: object required: - code - status - name - email - type - is_approved - is_registration_completed - created_at properties: code: type: string description: Código único do usuário status: type: string description: Status do usuário name: type: string description: Nome do usuário email: type: string description: Email do usuário type: type: string enum: - person - company description: Tipo do usuário is_approved: type: boolean description: Se o usuário foi aprovado is_registration_completed: type: boolean description: Se o registro foi completado public_token: type: string description: Token público para autenticação em endpoints protegidos created_at: type: string format: date-time description: Data e hora no formato ISO 8601 cpf: type: string description: CPF do usuário (apenas para pessoa física) cnpj: type: string description: CNPJ do usuário (apenas para pessoa jurídica) legacy: type: boolean description: >- Indica se o usuário é legado para o client autenticado. Usuários legados foram criados antes da integração com o Nexus (origem diferente de `nexus`) e não podem ter o perfil atualizado pela API. Presente apenas quando há um client autenticado. securitySchemes: ApiClientToken: type: apiKey in: header name: X-Api-Client-Token description: Token de autenticação do cliente obtido via endpoint /auth ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.