Pular para o conteúdo principal

Endpoints de Membership

O módulo Membership gerencia pessoas, igrejas, grupos, domicílios, funções, permissões, formulários e configurações. É o maior módulo e fornece a camada central de identidade e autorização para todos os outros módulos.

Caminho base: /membership

Pessoas​

Caminho base: /membership/people

MétodoCaminhoAutenticaçãoPermissãoDescrição
GET/JWTPeople.View ou MemberLista todas as pessoas da igreja
GET/:idJWTPeople.View ou o próprio registroObtém uma pessoa pelo ID (inclui envios de formulários)
GET/ids?ids=JWTPeople.View, Member ou People.ViewNamesObtém várias pessoas por IDs separados por vírgula. Quem chama com People.ViewNames sem People.View recebe o modelo básico, deixando de fora as pessoas que cancelaram a exibição (exceto quem chama)
GET/basic?ids=JWT—Obtém informações básicas (somente o nome) de várias pessoas
GET/names?ids=JWTQualquer permissão da igreja[{ id, name: { display, first, last }, photo }], ordenado por sobrenome e depois nome, para IDs separados por vírgula que quem chama já possui, para que funções sem People.View (doações, presença) possam identificar pessoas. Sem busca, sem filtro de diretório
POST/namesJWTQualquer permissão da igrejaIgual a GET /names. Corpo: { peopleIds } (ou { ids })
GET/recentJWTPeople.View, Member ou People.ViewNamesPessoas adicionadas recentemente. Quem chama com People.ViewNames sem People.View (mesmo membros com acesso ao diretório) recebe o modelo básico (id, name.display, photo, membershipStatus), deixando de fora as pessoas que cancelaram a exibição
GET/guest-register/options?churchId=Pública—Lista de verificação do cadastro de visitantes por QR: retorna { email, phone, address, birthDate, gender, maritalStatus, grade, comments }, cada um com "off", "optional" ou "required" (lido da configuração pública guestRegistrationFields; valores ausentes ou malformados caem para e-mail/telefone opcionais e o restante desativado). Exige enableQRGuestRegistration, a menos que a requisição traga um token de site/igreja correspondente; com limite de taxa (429)
GET/search?term=&email=JWTPeople.View, Member ou People.ViewNamesBusca pessoas por nome ou e-mail (até 100, ordenado por sobrenome e depois nome). Quem chama com People.ViewNames sem People.View (mesmo membros com acesso ao diretório) recebe uma busca por nome que retorna o modelo básico; uma busca por email retorna []
GET/search/phone?number=JWTPeople.View ou MemberBusca por número de telefone
GET/search/group?groupId=JWTPeople.View ou MemberObtém as pessoas de um grupo específico
GET/household/:householdIdJWT—Obtém todas as pessoas de um domicílio
GET/attendanceJWTPeople.EditCarrega os participantes com filtros (campusId, serviceId, serviceTimeId, groupId, categoryName, startDate, endDate)
GET/timeline?personIds=&groupIds=JWT—Carrega os dados de linha do tempo de pessoas e grupos
GET/directory/:idJWT—Obtém a pessoa para a visão de diretório (respeita as preferências de visibilidade)
GET/claim/:churchIdJWT—Reivindica um registro de pessoa para o usuário atual em uma igreja
POST/JWTPeople.Edit ou EditSelfCria ou atualiza pessoas (em lote)
POST/searchJWTPeople.View, Member ou People.ViewNamesBusca pessoas (variante POST). Corpo: { term } ou { email }; mesmas regras de nomes apenas de GET /search
POST/advancedSearchJWTPeople.View ou MemberBusca com múltiplas condições (idade, birthMonth, membershipStatus etc.). O corpo é uma lista de condições; um corpo vazio significa nenhuma condição, e qualquer outro corpo que não seja uma lista retorna 400
POST/loadOrCreatePública—Encontra ou cria uma pessoa pelo e-mail. Corpo: { churchId, email, firstName, lastName }
POST/guest-registerPública—Cadastro de visitantes por QR. Corpo: { churchId, members: [{ firstName, lastName, email?, phone?, birthDate?, gender?, grade? }], address?, maritalStatus?, comments? } (de 1 a 10 membros; email/phone/maritalStatus se aplicam somente ao primeiro membro). Campos que a igreja desativou são descartados; campos obrigatórios ausentes ou valores inválidos retornam 400. Primeiro reutiliza pessoas existentes: um membro corresponde quando exatamente uma pessoa não removida tem o mesmo primeiro nome (sem diferenciar maiúsculas) e o mesmo e-mail ou os mesmos dígitos de telefone (residencial, comercial ou celular); um membro sem e-mail ou telefone corresponde pelo primeiro nome dentro do domicílio correspondido. Pessoas correspondidas nunca são editadas. Membros não correspondidos entram no domicílio correspondido ou, caso contrário, em um novo domicílio (com o sobrenome do primeiro membro), como membershipStatus: "Visitor" com o address compartilhado. Salva comments como uma nota no primeiro membro, adiciona todos ao grupo privado guestRegistrationGroupId, se definido, e — quando guestRegistrationRecordAttendance é "true" — registra a presença nos horários de culto agendados desse grupo cuja janela de check-in esteja aberta agora. Retorna { householdId, people: [{ id, name }] }, repetindo os nomes enviados em vez dos armazenados. Mesmas regras de consentimento/token e de limite de taxa da chamada de opções
POST/household/:householdIdJWTPeople.EditAtualiza as atribuições de membros do domicílio
POST/public/emailPública—Envia um e-mail a uma pessoa. Corpo: { churchId, personId, subject, body, appName }
POST/apiEmailsInterna—Carrega os e-mails de pessoas por IDs (servidor a servidor, exige jwtSecret)
DELETE/:idJWTPeople.EditExclui uma pessoa

