Référence de l’API
Chaque endpoint public de l’API, regroupé par thème, généré à partir de la spécification OpenAPI que l’API publie elle-même.
Générée à partir de la spécification de l’API le 2 novembre 2026.
Les descriptions des endpoints viennent directement de la spécification de l’API et sont en portugais pour l’instant. L’interface autour est traduite.
- API introduction
- Authentication
- X-CommunityId
- Creation order
- Responses and errors
- Pagination
- Realtime (WebSocket)
- JavaScript SDK
- Webhooks
- Webhook events
- Fixed IPs
Thèmes
- Auth10 endpointsRegistro, login e recuperação de senha
- Members28 endpointsMembros da comunidade: lista, convite, cadastro, papéis, tags, a própria conta e métodos de pagamento
- Communities26 endpointsCriação e gestão de comunidades
- Hub4 endpointsDiretório de comunidades da Memberfy (hub.memberfy.net): leitura pública e a opção da comunidade
- Access requests1 endpointPedidos de comunidade nova: o formulário do site grava o pedido sem login; o SuperAdmin lista, aprova escolhendo um plano da comunidade Memberfy (cria a comunidade e a assinatura do owner, 90 dias grátis) ou recusa
- Member Imports10 endpointsImportação de membros por planilha (.xlsx ou .csv): análise com sugestão de destino de cada coluna, resumo antes de gravar, processamento assíncrono com relatório, cópia de segurança do arquivo, convite com a origem da lista e recusa do convite (lista de recusa da comunidade). Owner e admin; a recusa é pública, pelo token do e-mail
- Member Fields7 endpointsCampos customizados do cadastro de membros: a comunidade cria os campos (texto, número, data, seleção, sim/não; obrigatório ou não) e cada membro tem os seus valores. Veem a equipe (owner, admin, moderador e financeiro) e o próprio membro; editam owner, admin, moderador e o próprio membro. Cada campo vira a variável de campanha `{{campo_<key>}}`
- Content16 endpointsPosts e conteúdo da comunidade
- Courses41 endpointsCursos, módulos, aulas e matrículas
- Events49 endpointsEventos e participação
- Status12 endpointsStatus curtos estilo Twitter, com reações e comentários
- Feed8 endpointsFeed agregado e recomendações
- Sections & Spaces16 endpointsOrganização da comunidade em seções e espaços
- Subscriptions39 endpointsAssinaturas, grupos e planos
- Products12 endpointsProdutos vendáveis
- Coupons8 endpointsCupons de desconto
- Checkout13 endpointsFluxo de compra e pagamento
- Sales5 endpointsVendas da comunidade (Monetização › Vendas) e reembolsos pela Memberfy, com a escolha de manter ou revogar o acesso
- Ledger2 endpointsLivro-razão financeiro da comunidade
- Exports1 endpointDownload das exportações grandes geradas pela fila (o link do e-mail abre o app, que chama esta rota)
- Payouts12 endpointsSaques e configurações de repasse
- Business4 endpointsDados cadastrais e fiscais da comunidade
- Gamification16 endpointsEngajamento: pontos, níveis e conquistas (módulo `ranking`)
- Badges11 endpointsO catálogo de badges da comunidade e os badges de cada pessoa (Engajamento)
- Integrations12 endpointsIntegrações & APIs: chaves de API pessoais com escopo por módulo e nível (ler; criar e editar; apagar e ações destrutivas), IPs permitidos, revogação e o uso mensal das integrações. Qualquer papel gerencia as próprias chaves; owner e admin veem e revogam todas
- Activity Logs1 endpointRegistros de atividade da comunidade: ações da equipe, do assistente de IA (MCP) e dos membros, numa linha do tempo só
- Moderation17 endpointsDenúncias e ações de moderação
- Uploads22 endpointsUpload de mídia para o S3
- Gallery7 endpointsGaleria de mídia da comunidade
- Call for Papers59 endpointsChamadas de trabalhos: editais, trilhas, propostas, avaliação, voto e negociação
- Certificates25 endpointsCertificados: space, modelos (padrão e arte enviada), emissão em lote, PDF e imagens, revogação e verificação pública por código
- Workflows38 endpointsAutomações por gatilho: um evento do catálogo (cadastro, importação, compra, inscrição em evento, curso concluído…) inicia, para cada pessoa, um desenho com esperas, condições lidas na hora e e-mails da biblioteca, com limites por pessoa e por comunidade, reentrada, simulação e histórico. Owner e admin escrevem; moderador e financeiro leem. Por chave de API (`X-Api-Key`, escopo `workflows:read`), só leitura: listar, ver, versões, histórico de execuções e entregas. Toda escrita (criar, editar, ligar, pausar, retomar, rodar, testar, cancelar, aprovar remetente, limpar, excluir) responde 403 `API_KEY_BLOCKED` para chave e é feita pela sessão no app ou pelo MCP
- Welcome8 endpointsBoas-vindas da comunidade no primeiro acesso: telas com vídeo, regras e campos, obrigatórias ou puláveis, e o acompanhamento de quem concluiu, pulou ou está pendente. A pessoa percorre as próprias; owner e admin configuram
- Email provider5 endpointsEnvio pela conta Resend da própria comunidade (Business e acima): chave e segredo só escrita (só os 4 últimos voltam), remetente do domínio dela, verificação por e-mail de teste e webhook público por token. Os e-mails da comunidade saem pela conta dela; os da plataforma (login, senha, convites com link de acesso, avisos à equipe) pela Memberfy. Só owner e admin
- Video integrations4 endpointsIntegrações de vídeo: a chave do Bunny Stream e a do Cloudflare Stream com que a Memberfy assina a reprodução das aulas e dos posts (URL que expira em até 6 horas). Só escrita (a chave nunca volta, só os 4 últimos), auditada, fora do cofre dos workflows. Só owner e admin
- Vault10 endpointsCofre da comunidade: segredos ("Env") usados pelos nós de HTTP dos workflows como `{{env.NOME}}`, só escrita (o valor nunca volta), com hosts permitidos por segredo, auditoria e o aceite do aviso de dados pessoais (LGPD e GDPR). Só owner e admin
- SMS18 endpointsCanal SMS da comunidade: a equipe liga o canal com o teto diário e vê o uso contra a cota mensal do plano (mensagens e partes, nunca preço); o membro confirma o telefone por código, consente (serviço; marketing em caixa separada) e escolhe em "Avisos desta comunidade" o que recebe por e-mail e por SMS; toda mensagem leva o nome da comunidade e o link de saída de um clique. Só avisos de serviço nesta fase
- Campaigns55 endpointsCampanhas de e-mail: a equipe escreve o e-mail, escolhe o público (toda a base, grupos, tags ou pessoas), vê a prévia, testa em si mesma e envia agora, dentro da cota de envios da comunidade. Descadastro público por link, com a escolha entre parar os comunicados ou todos os e-mails
- Channels19 endpointsCanal: espaço de conversa em grupo em tempo real, um espaço = um canal. Mensagens com a mais nova embaixo (cursor de 50), threads de um nível, reações com qualquer emoji, menções por token `<@idDoPerfil>`, até 10 fotos e 1 vídeo por mensagem, não lidas por canal e por thread, seguir thread, sino e e-mail (categoria `channels`, sem o texto). Quem lê segue o espaço; quem escreve, responde e anexa segue "Quem pode postar"; quem só lê ainda reage. Owner, admin e moderador apagam qualquer mensagem
- Podcast e Vídeos31 endpointsPodcast e Vídeos: dois módulos de espaço com um motor só. O espaço tem programas (um ou vários, `moduleConfig.mode`); o programa tem episódios em áudio (MP3, M4A ou AAC, sem conversão) ou vídeo (streaming como todo vídeo), em rascunho, agendado ou publicado, com capítulos, retomada, fila pessoal, comentários e reações. Owner e admin gerenciam tudo; apresentadores (membro ou moderador escolhidos por programa) publicam só os episódios do programa deles. Quem lê segue as regras do espaço; episódio aberto toca para qualquer membro da comunidade, também em programa pago. Ao publicar, quem tem acesso recebe o aviso por e-mail (categoria "Podcasts e vídeos").
- Upvotes17 endpointsUpvote: espaço-quadro em que membros propõem tópicos (com até 4 fotos), todos votam (um voto por tópico, retirável) e comentam, e a equipe move cada tópico entre Aberto, Planejado, Em andamento, Feito e Arquivado (com motivo), reabre e junta duplicados. Em espaço público, a leitura dispensa login; quem votou só a equipe vê
- Classifieds15 endpointsClassificados: space em que membros anunciam (vaga, serviço, venda) com categoria, prazo, valor informativo e imagens; outros membros demonstram interesse e o anunciante e a equipe veem quem entrou em contato. Não transaciona
- Attendance18 endpointsPresença (coworking): space de uma unidade física com check-in e check-out de membros, quem está aqui e lotação (só número para o membro), saída automática no fim do dia no fuso da comunidade. Check-in do membro só quando a configuração permite; a equipe (owner, admin, moderador e financeiro) marca e corrige
- Embeds1 endpointEmbeds de links: um link vira player (YouTube, Spotify, Vimeo, Loom, Streamable, SoundCloud, Google Maps, Instagram, LinkedIn, Bunny Stream, Cloudflare Stream, Panda Video, HLS) ou cartão de pré-visualização. O editor resolve ao colar; posts e posts curtos trazem `embeds`, preenchido em segundo plano depois de salvar
- Polls6 endpointsEnquetes em posts: a equipe cria uma enquete no campo `poll` de um post curto (espaço de Feed) ou de um post (espaço de Conteúdo); os membros votam e trocam o voto enquanto ela está aberta; a contagem só aparece para quem votou, para a equipe e, encerrada, para todos
- Surveys28 endpointsPesquisas: a equipe (owner e admin) monta um questionário em seções, a partir de um modelo ou do zero, escolhe o público (comunidade toda, grupos, tags, pessoas) e/ou liga um link público que qualquer pessoa responde sem login, e lê o resultado consolidado (NPS, distribuição, taxa de resposta, filtro por segmento, CSV). Identificada ou anônima de verdade, com mínimo de 5 respostas na anônima
- Forms21 endpointsFormulários: módulo de espaço (um formulário ou vários) que coleta dados de membros logados e, quando a equipe libera, de qualquer pessoa pelo link `/f/{token}` (ALTCHA, limite por IP, campo-isca, senha de acesso opcional). Campos de cadastro (nome, e-mail, telefone, empresa, cargo, texto, escolha, número, data, URL, consentimento LGPD), aviso por e-mail aos responsáveis a cada envio, confirmação a quem enviou, lista de envios com status, filtro e CSV, e "Salvar como membro" com tag
- Referrals4 endpointsIndicação: cada membro tem um link (`?ref=<código>`) para trazer gente; quem se cadastra por ele e vira membro conta como indicação de quem indicou, uma vez, sem dinheiro. Owner e admin ligam (desligada por padrão); o membro vê quantos indicou, a equipe vê quem indicou quem e o relatório. A indicação dispara `member.referred` (workflows e webhooks) e a ação de gamificação `REFER_MEMBER` (padrão 0 pontos, conta nas regras de badge "N vezes"). O link nunca fura o modo de entrada da comunidade.
- Recognition20 endpointsReconhecimento: elogio público entre colegas num espaço de Reconhecimento (a comunidade pode ter vários, por time ou área; cada mural mostra só os seus). As rotas que agem num espaço recebem `spaceId`, opcional enquanto a comunidade tem um só; os valores da comunidade são da comunidade, comuns a todos os espaços. Quem abre o espaço reconhece uma ou mais pessoas com uma mensagem e, se houver, um valor da comunidade; o reconhecimento entra no feed, recebe reações e comentários, pode dar pontos de engajamento (GIVE_RECOGNITION e RECEIVE_RECOGNITION, padrão 0) e manda à pessoa reconhecida o e-mail da categoria `recognition`. Owner e admin cuidam dos valores e veem o painel
- Push9 endpointsNotificações no navegador e no celular (Web Push), por comunidade: aparelhos (inscrições) e preferências de quem chama. Sem provedor pago: a API assina com a chave VAPID da plataforma e entrega pelo serviço do próprio navegador. Só o dono lê, testa e apaga (404 para qualquer outro id). Fase 1 envia mensagem de chat, pedido e aceite de conexão, menção e resposta no Canal. Nenhuma rota de Push aceita chave de API (`x-api-key.blocked`): aparelho e preferências são da pessoa, como o chat e a conta.
- Notifications7 endpointsNotificações no app (o sino), por comunidade: só quem recebe lê, marca como lida ou remove (404 para qualquer outro). Genéricas: cada módulo acrescenta os seus tipos; hoje `chat.connectionRequested` e `chat.connectionAccepted`. Só ids no conteúdo, o app traduz pelo tipo. Tempo real pelo socket do chat (`notification.new`).
- Chat26 endpointsMensagens: conversa privada 1:1, em tempo real, entre duas pessoas da mesma comunidade, num painel colado no canto da tela (sem item no menu). Ligado por padrão em toda comunidade; owner e admin podem desligar e escolher quem inicia. Presença: "Disponível para conversar" vem ligado (desde 2026-10-22) e cada pessoa pode desligar; só quem está disponível aparece em "Online agora". Modo "Precisa adicionar" (`startMode: CONNECTION`): conversar pede conexão aceita (`/api/chat/connections`), e a conexão também abre o perfil completo. Só as duas pessoas leem a conversa: não há rota da equipe, do SuperAdmin ou do MCP para mensagens de outras pessoas (404), nem denúncia, moderação ou limite anti-spam. Bloqueio pessoal. Tempo real pelo WebSocket da plataforma (`/api/realtime/socket`, com o ticket de `POST /api/realtime/ticket`; `/api/chat/socket` fica um deploy como apelido); aviso por e-mail sem o texto (categoria `chat`), só para quem está disponível.
- Realtime1 endpointTempo real: um WebSocket por aba (`/api/realtime/socket`, com o ticket de `POST /api/realtime/ticket`) para todo membro, com o chat ligado ou desligado. Salas autorizadas com a regra do `GET` correspondente (`me`, `community`, `staff`, `space:<id>`, `item:<tipo>:<id>`) e avisos `invalidate` só com ids e tópicos: o app refaz o `GET` do que está na tela. Leva também o chat, o sino e o Descrever com IA. `/api/chat/ticket` e `/api/chat/socket` ficam um deploy como apelido.
- Feedbacks24 endpointsFeedbacks: feedback privado entre colegas num espaço de Feedbacks (a comunidade pode ter vários, por time ou área). Cada feedback e cada pedido pertencem ao espaço onde foram dados, e as duas pessoas precisam abrir esse espaço. As rotas que agem num espaço recebem `spaceId`, opcional enquanto a comunidade tem um só; as listas sem `spaceId` juntam os espaços que a pessoa abre. Quem abre o espaço dá feedback (texto rico) a um colega, pede feedback com uma mensagem opcional, responde, recusa ou cancela um pedido, agradece um recebido e apaga o que deu. Só o autor e o destinatário leem o texto (e só quem pediu e a pessoa pedida leem o pedido): qualquer outra pessoa, inclusive owner, admin e SuperAdmin, recebe 404. Owner e admin veem só números no painel. Três e-mails da categoria `feedbacks`, nunca com o texto
- Development Plans21 endpointsPDI: o plano de desenvolvimento individual, no espaço de PDI (a comunidade pode ter vários; tudo é por espaço e cada pessoa tem um PDI ativo por espaço). A pessoa escreve o plano (título, período e ações com prazo), envia para aprovação, marca o andamento das ações e conclui; o líder direto (`reportsToId`, calculado na hora) ou owner/admin aprovam ou devolvem com nota, e podem criar e editar o plano da pessoa; o líder indireto e o financeiro só leem. Ação atrasada é derivada (prazo passou no fuso da comunidade e não está feita). Painel por líder direto para owner, admin e financeiro (o espaço inteiro) e para o líder (a sua subárvore). Quatro e-mails da categoria `developmentPlan`, nunca com o conteúdo do plano
- Performance Review36 endpointsPerformance Review: ciclos de avaliação de desempenho 90°/180°/360° num espaço Performance Review (um ciclo ou vários). Owner e admin criam o ciclo (período avaliado, janela de respostas, público, modelo, perguntas e escala de 5), abrem (as atribuições saem da hierarquia e congelam), acompanham, lembram, fecham (nota calculada) e liberam; o líder acompanha e vê o resultado da sua subárvore ao fechar; cada pessoa responde as suas avaliações em passos e vê o próprio resultado depois de liberado. Quem escreveu avaliação de par ou de liderado nunca aparece, para ninguém. Três e-mails da categoria `performanceReview`, nunca com respostas
- Goals & OKRs16 endpointsMetas & OKRs: ciclos num espaço Metas & OKRs (um ou vários) com objetivos em três níveis (empresa por owner/admin, grupo pelo líder do grupo ou de um grupo acima, pessoal pela pessoa ou pelo líder direto), alinhados ao nível de cima, cada um com 1 ou mais resultados-chave (aumentar, diminuir, manter, entregável) com responsável, unidade e peso. Progresso do objetivo = média ponderada dos próprios KRs. Check-in com valor, farol e nota (sem edição), lembrete semanal por e-mail a quem não atualizou. Objetivo restrito só para o dono, os líderes dele e owner/admin. Dois e-mails da categoria `goalsOkrs`
- One-on-ones28 endpoints1:1: séries recorrentes entre um líder e um liderado direto (uma aberta por par na comunidade), criadas pelo líder, pelo liderado ou por owner/admin. As próximas 4 reuniões; pauta dos dois com "veio da anterior"; notas compartilhadas e só minhas (a privada nunca sai para outra pessoa); combinados que viram ação no PDI. Troca de líder ou saída encerra a série e o histórico fica. Owner/admin e o líder indireto veem só a adesão. Três e-mails da categoria `oneOnOnes`, com `.ics`, nunca com nota
- Time Tracking40 endpointsControle de Ponto: registro eletrônico de ponto via programa nas regras da Portaria MTP 671/2021, em melhor esforço e sem certificação. O estabelecimento (empregador, CNPJ ou CPF) tem escopo de comunidade e numera toda operação com o NSR; o empregado cadastrado (CPF, admissão, cargo) marca o ponto com a hora do servidor, IP e localização (ou "sem localização"), e nada recusa a marcação. O armazenamento é só de inserção (o banco recusa alteração e exclusão). Comprovante em PDF e AFD no leiaute 004 com um `.sha256` próprio, por links privados que expiram. Gestão: owner, admin e financeiro; líderes leem as marcações do time. Tratamento (PTRP): regras em versões com vigência, feriados nacionais e próprios, ajustes (incluir ou desconsiderar, decididos pelo líder direto ou pela gestão, sem tocar o armazenamento nem o AFD), espelho do art. 84, fechamento do mês com totais congelados, ciente da pessoa, exportação CSV e AEJ no leiaute 002 com `.sha256`
- Bookings30 endpointsReservas e Agendamento: recursos reserváveis (salas, mesas, agendas de pessoas), horário semanal e exceções, faixas de preço em créditos, busca, horários livres, reserva, cancelamento e ausência. Instantes em UTC, com o fuso da comunidade na resposta; entrada sem sufixo é hora local
- Scheduling5 endpointsAgendamento: regras de oferta do space (quem oferece, horário pago, aprovação), busca de pessoas com os próximos horários, página do anfitrião e aprovação das agendas de membros. Horário de membro é sempre gratuito
- Networking26 endpointsNetworking: o espaço é o programa (mentoria da comunidade ou da empresa, conexão de negócios, networking de evento). Opções do programa, entrada com ou sem aprovação, fila de aprovação, vitrine com busca, categorias e filtros que respeitam a privacidade da página do membro, e a seção de networking do perfil. A sessão é sempre gratuita; a agenda e a marcação usam o motor do Agendamento
- Parcels19 endpointsEncomendas (coworking): space de uma unidade física onde a equipe (owner, admin, moderador e financeiro) registra carta ou pacote para um residente, com foto privada e local (locker opcional); o residente é avisado por e-mail e vê só as próprias em "Minhas encomendas". O código de retirada do locker só o destinatário vê. Retirada pelo próprio membro (a comunidade pode exigir a confirmação da equipe), devolução e descarte (owner e admin). Nada é apagado
- Visitors10 endpointsVisitantes (coworking): space ligado a um space Presença. O membro (ou quem a configuração permite) cadastra o convidado antes, com dia e janela de horário no fuso da comunidade; o anfitrião recebe a confirmação por e-mail (pela fila); a recepção (owner, admin, moderador e financeiro) vê os esperados de hoje, marca a chegada com um toque (cria ou liga a visita da Presença, sem duplicar) e pode desfazê-la no mesmo dia. O convidado é só texto: nada cria membro nem entra na contagem do plano. NO_SHOW é derivado, não gravado
- Support32 endpointsSuporte (coworking): chamados de manutenção e de pedido entre os residentes e a equipe de um space. O residente abre (com recurso das Reservas ou local em texto, e fotos privadas), acompanha e conversa só nos próprios; a equipe (owner, admin, moderador e financeiro) vê a fila inteira, mas quem **responde** (tria, atribui, muda status, anota por dentro, resolve) é owner/admin e quem a configuração do space (`responders`: tags, grupos, pessoas, por categoria) escolher. Nota interna nunca chega ao residente. E-mails pela fila, sem foto. Sem anonimização nem prazo de guarda
- Companies14 endpointsEmpresas da comunidade: um cadastro próprio, que não é membro nem perfil (não aparece na lista de membros, nas contagens nem nas campanhas), com nome e equipe. Genérica: o bloco de coworking (tipo de residência, início e saída) é opcional. A empresa é assinante e pagadora: o admin da empresa contrata as ofertas, e a equipe com vínculo vivo usa o que ela contratou (`benefits` em `GET /api/companies/mine`). Owner e admin gerenciam; o financeiro lê tudo; o moderador lê sem os campos de contrato; o admin da empresa convida e remove a própria equipe. Status `active`/`ended` calculado na leitura
- Credits10 endpointsCréditos de uso (reservas): livro-razão por perfil que só recebe lançamentos novos. Saldo, extrato, concessão e ajuste pela equipe (owner, admin e financeiro; o moderador só lê) e a configuração da comunidade (acumula ou expira na virada do mês, janela e perda no cancelamento tardio e no no-show)
- Storefront4 endpointsLoja: space que vende produtos da comunidade, com modo all/selected e as regras de acesso do space
- Dashboard3 endpointsMétricas e indicadores
- Reports9 endpointsRelatórios da comunidade em séries prontas para gráfico: vendas, assinaturas, membros, engajamento (pontos e níveis), eventos, cursos, atividade de um membro e painel geral
- Analytics10 endpointsAnalytics próprio da comunidade: coletor do app, online agora, tempo real, pageviews, funil de compra e robôs (buscadores e LLMs)
- Import9 endpointsImportação de dados em massa
- MCP17 endpointsServidor MCP (Claude, ChatGPT, Cursor): OAuth 2.1 com escolha de comunidade, consentimento e conexões
- WhatsApp5 endpointsCanal WhatsApp da comunidade, sobre as peças do SMS: a equipe liga o canal com o teto diário; consentimento, "Avisos desta comunidade" e SAIR por canal; texto livre só na janela de 24 h depois da última mensagem da pessoa ao número, fora dela só modelo aprovado. Respostas e status chegam pelos webhooks do SMS
- Privacy9 endpointsExcluir minha conta (30 dias para desistir, ou o fim do período pago) e a exclusão dos dados de um membro a pedido dele, pela equipe
- Entitlements2 endpointsO que o plano da Memberfy libera para a comunidade (teto de membros, marca, extensões)
- AI3 endpointsMelhorar com IA: reescreve um texto que a pessoa está escrevendo, no mesmo formato e idioma, sem guardar o conteúdo. Qualquer papel da comunidade
- System2 endpointsHealth check e utilidades
- Hierarquia8 endpoints
- Media11 endpoints
- Logs1 endpoint
- Downsell13 endpoints
- Downloads16 endpoints