> ## Documentation Index > Fetch the complete documentation index at: https://userepass.com/docs/llms.txt > Use this file to discover all available pages before exploring further. # Consulta o estado do guia do usuário na organização ativa > Retorna o estado do guia de onboarding do painel (tours, telas visitadas e preferências) do usuário autenticado na organização ativa. Quando o usuário ainda não interagiu com o guia, retorna o estado inicial vazio com `updatedAt: null`. ## OpenAPI ````yaml /openapi.json get /me/guide-state openapi: 3.1.0 info: title: Repass API description: >- API pública do Repass — plataforma de gestão de afiliados: programas, links, tracking, atribuição, conversões, comissões, payouts, fiscal (BR), reprocessamento, event store e webhooks. version: 0.1.0 servers: - url: https://api.userepass.com description: Produção security: - bearerAuth: [] - apiKeyAuth: [] tags: - name: Profile description: Perfil do usuário autenticado. - name: Guide description: >- Guia de onboarding do painel: estado de tours, telas visitadas e preferências por usuário e organização. - name: Portal description: >- Portal do afiliado: sessão por identidade de afiliado (sem org), convites e claim. - name: Programs description: 'Programas de afiliados: configuração, atribuição, hold e tiers.' - name: Commission Rules description: Regras de comissão versionadas (imutáveis) por programa. - name: Affiliates description: 'Ciclo de vida do afiliado: cadastro, aprovação, tier, saldo.' - name: Terms description: Termos do programa, versionados. - name: Materials description: >- Materiais (criativos) do programa: upload pelo gestor e download pelos afiliados. - name: Links description: Links rastreáveis e domínios de redirecionamento. - name: Coupons description: Cupons de afiliado e sync com gateway. - name: Pagamentos por PIX description: Habilitação de pagamentos por PIX (onboarding e documentos). - name: Tracking description: Endpoints públicos de redirect e registro de cliques. - name: Clicks description: Consulta de cliques e estatísticas de link. - name: Conversions description: 'Conversões: ingestão S2S, atribuição, matching, fraude e auditoria.' - name: Commissions description: Comissões calculadas, holds, aprovação, void e clawback. - name: Payouts description: Ciclos de pagamento, prévia, execução e comprovantes. - name: Invoices description: Notas fiscais (PJ), envio e validação (BR). - name: Fraud description: Fila de revisão e decisões de fraude. - name: Reprocess description: Reprocessamento com dry-run obrigatório e relatório de impacto. - name: Events description: Histórico de eventos para auditoria e consulta. - name: Notifications description: >- Notificações ao operador (falhas de sincronização, payouts e afins) — registro in-app espelhado por e-mail aos owners/admins. - name: Webhooks description: Endpoints de webhook, entregas, retries e dead-letter. - name: Ingest description: Ingestão de eventos de cobrança (S2S e gateways). - name: Settings description: Configurações por organização (políticas e integrações). - name: Billing description: 'Plano e cobrança: contadores de uso da organização para o painel.' - name: Dashboard description: >- Métricas agregadas da operação (receita, top afiliados, conversões, comissões, novos afiliados) para a home e os relatórios do gestor. - name: Health description: Liveness do serviço. paths: /me/guide-state: get: tags: - Guide summary: Consulta o estado do guia do usuário na organização ativa description: >- Retorna o estado do guia de onboarding do painel (tours, telas visitadas e preferências) do usuário autenticado na organização ativa. Quando o usuário ainda não interagiu com o guia, retorna o estado inicial vazio com `updatedAt: null`. operationId: getGuideState responses: '200': description: Default Response content: application/json: schema: type: object properties: state: type: object properties: schemaVersion: type: number description: >- Versão do shape deste documento. Sempre 1 na versão atual. enum: - 1 tours: type: object propertyNames: type: string additionalProperties: type: object properties: status: type: string enum: - in_progress - completed - skipped description: >- Status de um tour do guia: em andamento, concluído ou pulado pelo usuário. lastStepId: anyOf: - type: string - type: 'null' description: >- Identificador do último passo visto pelo usuário, ou `null` quando o tour ainda não avançou nenhum passo. example: create-program completedStepIds: type: array items: type: string description: >- Identificadores dos passos já concluídos deste tour. example: - welcome - create-program contentVersion: type: integer minimum: -9007199254740991 maximum: 9007199254740991 description: >- Versão do conteúdo do tour com a qual este progresso foi gravado. Escritas com versão menor que a armazenada são descartadas (escritor desatualizado). example: 1 updatedAt: type: string description: >- Timestamp ISO 8601 da última atualização deste progresso. example: '2026-07-07T12:00:00.000Z' lastStepRoute: description: >- Padrão de rota do último passo visto (retomada de tour estacionado). example: /programs type: string autoResumeCount: description: >- Quantas retomadas automáticas entre sessões o tour já consumiu. example: 0 type: integer minimum: 0 maximum: 9007199254740991 required: - status - lastStepId - completedStepIds - contentVersion - updatedAt additionalProperties: false description: Progresso do usuário em um tour do guia. description: >- Progresso por tour, indexado pelo identificador do tour. screensVisited: type: object propertyNames: type: string additionalProperties: type: string description: >- Rotas do painel já visitadas, com o timestamp ISO 8601 da PRIMEIRA visita. example: /programs: '2026-07-07T12:00:00.000Z' invites: description: >- Timestamps ISO 8601 de quando o convite (toast) de cada tour foi exibido, indexado pelo identificador do tour, no máximo os 5 mais recentes por tour. example: getting-started: - '2026-07-07T12:00:00.000Z' type: object propertyNames: type: string additionalProperties: maxItems: 5 type: array items: type: string preferences: type: object properties: neverShowAgain: type: boolean description: >- Quando `true`, o usuário pediu para nunca mais ver o guia neste painel. example: false required: - neverShowAgain additionalProperties: false description: Preferências do usuário sobre o guia. required: - schemaVersion - tours - screensVisited - preferences additionalProperties: false description: >- Estado completo do guia de onboarding do painel para um usuário em uma organização. updatedAt: anyOf: - type: string - type: 'null' description: >- Timestamp ISO 8601 da última escrita, ou `null` quando o usuário ainda não tem estado gravado (resposta com o estado inicial). example: '2026-07-07T12:00:00.000Z' required: - state - updatedAt additionalProperties: false components: securitySchemes: bearerAuth: type: http scheme: bearer description: >- Chave de API (prefixo `rstr_`) enviada como `Authorization: Bearer rstr_...`. apiKeyAuth: type: apiKey in: header name: x-api-key description: Chave de API (prefixo `rstr_`) enviada no header `x-api-key`. ````