Exemplo: buscar pessoas​

GET /membership/people/search?term=John
Authorization: Bearer <token>
[
{
"id": "abc-123",
"name": { "first": "John", "last": "Smith" },
"contactInfo": { "email": "john@example.com" },
"membershipStatus": "Member"
}
]

Exemplo: criar uma pessoa​

POST /membership/people
Authorization: Bearer <token>

[{ "firstName": "Jane", "lastName": "Doe", "contactInfo": { "email": "jane@example.com" } }]

Usuários​

Caminho base: /membership/users

Consulte Autenticação e permissões para os endpoints de login, registro e gerenciamento de senhas.

MétodoCaminhoAutenticaçãoPermissãoDescrição
POST/loginPública—Faz login (e-mail/senha, renovação de JWT ou authGuid)
POST/registerPública—Registra um novo usuário
POST/forgotPública—Envia e-mail de redefinição de senha
POST/setPasswordGuidPública—Define a senha usando o GUID de autenticação do link do e-mail
POST/verifyCredentialsPública—Verifica e-mail/senha e retorna as igrejas associadas
POST/loadOrCreateJWT—Encontra ou cria um usuário pelo e-mail/userId
POST/setDisplayNameJWT—Atualiza o nome e o sobrenome do usuário
POST/updateEmailJWT—Altera o endereço de e-mail do usuário
POST/updatePasswordJWT—Altera a senha do usuário (mínimo de 6 caracteres)
POST/updateOptedOutJWT—Define a situação de cancelamento de exibição de uma pessoa
POST/sendInviteEmailJWTPeople.EditEnvia por e-mail um convite a uma pessoa desta igreja (email, personName, contextName). O botão mostra Cadastrar-se para quem não tem conta e Entrar para um usuário existente. Um usuário que nunca entrou recebe, em vez disso, um link Definir sua senha que expira em 7 dias. Modelo fixo, então não conta no limite diário de e-mails da igreja
GET/search?term=JWTServer.AdminBusca todos os usuários por nome/e-mail
DELETE/JWT—Exclui a conta do usuário atual

Igrejas​

Caminho base: /membership/churches

MétodoCaminhoAutenticaçãoPermissãoDescrição
GET/JWT—Carrega todas as igrejas do usuário atual
GET/:idJWT—Obtém uma igreja pelo ID
GET/:id/getDomainAdminJWT—Obtém o usuário administrador de domínio de uma igreja
GET/:id/impersonateJWTServer.AdminAssume a identidade de uma igreja (somente administrador do servidor)
GET/all?term=JWTServer.AdminBusca todas as igrejas (administrador)
GET/search/?name=Pública—Busca igrejas pelo nome
GET/lookup/?subDomain=&id=Pública—Localiza uma igreja pelo subdomínio ou ID
POST/JWTSettings.EditAtualiza os dados da igreja
POST/addJWT—Registra uma nova igreja. Campos obrigatórios: name, address1, city, state, zip, country
POST/searchPública—Busca igrejas pelo nome (variante POST)
POST/selectJWT—Seleciona/troca para uma igreja. Corpo: { churchId } ou { subDomain }
POST/:id/archiveJWTServer.AdminArquiva ou desarquiva uma igreja
POST/byIdsPública—Carrega várias igrejas pelos IDs
DELETE/deleteAbandonedJWTServer.AdminExclui igrejas abandonadas há 7 dias ou mais

