Siga a estrutura de pergunta recomendada pelo Dev Bot antes de enviar suas dúvidas de integração.
EVO API
Início
Guias
APIs
💎 API Pro
📢 Novidades
Início
Guias
APIs
💎 API Pro
📢 Novidades
Suporte
Copiar Página
Boas vindas 💜
📃 Guias
Primeiros passos com a API
Começando a usar a EVO API
Permissões do token
Limites de requisições
API Pro
Conhecendo a documentação
Utilizar a documentação de forma eficaz
Novidades
Casos de uso
Realizar venda online via API
Integração EVO Pay
Como usar o webhook
Agendamento de aula experimental
Chamadas de exportação para Excel
Conciliação de pagamentos via banco
Emissão de Nota Fiscal
Controle de acesso de aluno via serviço externo
Integrar landing page
FAQ
Gestão de clientes e relacionamentos
Operações e atividades
Financeiro
Configurações e integrações
Sugestões
Sugestão de implementação
🌐 API Reference
AccessControl
Post access control entry authorize
Post access control insert manual liberation
Get access control turnstiles
Update access control serial number turnstiles
Get the facial recognition photo of a member, prospect, employee or personal trainer.
Activities
Get activities
Get activities schedule
Get activities schedule details
Create a new experimental class and enroll the member on it
List of spots that are already filled in the activity session
Get activities schedule by idService or idMembership
Book member in activity schedule
Change status of a member in activity schedule
Get activities schedule by enrollment
Create a new enrollment for a member
Delete enrollment
Get enrollment details for a member
Get activity sessions for a member
Appointments
Get activities
Retrieves detailed information about scheduled appointment sessions
Get blocked appointments
Get available activities for appointment
Get the available times for appointment
Change status of a member in a appointment
Enroll member in activity appointment
BankAccounts
Get bank accounts
Create a new bank account
Carts
Get cart by idCartToken
Get cart by idMember or idProspect
Add new cart
Forfeit cart
Configuration
Get branch configurations
Get gateway configurations
Get gateway form token
Get card flag
Get card translation
Get occupation
Get group branches
Get API Pro usage of the current month (hits and costs by period) and the configured cost limit
Employees
Get employees
Add employees
Update employees
Delete employees
Retrieves employee permissions.
Entries
Get entries
FitnessAssessment
Get the branch's custom fitness-assessment protocols (RF-1).
Get a protocol detail (field configuration) of any type (RF-2). The response shape is dynamic per type. Ids are not unique across types, so type selects the source.
Management listing of fitness assessments by period/type/expiration (RF-3). General administration only.
Get the member's answered fitness assessments (RF-4). Requires `idMember` (client-scoped source). When `idFitnessAssessment` is given, returns the full answer detail of that single assessment, with a dynamic shape per protocol type. Otherwise returns th
Add a bioimpedance fitness assessment for the member (RF-5). Returns the created id.
Edit a bioimpedance fitness assessment (RF-6): updates ALL bioimpedance data (measurements, basic data, photos) and the expiry date.
Delete a bioimpedance fitness assessment. Soft delete: the record is kept and flagged as deleted, crediting the employee and the date of the exclusion — same behaviour as the EVO APP flow (`v1/avaliacao-fisica/ExcluirRespostaBioimpedancia`).
Invoices
Get invoices by date
Management
Returns the aggregator check-in report
Get non-renewed clients
Get prospects
Get active clients
MemberMembership
Get summary of MemberMemberships (active, canceled, or specific types).
Get summary of MemberMemberships by id
Cancel MemberMembership
Revert scheduled membership cancellation.
Members
Get member profile
Get members
Retrieves active members from a specific branch or from all branches
Get member services
Get member credit cards
Update a member card number
Authenticate member
Authenticate a member by encrypted id
Get link for reset password
Update a member fitcoins
Get member fitcoins
Get basic member information.
Get member's latest branch transfer
Update basic member data
Transfers a member from one branch to another
Block/unblock member
Send push notification to a specific member
Send push notification to multiple members
Add a responsible to a member
Remove a responsible from a member
Membership
Get memberships
Get memberships categories
Notifications
Insert a member notification
Insert a prospect notification
Parking
Validates parking access authorization by CPF (`document`) or by `idMember` for a specific branch.
Partnership
Get partnerships
Payables
Get payables
Get cost center
PaymentType
Initiates credit card validation
Confirm the card validation
Pix
Get qr-code
Product
Get products
Prospects
Get prospects
Add prospects
Partial update prospect (only provided fields will be updated)
Get prospect services
Transfers a prospect from one branch to another
Get prospect's latest branch transfer
Get interests list
Turn the opportunity into a member, returns the idMember created.
Receivables
Gets a list of debts and current status (Similar to the Collections - Default report)
Creates batch collection attempts for the member membership contracts.
Gets the details of a specific charge batch.
Get receivables
Marks a list of receivables as received (paid)
Cancels a list of receivables
Reconciles a list of receivables with the transaction data informed
Get cost center
Get receivables conciliation report
Charge a receivable using a member's credit card
Collects (registers) a payment for a sale
List PJBank boletos (bank slips) for the authenticated branch.
Sales
Get sale by Id
Get sales
Create a new sale
Get sales bySessionId
Return itens for sale -> site/totem
Service
Get services
States
Get all states for the current user's country
Voucher
Get vouchers
Get all vouchers code by voucher id
Creates a new voucher
Validate the voucher
Webhook
Add new webhook
Remove a specific webhook by id
List all webhooks created
Workout
Change data from a client's prescribed workout
Get all Exercises
Get all default workouts of the new prescription
Get all client's or prospect's or employee's workouts of the new prescription
Get all client's or prospect's or employee's workouts of the new prescription by month, year or idProfessor
Link workout of the new prescription for client
Create a workout of the new prescription
Get the latest workout of each active member of a branch (management view). Only workouts from the new workout version are considered - a member whose workouts all come from the legacy version is reported as having no workout (workoutStatus 0).
Esquemas
Schemas
ClientesAtivosViewModel
ContratoNaoRenovadosViewModel
SpsRelProspectsCadastradosConvertidos
ActiveMembersReturnViewModel
ActivityAreaViewModel
ActivityEmployeesViewModel
ActivityGroupApiViewModel
ActivityGroupViewModel
ActivityResourcesViewModel
ActivityUnavailability
AddressFamily
AreaBloqueioAgendaApiViewModel
AdditionalMembershipApiViewModel
AtividadeAgendaApiCustomViewModel
ApiResultadoConfirmacaoViewModel
AdditionalMembershipNewSaleViewModel
AtividadeAgendaApiViewModel
AsnEncodedData
AddressLocationViewModel
ApiResultadoPreAutorizacaoViewModel
AtividadeAgendaListApiViewModel
ApiProConsumoItemViewModel
AtividadeBasicoApiViewModel
BairroViewModel
ApiProConsumoPeriodoViewModel
AtividadeEnrollScheduleApiV2ViewModel
Assembly
ApiProConsumoUsoViewModel
AtividadeListApiViewModel
ApiProConsumoViewModel
AtividadeLugarReservaApiViewModel
AsymmetricAlgorithm
AtividadeLugarReservaViewModel
AtividadeSessaoAgendaViewModel
AtividadeSessaoParticipanteApiViewModel
BandeirasBasicoViewModel
BankAccountsViewModel
BasicFreezeViewModel
BasicMemberMembershipApiViewModel
AtualizarConfiguracoesEmpresaRequestViewModel
BloqueioAgendaApiViewModel
AtualizarConfiguracoesFinanceirasRequestViewModel
BonusSessionViewModel
AtualizarConfiguracoesVendaRequestViewModel
BusinessHoursViewModel
CancelReceivablesResponseViewModel
CidadeViewModel
CancelReceivablesViewModel
CardDataViewModel
BasicDataDto
CardTranslationViewModel
BranchGatewayViewModel
ClientesAtivosRetornoViewModel
BranchIdentificationViewModel
BioimpedanceCreatedResponse
CartViewModel
BranchOperationViewModel
BioimpedanceRequest
ChargeReceivableRequestViewModel
ChargeReceivableResponseViewModel
ByteReadOnlyMemory
CheckinResponseItemViewModel
CityViewModel
ByteReadOnlySpan
BioimpedanceUpdateRequest
ClienteEnotasRetorno
CardValidationCheckRequestViewModel
ClienteTransferenciaViewModel
CallingConventions
CardValidationStartRequestViewModel
CofinsEnotasRetorno
ColaboradoresBloqueioAgendaApiViewModel
CancellationToken
CartIdViewModel
CartItemsViewModel
ConfiguracaoApiViewModel
ConjugadoItemRequestApiViewModel
ContractCancellationViewModel
ContractSuspensionViewModel
ContratoEntradasApiViewModel
ContratoFiliaisResumoApiViewModel
ContratosCanceladosParcelasApiViewModel
Claim
ContratosCanceladosResumoApiViewModel
ClaimsIdentity
ContratosResumoPaginaVendaViewModel
ClienteDetalhesBasicosApiViewModel
ConveniosApiViewModel
ClaimsPrincipal
CostCenterApiViewModel
DadosContratoTrasnferenciaApiViewModel
ContactViewModel
DadosTrocaContratoApiViewModel
DebtorChargesViewModel
DebtorsItensViewModel
CollectReceivableRequestViewModel
DefaultResponseViewModel
DiferenciaisApiViewModel
DifferentialsViewModel
DropsetItemRequestApiViewModel
EFormaContato
ConnectionInfo
ContratosResumoApiViewModel
EFormaPagamentoTotem
ConstructorInfo
EStatusAtividade
CreateBankAccountRequestViewModel
EStatusAtividadeSessao
ESubStatus
ESubStatusApi
DataPrivacyViewModel
ETemperatura
ETipoContrato
ETipoDocumento
EmpresasFiliaisGatewayViewModel
EmployeeApiBranchPermissions
EmployeeApiIntegracaoAtualizacaoViewModel
EmployeeApiIntegracaoViewModel
CustomAttributeData
EmpresasConveniosApiViewModel
DigitalPresenceViewModel
EmpresasFiliaisOcupacaoViewModel
CustomAttributeNamedArgument
EnderecoEnotasRetorno
EFusoHorario
EnotasRetorno
CustomAttributeTypedArgument
EntradasResumoApiViewModel
ExperimentalClassResponseViewModel
EstadoViewModel
FilialIntegracaoViewModel
FitcoinsResponseViewModel
FreezeViewModel
EOrigemAgendamento
FreteEnotasRetorno
FuncionariosResumoApiViewModel
ETipoGateway
GrupoFiliaisIntegracaoViewModel
HttpResponseError
EStatusTreino
IcmsEnotasRetorno
IdMemberResponseViewModel
ImpostosEnotasRetorno
InformacoesIndicadosViewModel
InstallmentViewModel
IntegracaoBoletoConsultaViewModel
ItenEnotasRetorno
ItensBloqueioAgendaApiViewModel
LiberacaoCatracaManualViewModel
LogTefApiViewModel
FinanceiroAutomaticSettlementViewModel
MatriculaDetalhesApiV2ViewModel
FinanceiroAvailableCeilingViewModel
MatriculaDetalhesApiViewModel
FinanceiroBankSlipExpiredViewModel
MatricularApiViewModel
FinanceiroBankSlipViewModel
MatricularConfiguracaoApiViewModel
FinanceiroCreditsDiscountsViewModel
MemberAuthenticateViewModel
FinanceiroDefaultAccountsViewModel
MemberBasicResponsibleViewModel
MemberBlockUnblockViewModel
FinanceiroFinancialOperationViewModel
FinanceiroDefaultingViewModel
FinanceiroGenerateForOutstandingBalanceViewModel
MemberLevelViewModel
FinanceiroInterestAndFinesViewModel
MemberMembershipApiViewModel
FinanceiroInstallmentRulesViewModel
FinanceiroOnlineSalesByBankSlipViewModel
MemberNewSaleViewModel
FinanceiroPaymentMethodsViewModel
MemberParkingViewModel
EventAttributes
MemberScheduleApiV2ViewModel
EventInfo
FinanceiroRecurringDebitCardViewModel
MemberServiceViewModel
MemberTransferViewModel
FotoFacialIntegracaoViewModel
MembersApiResumidoVendaViewModel
FieldAttributes
FieldInfo
MetadadosEnotasRetorno
FitnessAssessmentManagementResponse
MobilePushMultiplaViewModel
MobilePushViewModel
MonthDiscountViewModel
NeighborhoodViewModel
GenericParameterAttributes
NotificationApiViewModel
NotificationProspectApiViewModel
HostString
NotificationResponseViewModel
NovoVoucherViewModel
HttpContext
PagamentoEnotasRetorno
PayablesApiSubTypesViewModel
HttpRequest
PayablesApiViewModel
PedidoEnotasRetorno
HttpResponse
PaymentDataViewModel
PercentualAproximadoTributosEnotasRetorno
IgnoredReceivableViewModel
PeriodizacaoApiViewModel
PisEnotasRetorno
MemberCreditCardApiViewModel
ICustomAttributeProvider
PixPaymentDetailsViewModel
PrescricaoTreinoViewModel
IIdentity
ManagementWorkoutResponseApiViewModel
ProblemDetails
ProdutoResumoApiViewModel
IPAddress
ProgressivoItemRequestApiViewModel
MemberIdAuthViewModel
IResponseCookies
MemberResponsibleAddViewModel
MemberIdAuthenticatedViewModel
MemberResponsibleViewModel
ProspectIdViewModel
IServiceProvider
MarkReceivedResponseViewModel
ProspectResponsavelFinanceiroViewmodel
ProspectTransferViewModel
ISession
ProspectTransferenciaViewModel
ProtocoloEnotasRetorno
PublicoAtividadeViewModel
ReceivablesApiResumoVendaViewModel
MembersBasicApiViewModel
ReceivablesApiSubTypesViewModel
MemberDataViewModel
ReceivablesApiViewModel
IntPtr
ReceivablesApiViewModelListGridComQtdeViewModel
ReceivablesCreditDetails
ReceivablesInvoiceApiViewModel
ReceivablesMaskReceivedViewModel
KeySizes
MembersApiViewModel
NewSaleViewModel
ReconcileReceivablesResponseViewModel
LayoutKind
ReconcileReceivablesViewModel
RecursosBloqueioAgendaApiViewModel
RetornoAgregadoresCheckinMultiFiliaisViewModel
RetornoCatracaViewModel
RetornoEntradaManualViewModel
RevenueCenterApiViewModel
SalesViewModel
SalesItemViewModel
SalesItemsViewModel
SalesViewModelV2
SerieItemRequestApiViewModel
PlatformSettingsViewModel
SeriePrescricaoRequestApiViewModel
ServiceDiscountViewModel
MemberInfo
ServicoAdicionalApiViewModel
ServicoAnualApiViewModel
ServicoEnotasRetorno
ServicosResumoApiViewModel
SimplificadoEnotasRetorno
SpsProspectsServicosInteresses
StateViewModel
SumaryDebtorsViewModel
TaxDataViewModel
MemberTypes
TelefoneApiViewModel
TransferClientResponseViewModel
TransporteEnotasRetorno
ProspectApiIntegracaoAtualizacaoViewModel
TreinoPrescricaoRequestApiViewModel
ProspectApiIntegracaoViewModel
UnavailableSpotsResponseViewModel
MethodAttributes
VendasResumoApiViewModel
VoucherAtributePublicViewModel
MethodBase
VoucherCriacaoViewModel
VoucherItemApiViewModel
MethodImplAttributes
ProspectsResumoApiViewModel
TimeSpan
VouchersCodigosViewModel
VouchersCodigosViewModelListWithQuantityViewModel
ProtocolResponse
VouchersResumoApiViewModel
MethodInfo
W12UtilsCategoryMembershipViewModel
W12UtilsWebhookHeaderViewModel
W12UtilsWebhookViewModel
W12UtilzWebHookFilterViewModel
Module
YearDiscountViewModel
autorizaEntradaExternoViewModel
ModuleHandle
retornoAutorizaEntradaExternoViewModel
SaleItensViewModel
ReverseReceivedResponseViewModel
ReverseReceivedViewModel
RestricaoTreinoResumoApiViewModel
Oid
ParameterAttributes
ParameterInfo
PathString
VendaAuthorizedBranchesViewModel
VendaBranchIntegrationViewModel
VendaClientRulesViewModel
VendaCommercialRulesViewModel
PipeReader
VendaCommissioningViewModel
VendaCommunicationViewModel
PipeWriter
VendaContractSignatureViewModel
VendaDocumentsViewModel
VendaExpirationTimeViewModel
TagTreinoResumoApiViewModel
VendaFinancialPendingViewModel
VendaOnlineContractsViewModel
VendaPromotionsViewModel
VendaReceiptViewModel
PropertyAttributes
VendaSaleIntentLinkViewModel
VendaSaleRestrictionsViewModel
PropertyInfo
PublicKey
QueryString
RuntimeFieldHandle
RuntimeMethodHandle
RuntimeTypeHandle
SafeWaitHandle
SecurityRuleSet
Stream
StringStringKeyValuePair
StringStringValuesKeyValuePair
StructLayoutAttribute
Type
TypeAttributes
TypeInfo
TypeObjectKeyValuePair
WaitHandle
WebSocketManager
X500DistinguishedName
X509Certificate2
X509Extension
IResponseCookies
Copiar Página
{
}