> ## Documentation Index
> Fetch the complete documentation index at: https://docs.ephra.io/llms.txt
> Use this file to discover all available pages before exploring further.

# Consultar convite de equipe

> Resolve o token de um convite emitido por esta empresa e devolve para quem foi enviado, com que papéis e até quando vale. Use para saber se um convite continua pendente antes de reenviá-lo. Responde 404 quando o convite não existe ou foi emitido por outra empresa.



## OpenAPI

````yaml /openapi.yaml get /v1/team-members/invites/{inviteToken}
openapi: 3.0.3
info:
  title: Ephra API
  description: >-
    API pública da Ephra: cobranças (PIX, cartão e boleto), transações, webhooks
    e a API do vendedor sobre catálogo, checkout, vendas, reembolsos,
    financeiro, crescimento e plataforma.


    **Limite de requisições.** 1000 requisições por minuto por IP de origem.
    Toda resposta traz `x-ratelimit-limit`, `x-ratelimit-remaining` e
    `x-ratelimit-reset` (segundos até a janela zerar); ao estourar o limite a
    resposta é `429` com `retry-after`.


    **Erros.** Toda falha responde o mesmo envelope: `{ "success": false,
    "message": "..." }`.
  version: 1.0.0
servers:
  - url: https://api.ephra.io
    description: Servidor de produção
security: []
tags:
  - name: Catálogo
    description: Produtos, ofertas, categorias e cupons — o que a empresa vende.
  - name: Checkout
    description: Checkouts, order bumps, upsells e links de pagamento.
  - name: Vendas
    description: Vendas, clientes, assinaturas e entregas já realizadas.
  - name: Reembolsos
    description: Pedidos de reembolso, contestações e o quiz de retenção.
  - name: Financeiro
    description: Saldo, saques, antecipações, taxas e extratos da empresa.
  - name: Crescimento
    description: Afiliados, coprodução, indicações, pixels e integrações de marketing.
  - name: Plataforma
    description: Conta, membros, chaves de API, webhooks e configurações gerais.