Grupos​

Caminho base: /membership/groups

Estende o CRUD padrão (GET /, GET /:id da classe base).

MétodoCaminhoAutenticaçãoPermissãoDescrição
GET/JWT—Lista todos os grupos
GET/:idJWT—Obtém um grupo pelo ID
GET/search?campusId=&serviceId=&serviceTimeId=JWT—Busca grupos por filtros de culto
GET/myJWT—Obtém os grupos do usuário atual
GET/my/:tagJWT—Obtém os grupos do usuário atual filtrados por tag
GET/tag/:tagJWT—Obtém todos os grupos com uma tag específica
GET/public/:churchId/:idPública—Obtém um grupo público pela igreja e pelo ID
GET/public/:churchId/tag/:tagPública—Obtém grupos públicos por tag
GET/public/:churchId/label?label=Pública—Obtém grupos públicos por etiqueta
GET/public/:churchId/slug/:slugPública—Obtém um grupo público pelo slug
POST/JWTGroups.EditCria ou atualiza grupos (gera o slug automaticamente)
DELETE/:idJWTGroups.EditExclui um grupo (também exclui as equipes filhas de grupos de ministério)

Membros de grupos​

Caminho base: /membership/groupmembers

Estende o CRUD padrão (GET /:id, DELETE /:id da classe base).

MétodoCaminhoAutenticaçãoPermissãoDescrição
GET/:idJWTGroupMembers.ViewObtém um membro de grupo pelo ID
GET/JWTGroupMembers.View*Lista os membros de grupos. Filtre por ?groupId=, ?groupIds= ou ?personId=. *Também permitido se o usuário estiver no grupo ou consultar o próprio personId, e para ?groupId= de qualquer grupo não confidencial quando o usuário tem Attendance.View ou Attendance.Edit (membros com menos de 13 anos são incluídos para eles)
GET/myJWT—Obtém as participações em grupos do usuário atual
GET/basic/:groupIdJWT—Obtém a lista básica de membros de um grupo
GET/public/leaders/:churchId/:groupIdPública—Obtém os líderes de um grupo (público)
GET/public/:churchId/:groupIdPública—Obtém a lista pública de um grupo (campos mínimos: personId, displayName, leader, foto). Somente quando o grupo aceita via publicRoster; alimenta o elemento staffGrid do criador de sites
POST/JWTGroupMembers.EditAdiciona ou atualiza membros de grupos
DELETE/:idJWTGroupMembers.ViewRemove um membro de grupo

Domicílios​

Caminho base: /membership/households

Controller CRUD padrão.

MétodoCaminhoAutenticaçãoPermissãoDescrição
GET/JWT—Lista todos os domicílios
GET/:idJWT—Obtém um domicílio pelo ID
POST/JWTPeople.EditCria ou atualiza domicílios
DELETE/:idJWTPeople.EditExclui um domicílio

Funções​

Caminho base: /membership/roles

MétodoCaminhoAutenticaçãoPermissãoDescrição
GET/:idJWTRoles.ViewObtém uma função pelo ID
GET/church/:churchIdJWTRoles.ViewObtém todas as funções de uma igreja. Cada função inclui memberCount, o número de usuários distintos nela
POST/JWTRoles.EditCria ou atualiza funções
DELETE/:idJWTRoles.EditExclui uma função (também remove suas permissões e membros)

Membros de funções​

Caminho base: /membership/rolemembers

MétodoCaminhoAutenticaçãoPermissãoDescrição
GET/roles/:idJWTRoles.ViewObtém os membros de uma função. Adicione ?include=users para incluir os dados dos usuários
POST/JWTRoles.EditAdiciona membros a uma função (cria o usuário se o e-mail não existir)
DELETE/:idJWTRoles.ViewRemove um membro de função
DELETE/self/:churchId/:userIdJWT—Remove a si mesmo de uma igreja

Permissões de funções​

