Follow the question structure recommended by Dev Bot before submitting your integration questions.
EVO API EN
Home
Guides
APIs
π API Pro
π’ News
Home
Guides
APIs
π API Pro
π’ News
Support
Copy Page
Welcome π
π Guides
Getting started with the API
Getting started with the EVO API
Token permissions
Rate limits
API Pro
Understanding the documentation
Using documentation effectively
News
Use cases
Conduct online sales via API
EVO Pay Integration
How to use webhooks
Scheduling a trial lesson
Export to Excel
Bank payment reconciliation
Issuance of Invoice
User access control via external service
Integrate landing page
FAQ
Customer and relationship management
Operations and activities
Financial
Settings and integrations
Suggestions
Implementation suggestion
π API Reference
AccessControl
Post access control entry authorize
Post access control insert manual liberation
Get access control turnstiles
Update access control serial number turnstiles
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
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
Employees
Get employees
Add employees
Update employees
Delete employees
Retrieves employee permissions.
Entries
Get entries
Invoices
Get invoices by date
Management
Returns the aggregator check-in report filtered by origin branch, check-in branch, date range and aggregator.
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
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
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.
Validates parking access authorization and information by CPF (`document`)
Partnership
Get partnerships
Payables
Get payables
Get cost center
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
List PJBank boletos (bank slips) for the authenticated branch.
Collects (registers) a payment for a sale
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
Schemas
Schemas
ClientesAtivosViewModel
ContratoNaoRenovadosViewModel
SpsRelProspectsCadastradosConvertidos
ActiveMembersReturnViewModel
ActivityAreaViewModel
ActivityEmployeesViewModel
ActivityGroupApiViewModel
ActivityGroupViewModel
ActivityResourcesViewModel
ActivityUnavailability
AreaBloqueioAgendaApiViewModel
AtividadeAgendaApiCustomViewModel
AtividadeAgendaApiViewModel
AtividadeAgendaListApiViewModel
AtividadeBasicoApiViewModel
AddressFamily
AtividadeEnrollScheduleApiV2ViewModel
AtividadeListApiViewModel
AtividadeLugarReservaApiViewModel
AtividadeLugarReservaViewModel
AtividadeSessaoAgendaViewModel
AsnEncodedData
AtividadeSessaoParticipanteApiViewModel
BandeirasBasicoViewModel
BankAccountsViewModel
BairroViewModel
BasicFreezeViewModel
BasicMemberMembershipApiViewModel
Assembly
BloqueioAgendaApiViewModel
BonusSessionViewModel
AsymmetricAlgorithm
BranchGatewayViewModel
BusinessHoursViewModel
CancelReceivablesResponseViewModel
CancelReceivablesViewModel
CardDataViewModel
CardTranslationViewModel
CartIdViewModel
CartItemsViewModel
CartViewModel
ChargeReceivableRequestViewModel
ChargeReceivableResponseViewModel
CheckinResponseItemViewModel
CityViewModel
ClienteDetalhesBasicosApiViewModel
ClienteEnotasRetorno
CidadeViewModel
ClienteTransferenciaViewModel
CofinsEnotasRetorno
ColaboradoresBloqueioAgendaApiViewModel
CollectReceivableRequestViewModel
ConfiguracaoApiViewModel
ConjugadoItemRequestApiViewModel
ContractCancellationViewModel
ClientesAtivosRetornoViewModel
ContractSuspensionViewModel
ContratoEntradasApiViewModel
ContratoFiliaisResumoApiViewModel
ByteReadOnlyMemory
ContratosCanceladosParcelasApiViewModel
ContratosCanceladosResumoApiViewModel
ContratosResumoApiViewModel
ByteReadOnlySpan
ContratosResumoPaginaVendaViewModel
ConveniosApiViewModel
CostCenterApiViewModel
CallingConventions
DadosContratoTrasnferenciaApiViewModel
DadosTrocaContratoApiViewModel
DebtorChargesViewModel
DebtorsItensViewModel
CancellationToken
DefaultResponseViewModel
DiferenciaisApiViewModel
DifferentialsViewModel
DropsetItemRequestApiViewModel
EFormaContato
EFormaPagamentoTotem
EOrigemAgendamento
EStatusAtividade
EStatusAtividadeSessao
ESubStatus
ESubStatusApi
ETemperatura
Claim
ETipoContrato
ETipoDocumento
ETipoGateway
ClaimsIdentity
EmployeeApiBranchPermissions
EmployeeApiIntegracaoAtualizacaoViewModel
EmployeeApiIntegracaoViewModel
ClaimsPrincipal
EmpresasConveniosApiViewModel
EmpresasFiliaisOcupacaoViewModel
EnderecoEnotasRetorno
EnotasRetorno
EntradasResumoApiViewModel
ExperimentalClassResponseViewModel
FilialIntegracaoViewModel
FitcoinsResponseViewModel
FreezeViewModel
FreteEnotasRetorno
FuncionariosResumoApiViewModel
ConnectionInfo
GrupoFiliaisIntegracaoViewModel
HttpResponseError
IcmsEnotasRetorno
ConstructorInfo
IdMemberResponseViewModel
ImpostosEnotasRetorno
InformacoesIndicadosViewModel
InstallmentViewModel
IntegracaoBoletoConsultaViewModel
ItenEnotasRetorno
ItensBloqueioAgendaApiViewModel
LiberacaoCatracaManualViewModel
LogTefApiViewModel
MatriculaDetalhesApiV2ViewModel
MatriculaDetalhesApiViewModel
MatricularApiViewModel
EmpresasFiliaisGatewayViewModel
MatricularConfiguracaoApiViewModel
MemberAuthenticateViewModel
MemberBasicResponsibleViewModel
MemberBlockUnblockViewModel
CustomAttributeData
MemberCreditCardApiViewModel
MemberDataViewModel
MemberLevelViewModel
CustomAttributeNamedArgument
MemberMembershipApiViewModel
MemberNewSaleViewModel
MemberParkingViewModel
CustomAttributeTypedArgument
MemberResponsibleViewModel
MemberScheduleApiV2ViewModel
MemberServiceViewModel
EstadoViewModel
MemberTransferViewModel
MembersApiResumidoVendaViewModel
MembersApiViewModel
MembersBasicApiViewModel
MetadadosEnotasRetorno
MobilePushMultiplaViewModel
MobilePushViewModel
MonthDiscountViewModel
NeighborhoodViewModel
NewSaleViewModel
NotificationApiViewModel
NotificationProspectApiViewModel
NotificationResponseViewModel
NovoVoucherViewModel
PagamentoEnotasRetorno
PayablesApiSubTypesViewModel
PayablesApiViewModel
PedidoEnotasRetorno
PercentualAproximadoTributosEnotasRetorno
PeriodizacaoApiViewModel
PisEnotasRetorno
PixPaymentDetailsViewModel
PrescricaoTreinoViewModel
ProblemDetails
ProdutoResumoApiViewModel
ProgressivoItemRequestApiViewModel
ProspectApiIntegracaoAtualizacaoViewModel
ProspectApiIntegracaoViewModel
ProspectIdViewModel
ProspectResponsavelFinanceiroViewmodel
ProspectTransferViewModel
ProspectTransferenciaViewModel
ProspectsResumoApiViewModel
ProtocoloEnotasRetorno
EventAttributes
PublicoAtividadeViewModel
ReceivablesApiResumoVendaViewModel
ReceivablesApiSubTypesViewModel
ReceivablesApiViewModel
EventInfo
ReceivablesApiViewModelListGridComQtdeViewModel
ReceivablesCreditDetails
ReceivablesInvoiceApiViewModel
ReceivablesMaskReceivedViewModel
FieldAttributes
ReconcileReceivablesResponseViewModel
ReconcileReceivablesViewModel
RecursosBloqueioAgendaApiViewModel
FieldInfo
RetornoAgregadoresCheckinMultiFiliaisViewModel
RetornoCatracaViewModel
RetornoEntradaManualViewModel
RevenueCenterApiViewModel
SaleItensViewModel
SalesItemViewModel
SalesItemsViewModel
SalesViewModelV2
SerieItemRequestApiViewModel
GenericParameterAttributes
SeriePrescricaoRequestApiViewModel
ServiceDiscountViewModel
ServicoAdicionalApiViewModel
HostString
ServicoAnualApiViewModel
ServicoEnotasRetorno
ServicosResumoApiViewModel
HttpContext
SimplificadoEnotasRetorno
SpsProspectsServicosInteresses
StateViewModel
SumaryDebtorsViewModel
TaxDataViewModel
HttpRequest
TelefoneApiViewModel
TransferClientResponseViewModel
TransporteEnotasRetorno
HttpResponse
TreinoPrescricaoRequestApiViewModel
UnavailableSpotsResponseViewModel
VendasResumoApiViewModel
VoucherAtributePublicViewModel
ICustomAttributeProvider
VoucherCriacaoViewModel
VoucherItemApiViewModel
VouchersCodigosViewModel
IIdentity
VouchersCodigosViewModelListWithQuantityViewModel
VouchersResumoApiViewModel
W12UtilsCategoryMembershipViewModel
IPAddress
W12UtilsWebhookHeaderViewModel
W12UtilsWebhookViewModel
W12UtilzWebHookFilterViewModel
YearDiscountViewModel
IResponseCookies
autorizaEntradaExternoViewModel
retornoAutorizaEntradaExternoViewModel
IServiceProvider
ISession
IntPtr
KeySizes
LayoutKind
SalesViewModel
MemberInfo
MemberTypes
MethodAttributes
MethodBase
MethodImplAttributes
TimeSpan
MethodInfo
ReverseReceivedResponseViewModel
ReverseReceivedViewModel
Module
ModuleHandle
Oid
ParameterAttributes
ParameterInfo
PathString
PipeReader
PipeWriter
PropertyAttributes
PropertyInfo
PublicKey
QueryString
RuntimeFieldHandle
RuntimeMethodHandle
RuntimeTypeHandle
SafeWaitHandle
SecurityRuleSet
Stream
StringStringKeyValuePair
StringStringValuesKeyValuePair
StructLayoutAttribute
Type
TypeAttributes
TypeInfo
TypeObjectKeyValuePair
WaitHandle
WebSocketManager
X500DistinguishedName
X509Certificate2
X509Extension
ESubStatusApi
Copy Page
0