paths:
  /v1/team-members/invites/{inviteToken}:
    get:
      tags:
        - Plataforma
      summary: Consultar convite de equipe
      description: >-
        Resolve o token de um convite emitido por esta empresa e devolve para
        quem foi enviado, com que papéis e até quando vale. Use para saber se um
        convite continua pendente antes de reenviá-lo. Responde 404 quando o
        convite não existe ou foi emitido por outra empresa.
      operationId: getTeamInvite
      parameters:
        - schema:
            type: string
            minLength: 1
          in: path
          name: inviteToken
          required: true
          description: Token que identifica o convite.
      responses:
        '200':
          description: Convite encontrado.
          content:
            application/json:
              schema:
                type: object
                properties:
                  success:
                    type: boolean
                    description: Sempre `true` em uma resposta bem-sucedida.
                  data:
                    type: object
                    properties:
                      id:
                        type: integer
                        description: Identificador do convite.
                      email:
                        type: string
                        description: E-mail para o qual o convite foi enviado.
                      roles:
                        type: array
                        items:
                          type: string
                          enum:
                            - admin
                            - user
                        description: Papéis que o convidado terá ao aceitar.
                      status:
                        type: string
                        enum:
                          - pending
                          - accepted
                          - expired
                          - canceled
                        description: >-
                          Situação do convite: pendente, aceito, expirado ou
                          cancelado.
                      expired:
                        type: boolean
                        description: >-
                          `true` quando a data de expiração já passou, mesmo que
                          o status ainda seja pendente.
                      expiresAt:
                        type: string
                        format: date-time
                        description: Momento em que o convite deixa de valer.
                      acceptedAt:
                        type: string
                        format: date-time
                        nullable: true
                        description: Momento em que foi aceito, se foi.
                      createdAt:
                        type: string
                        format: date-time
                        description: Momento em que o convite foi enviado.
                    required:
                      - id
                      - email
                      - roles
                      - status
                      - expired
                      - expiresAt
                      - acceptedAt
                      - createdAt
                    additionalProperties: false
                required:
                  - success
                  - data
                additionalProperties: false
                description: Convite encontrado.
              example:
                success: true
                data:
                  id: 1842
                  email: carlos.mendes@minhaloja.com.br
                  roles:
                    - user
                  status: pending
                  expired: false
                  expiresAt: '2026-09-13T12:00:00.000Z'
                  acceptedAt: null
                  createdAt: '2026-09-12T12:00:00.000Z'
        '401':
          description: Token ausente, inválido, expirado ou de empresa bloqueada.
          content:
            application/json:
              schema:
                type: object
                properties:
                  success:
                    type: boolean
                    description: Sempre `false` em uma resposta de erro.
                  message:
                    type: string
                    description: Mensagem legível explicando a falha.
                required:
                  - success
                  - message
                additionalProperties: false
                description: Token ausente, inválido, expirado ou de empresa bloqueada.
              example:
                success: false
                message: Token inválido ou expirado
        '404':
          description: O recurso não existe, foi excluído ou pertence a outra empresa.
          content:
            application/json:
              schema:
                type: object
                properties:
                  success:
                    type: boolean
                    description: Sempre `false` em uma resposta de erro.
                  message:
                    type: string
                    description: Mensagem legível explicando a falha.
                required:
                  - success
                  - message
                additionalProperties: false
                description: >-
                  O recurso não existe, foi excluído ou pertence a outra
                  empresa.
              example:
                success: false
                message: Recurso não encontrado
        '422':
          description: A requisição não passou na validação de schema.
          content:
            application/json:
              schema:
                type: object
                properties:
                  success:
                    type: boolean
                    description: Sempre `false` em uma resposta de erro.
                  message:
                    type: string
                    description: Mensagem legível explicando a falha.
                required:
                  - success
                  - message
                additionalProperties: false
                description: A requisição não passou na validação de schema.
              example:
                success: false
                message: 'name: Nome é obrigatório'
        '429':
          description: >-
            Requisições demais: o limite é de 1000 requisições por minuto por IP
            de origem. Espere o número de segundos do header `retry-after` e
            repita com recuo exponencial.
          content:
            application/json:
              schema:
                type: object
                properties:
                  success:
                    type: boolean
                    description: Sempre `false` em uma resposta de erro.
                  message:
                    type: string
                    description: Mensagem legível explicando a falha.
                required:
                  - success
                  - message
                additionalProperties: false
                description: >-
                  Requisições demais: o limite é de 1000 requisições por minuto
                  por IP de origem. Espere o número de segundos do header
                  `retry-after` e repita com recuo exponencial.
              example:
                success: false
                message: Muitas requisições. Tente novamente em breve.
          headers:
            retry-after:
              $ref: '#/components/headers/retry-after'
            x-ratelimit-limit:
              $ref: '#/components/headers/x-ratelimit-limit'
            x-ratelimit-remaining:
              $ref: '#/components/headers/x-ratelimit-remaining'
            x-ratelimit-reset:
              $ref: '#/components/headers/x-ratelimit-reset'
        '500':
          description: >-
            Falha interna ao processar a requisição. Repita; se persistir, abra
            chamado com o horário e a rota.
          content:
            application/json:
              schema:
                type: object
                properties:
                  success:
                    type: boolean
                    description: Sempre `false` em uma resposta de erro.
                  message:
                    type: string
                    description: Mensagem legível explicando a falha.
                required:
                  - success
                  - message
                additionalProperties: false
                description: >-
                  Falha interna ao processar a requisição. Repita; se persistir,
                  abra chamado com o horário e a rota.
              example:
                success: false
                message: Erro interno do servidor
      security:
        - bearerAuth: []
components:
  headers:
    retry-after:
      description: Segundos a esperar antes de repetir a requisição.
      schema:
        type: integer
    x-ratelimit-limit:
      description: Teto de requisições na janela (1000). Presente em toda resposta.
      schema:
        type: integer
    x-ratelimit-remaining:
      description: >-
        Quantas requisições ainda cabem na janela atual. Presente em toda
        resposta.
      schema:
        type: integer
    x-ratelimit-reset:
      description: Segundos até o contador da janela zerar. Presente em toda resposta.
      schema:
        type: integer
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT

````