Caminho base: /membership/rolepermissions

MétodoCaminhoAutenticaçãoPermissãoDescrição
GET/roles/:idJWTRoles.ViewObtém as permissões de uma função (use null como ID para a função "Todos")
POST/JWTRoles.EditCria ou atualiza permissões de funções
DELETE/:idJWTRoles.EditExclui uma permissão de função

Permissões​

Caminho base: /membership/permissions

MétodoCaminhoAutenticaçãoPermissãoDescrição
GET/JWT—Obtém a lista completa de permissões disponíveis

Cada entrada tem apiName, section (tipo de conteúdo), action e os rótulos displaySection / displayAction que o editor de funções do B1Admin exibe. Adições recentes: MembershipApi / People / View Names (Ver nomes de pessoas apenas, em Pessoas e grupos) e GivingApi / Donations / Enter (Lançar doações, em Doações; veja Lotes de doações).

Formulários​

Caminho base: /membership/forms

MétodoCaminhoAutenticaçãoPermissãoDescrição
GET/JWTForms.Admin ou Forms.EditLista todos os formulários (o administrador vê todos; editores veem os atribuídos + os formulários que não são de membros)
GET/:idJWTAcesso ao formulárioObtém um formulário pelo ID
GET/archivedJWTForms.Admin ou Forms.EditLista os formulários arquivados
GET/group/:groupIdJWTMembro do grupo, líder do grupo ou Forms.AdminFormulários independentes vinculados ao grupo (forms.groupId), excluindo os arquivados, ordenados por nome. Retorna id, name, description e open (dentro da janela de disponibilidade). Membros recebem somente formulários abertos; líderes e administradores de formulários também recebem os encerrados. Alimenta os formulários vinculados da página do grupo
GET/standalone/:id?churchId=JWT—Obtém um formulário independente (formulários restritos exigem autenticação)
POST/JWTForms.Admin ou Forms.EditCria ou atualiza formulários. Formulários independentes aceitam photoUrl opcional (foto de cabeçalho exibida acima do formulário) e groupId (grupo vinculado)
DELETE/:idJWTAcesso ao formulárioExclui um formulário

Envios de formulários​

Caminho base: /membership/formsubmissions

MétodoCaminhoAutenticaçãoPermissãoDescrição
GET/JWTForms.Admin ou Forms.EditLista os envios. Filtre por ?personId= ou ?formId=
GET/my?include=questions,answersJWT—Restrito ao próprio usuário: até 50 envios de formulários independentes (não de formulários de pessoas) enviados pelo membro conectado ou vinculados à sua pessoa (contentType person, contentId = o ID da pessoa — por exemplo, após uma troca de pessoa feita por um administrador), do mais recente para o mais antigo, cada um com form.name. include anexa as perguntas de cada formulário e as respostas do envio. Retorna 401 se o usuário não estiver vinculado a uma pessoa. Alimenta a seção Meus formulários da página Eu do B1
GET/group/:groupIdJWTLíder do grupoRespostas para os líderes do grupo: uma entrada por formulário vinculado e por evento do grupo com formulário de inscrição, cada uma com form, event (id, title, start; somente nas entradas de evento), questions e submissions (com answers e personName, null quando anônimo)
GET/:idJWTForms.Admin, Forms.Edit ou acesso de visualizaçãoObtém um envio pelo ID. Adicione ?include=form,questions,answers. Líderes do grupo vinculado ao formulário e líderes do grupo ao qual uma inscrição de evento pertence também podem lê-lo
GET/formId/:formIdJWTAcesso ao formulário (visualização)Obtém todos os envios de um formulário (inclui form, questions, answers). Líderes do grupo vinculado ao formulário têm acesso de visualização
POST/JWT—Envia as respostas do formulário (trata formulários restritos/não restritos, envia notificações por e-mail). Quando o formulário tem autoCreatePerson, encontra ou cria uma pessoa Convidada pelo e-mail e vincula o envio; quando o formulário também tem groupId, adiciona essa pessoa ao grupo; quando followUpSubject/followUpBody estão definidos, envia um e-mail de acompanhamento com modelo para quem enviou. A menos que quem chama possa administrar o formulário, submittedBy é sempre definido como a pessoa do membro conectado (ou fica vazio para envios anônimos)
DELETE/:idJWTForms.Admin ou Forms.EditExclui um envio e suas respostas

Perguntas​

Caminho base: /membership/questions

MétodoCaminhoAutenticaçãoPermissãoDescrição
GET/JWTAcesso ao formulárioLista as perguntas de um formulário. Exige ?formId=
GET/:idJWTAcesso ao formulárioObtém uma pergunta pelo ID
GET/unrestricted?formId=JWT—Obtém as perguntas de um formulário não restrito
GET/sort/:id/upJWT—Move uma pergunta para cima na ordem
GET/sort/:id/downJWT—Move uma pergunta para baixo na ordem
POST/JWTAcesso ao formulárioCria ou atualiza perguntas (atribui a ordem automaticamente)
DELETE/:id?formId=JWTAcesso ao formulárioExclui uma pergunta

Respostas​

Caminho base: /membership/answers

MétodoCaminhoAutenticaçãoPermissãoDescrição
GET/JWTForms.Admin ou Forms.EditLista as respostas. Filtre por ?formSubmissionId=
POST/JWTForms.Admin ou Forms.EditCria ou atualiza respostas

Permissões de membros​

Caminho base: /membership/memberpermissions

Controla o acesso por membro a formulários específicos.

MétodoCaminhoAutenticaçãoPermissãoDescrição
GET/:idJWTAcesso ao formulárioObtém uma permissão de membro pelo ID
GET/member/:idJWTAcesso ao formulárioObtém todas as permissões de formulário de um membro
GET/form/:idJWTAcesso ao formulárioObtém todas as permissões de membros de um formulário
GET/form/:id/myJWTAcesso ao formulárioObtém a permissão do usuário atual para um formulário
POST/JWTAcesso ao formulárioCria ou atualiza permissões de membros
DELETE/:id?formId=JWTAcesso ao formulárioExclui uma permissão de membro
DELETE/member/:id?formId=JWTAcesso ao formulárioExclui todas as permissões de um membro em um formulário

Configurações​

Caminho base: /membership/settings

MétodoCaminhoAutenticaçãoPermissãoDescrição
GET/JWTSettings.EditObtém todas as configurações da igreja
GET/public/:churchIdPública—Obtém as configurações públicas de uma igreja
POST/JWTSettings.EditSalva configurações (aceita upload de imagem em base64)

Domínios​

Caminho base: /membership/domains

Estende o CRUD padrão (GET /:id, GET /, DELETE /:id da classe base).

MétodoCaminhoAutenticaçãoPermissãoDescrição
GET/JWT—Lista todos os domínios
GET/:idJWT—Obtém um domínio pelo ID
GET/lookup/:domainNameJWT—Localiza um domínio pelo nome
GET/public/lookup/:domainNamePública—Localização pública de domínio pelo nome
GET/health/checkPública—Executa a verificação de integridade dos domínios não verificados
POST/JWTSettings.EditCria ou atualiza domínios (aciona a atualização do Caddy)
DELETE/:idJWTSettings.EditExclui um domínio

Userchurch​

Caminho base: /membership/userchurch

Gerencia a associação entre usuários e igrejas.

MétodoCaminhoAutenticaçãoPermissãoDescrição
GET/userid/:userIdJWT—Obtém o registro usuário-igreja pelo ID do usuário
GET/personid/:personIdJWT—Obtém o e-mail do usuário vinculado a uma pessoa
GET/user/:userIdJWTServer.AdminCarrega todas as igrejas de um usuário
POST/JWT—Cria uma associação usuário-igreja
PATCH/:userIdJWT—Atualiza a data do último acesso e registra o acesso
DELETE/record/:userId/:churchId/:personIdJWT—Exclui um registro usuário-igreja

Preferências de visibilidade​

Caminho base: /membership/visibilityPreferences

MétodoCaminhoAutenticaçãoPermissãoDescrição
GET/myJWT—Obtém as preferências de visibilidade do usuário atual
POST/JWT—Salva as preferências de visibilidade (visibilidade de endereço, telefone e e-mail)

Consulta​

Caminho base: /membership/query

MétodoCaminhoAutenticaçãoPermissãoDescrição
POST/membersJWT—Busca de membros em linguagem natural com IA. Corpo: { text, subDomain, siteUrl }

Erros do cliente​

Caminho base: /membership/clientErrors

MétodoCaminhoAutenticaçãoPermissãoDescrição
POST/JWT—Registra um erro do lado do cliente

Páginas relacionadas​