EVO API EN
Home
GuidesAPIs💎 API Pro📢 News
Home
GuidesAPIs💎 API Pro📢 News
  1. Appointments
  • Welcome 💜
  • 📃 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
    • 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
        GET
      • Retrieves detailed information about scheduled appointment sessions
        GET
      • Get blocked appointments
        GET
      • Get available activities for appointment
        GET
      • Get the available times for appointment
        GET
      • Change status of a member in a appointment
        PATCH
      • Enroll member in activity appointment
        POST
    • 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
    • Employees
      • Get employees
      • Add employees
      • Update employees
      • Delete employees
      • Retrieves employee permissions.
    • Entries
      • Get entries
    • Invoices
      • Get invoices by date
    • Management
      • 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
      • Update prospect
      • 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)
      • Reverses a list of received (paid) receivables back to open status
      • Get cost center
      • Get receivables conciliation report
      • Charge a receivable using a member's credit card
    • 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
      • 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
    • ActivityGroupApiViewModel
    • ActivityAreaViewModel
    • ActiveMembersReturnViewModel
    • AtividadeAgendaApiViewModel
    • ActivityEmployeesViewModel
    • ActivityGroupViewModel
    • AtividadeBasicoApiViewModel
    • AtividadeAgendaApiCustomViewModel
    • ActivityResourcesViewModel
    • AtividadeListApiViewModel
    • ActivityUnavailability
    • AddressFamily
    • AtividadeLugarReservaApiViewModel
    • AreaBloqueioAgendaApiViewModel
    • AtividadeLugarReservaViewModel
    • AsnEncodedData
    • AtividadeSessaoParticipanteApiViewModel
    • AtividadeAgendaListApiViewModel
    • BairroViewModel
    • Assembly
    • AsymmetricAlgorithm
    • BandeirasBasicoViewModel
    • BankAccountsViewModel
    • BasicFreezeViewModel
    • AtividadeEnrollScheduleApiV2ViewModel
    • BasicMemberMembershipApiViewModel
    • AtividadeSessaoAgendaViewModel
    • BonusSessionViewModel
    • BusinessHoursViewModel
    • CardDataViewModel
    • CardTranslationViewModel
    • CartIdViewModel
    • CartItemsViewModel
    • CartViewModel
    • CidadeViewModel
    • BloqueioAgendaApiViewModel
    • ClienteDetalhesBasicosApiViewModel
    • ClienteEnotasRetorno
    • BranchGatewayViewModel
    • ClienteTransferenciaViewModel
    • ClientesAtivosRetornoViewModel
    • CofinsEnotasRetorno
    • ByteReadOnlyMemory
    • ConfiguracaoApiViewModel
    • ByteReadOnlySpan
    • ContratoEntradasApiViewModel
    • CallingConventions
    • ContratoFiliaisResumoApiViewModel
    • CityViewModel
    • CancellationToken
    • ChargeReceivableRequestViewModel
    • ContratosCanceladosParcelasApiViewModel
    • ChargeReceivableResponseViewModel
    • ContratosCanceladosResumoApiViewModel
    • ContratosResumoApiViewModel
    • ContratosResumoPaginaVendaViewModel
    • ColaboradoresBloqueioAgendaApiViewModel
    • ConveniosApiViewModel
    • CostCenterApiViewModel
    • ConjugadoItemRequestApiViewModel
    • Claim
    • DadosContratoTrasnferenciaApiViewModel
    • ClaimsIdentity
    • DadosTrocaContratoApiViewModel
    • ClaimsPrincipal
    • DebtorChargesViewModel
    • DebtorsItensViewModel
    • DefaultResponseViewModel
    • DiferenciaisApiViewModel
    • DifferentialsViewModel
    • EFormaContato
    • EFormaPagamentoTotem
    • EOrigemAgendamento
    • EStatusAtividade
    • ConnectionInfo
    • EStatusAtividadeSessao
    • ConstructorInfo
    • ETemperatura
    • ETipoContrato
    • ETipoDocumento
    • ETipoGateway
    • DropsetItemRequestApiViewModel
    • EmployeeApiIntegracaoAtualizacaoViewModel
    • EmployeeApiBranchPermissions
    • EmployeeApiIntegracaoViewModel
    • EmpresasConveniosApiViewModel
    • ESubStatus
    • EmpresasFiliaisGatewayViewModel
    • EmpresasFiliaisOcupacaoViewModel
    • ESubStatusApi
    • CustomAttributeData
    • EnderecoEnotasRetorno
    • CustomAttributeNamedArgument
    • EnotasRetorno
    • CustomAttributeTypedArgument
    • EntradasResumoApiViewModel
    • EstadoViewModel
    • ExperimentalClassResponseViewModel
    • FitcoinsResponseViewModel
    • FreezeViewModel
    • FreteEnotasRetorno
    • FuncionariosResumoApiViewModel
    • HttpResponseError
    • IcmsEnotasRetorno
    • ImpostosEnotasRetorno
    • InformacoesIndicadosViewModel
    • InstallmentViewModel
    • ItenEnotasRetorno
    • LiberacaoCatracaManualViewModel
    • LogTefApiViewModel
    • MemberAuthenticateViewModel
    • MemberBasicResponsibleViewModel
    • MemberBlockUnblockViewModel
    • MemberDataViewModel
    • MemberMembershipApiViewModel
    • MemberNewSaleViewModel
    • MemberResponsibleViewModel
    • IdMemberResponseViewModel
    • MemberServiceViewModel
    • MemberTransferViewModel
    • ItensBloqueioAgendaApiViewModel
    • MembersApiViewModel
    • MembersBasicApiViewModel
    • MetadadosEnotasRetorno
    • MonthDiscountViewModel
    • NewSaleViewModel
    • MatriculaDetalhesApiV2ViewModel
    • NotificationApiViewModel
    • MatricularApiViewModel
    • EventAttributes
    • NotificationProspectApiViewModel
    • MatricularConfiguracaoApiViewModel
    • EventInfo
    • NotificationResponseViewModel
    • NovoVoucherViewModel
    • FieldAttributes
    • PagamentoEnotasRetorno
    • FieldInfo
    • PayablesApiSubTypesViewModel
    • PayablesApiViewModel
    • PedidoEnotasRetorno
    • PercentualAproximadoTributosEnotasRetorno
    • MemberCreditCardApiViewModel
    • ReceivablesApiResumoVendaViewModel
    • PeriodizacaoApiViewModel
    • GenericParameterAttributes
    • PisEnotasRetorno
    • HostString
    • PixPaymentDetailsViewModel
    • HttpContext
    • PrescricaoTreinoViewModel
    • MembersApiResumidoVendaViewModel
    • MemberScheduleApiV2ViewModel
    • HttpRequest
    • ProblemDetails
    • HttpResponse
    • ProspectApiIntegracaoAtualizacaoViewModel
    • ProspectApiIntegracaoViewModel
    • ICustomAttributeProvider
    • ProspectIdViewModel
    • IIdentity
    • ProspectResponsavelFinanceiroViewmodel
    • IPAddress
    • ProspectTransferViewModel
    • NeighborhoodViewModel
    • IResponseCookies
    • ProspectTransferenciaViewModel
    • IServiceProvider
    • ProspectsResumoApiViewModel
    • ISession
    • ProtocoloEnotasRetorno
    • PublicoAtividadeViewModel
    • ReceivablesApiSubTypesViewModel
    • ReceivablesApiViewModel
    • ReceivablesApiViewModelListGridComQtdeViewModel
    • ReceivablesCreditDetails
    • IntPtr
    • ReceivablesInvoiceApiViewModel
    • VendasResumoApiViewModel
    • ProgressivoItemRequestApiViewModel
    • ReceivablesMaskReceivedViewModel
    • RetornoCatracaViewModel
    • KeySizes
    • RetornoEntradaManualViewModel
    • LayoutKind
    • RevenueCenterApiViewModel
    • SaleItensViewModel
    • SalesItemViewModel
    • SalesItemsViewModel
    • MatriculaDetalhesApiViewModel
    • SalesViewModel
    • ProdutoResumoApiViewModel
    • ServiceDiscountViewModel
    • ServicoAdicionalApiViewModel
    • ServicoAnualApiViewModel
    • ServicoEnotasRetorno
    • ServicosResumoApiViewModel
    • RecursosBloqueioAgendaApiViewModel
    • MemberInfo
    • SimplificadoEnotasRetorno
    • SpsProspectsServicosInteresses
    • MemberLevelViewModel
    • SumaryDebtorsViewModel
    • TaxDataViewModel
    • MemberParkingViewModel
    • TelefoneApiViewModel
    • TransferClientResponseViewModel
    • TransporteEnotasRetorno
    • MemberTypes
    • UnavailableSpotsResponseViewModel
    • VouchersResumoApiViewModel
    • W12UtilsCategoryMembershipViewModel
    • SerieItemRequestApiViewModel
    • W12UtilsWebhookHeaderViewModel
    • SeriePrescricaoRequestApiViewModel
    • MethodAttributes
    • W12UtilsWebhookViewModel
    • MethodBase
    • W12UtilzWebHookFilterViewModel
    • MethodImplAttributes
    • YearDiscountViewModel
    • TimeSpan
    • MethodInfo
    • autorizaEntradaExternoViewModel
    • ReverseReceivedResponseViewModel
    • retornoAutorizaEntradaExternoViewModel
    • MobilePushMultiplaViewModel
    • ReverseReceivedViewModel
    • MobilePushViewModel
    • Module
    • ModuleHandle
    • SalesViewModelV2
    • TreinoPrescricaoRequestApiViewModel
    • Oid
    • VoucherCriacaoViewModel
    • StateViewModel
    • ParameterAttributes
    • VouchersCodigosViewModel
    • ParameterInfo
    • VouchersCodigosViewModelListWithQuantityViewModel
    • PathString
    • PipeReader
    • VoucherAtributePublicViewModel
    • PipeWriter
    • VoucherItemApiViewModel
    • PropertyAttributes
    • PropertyInfo
    • PublicKey
    • QueryString
    • RuntimeFieldHandle
    • RuntimeMethodHandle
    • RuntimeTypeHandle
    • SafeWaitHandle
    • SecurityRuleSet
    • Stream
    • StringStringKeyValuePair
    • StringStringValuesKeyValuePair
    • StructLayoutAttribute
    • Type
    • TypeAttributes
    • TypeInfo
    • TypeObjectKeyValuePair
    • WaitHandle
    • WebSocketManager
    • X500DistinguishedName
    • X509Certificate2
    • X509Extension
  1. Appointments

Retrieves detailed information about scheduled appointment sessions

GET
https://evo-integracao-api.w12app.com.br/api/v1/appointments/schedule/detail
🌐 API Reference/Appointments

Retornar Detalhes das Sessões de Atividades#

Descrição#

Retorna os detalhes completos das sessões de atividades 1:1 disponíveis ou agendadas para um membro, prospect ou colaborador, considerando filtros de data e contexto da sessão.
🛂 A permissão no EVO que libera o acesso a este endpoint é o Atividade - Consulta.

🔑 Parâmetros de Requisição (Query Params)#

ParâmetroTipoObrigatórioDescrição
idMemberint32NãoFiltrar as sessões vinculadas a um aluno específico.
idProspectint32NãoFiltrar as sessões vinculadas a um prospect específico.
idEmployeeint32NãoFiltrar as sessões associadas a um colaborador instrutor.
idActivitySessionint32NãoFiltrar pelo identificador específico da sessão de atividade.
startActivityDate*date-timeNãoData inicial para filtro de sessões (formato ISO 8601).
endActivityDatedate-timeNãoData final para filtro de sessões (formato ISO 8601).

📤 Estrutura da Resposta#

A resposta retorna uma lista de sessões de atividades, contendo informações sobre horários, instrutores, locais, recursos, status e vínculo com membros ou prospects.
CampoTipoDescrição
idActivitySessionint32Identificador único da sessão da atividade.
idGroupActivity*int32ID do grupo de atividade relacionado.
namestringNome da atividade.
datestring (date-time)Data em que a sessão ocorre.
instructorstringNome do instrutor responsável.
instructorPhotostringURL da foto do instrutor.
areastringNome da área/ambiente onde a atividade será realizada.
codestringCódigo identificador da atividade.
weekDayint32Dia da semana da sessão (0 = Domingo, 1 = Segunda, etc).
timeTickint64Horário da sessão representado em ticks.
durationTickint64Duração da sessão representada em ticks.
branchNamestringNome da filial onde a sessão acontece.
descriptionstringDescrição da atividade.
imageUrlstringURL de imagem ilustrativa da atividade.
startTimestringHorário de início da sessão (string formatada).
endTimestringHorário de término da sessão (string formatada).
statusint32Status geral da sessão. Veja mais a seguir.
subStatusint32Substatus adicional da sessão. Veja mais a seguir.
memberStatusstringStatus do membro em relação à sessão (ex.: reservado, aguardando).
memberNamestringNome do aluno vinculado (se aplicável).
idMemberint32ID do aluno participante (0 se não houver).
idProspectint32ID do prospect vinculado (0 se não houver).
idEmployeeint32ID do colaborador instrutor vinculado.
resourcesarrayobjectLista de recursos necessários ou associados à atividade. Veja mais a seguir.

🔷 Enum de status#

CampoValor
Presente0
Falta1
FaltaJustificada2

🔷 Enum de subStatus#

CampoValor
Agendado0
Confirmado1
Presente2
Ausente3
Desmarcado4
Remarcado5
AtividadeNaAgenda6
FaltaJustificada7
PreAgendado8

🧩 Estrutura de resources#

CampoTipoDescrição
idActivityResourceint32Identificador da relação entre a sessão e o recurso.
idActivityint32ID da atividade vinculada ao recurso.
namestringNome do recurso (ex.: “Colchonete”, “Bicicleta”, “Sala 2”).
idResourceint32ID do recurso no cadastro geral.

Request

Authorization
Basic Auth
Send your HTTP requests with an
Authorization
header that contains the word Basic followed by a space and a base64-encoded string username:password
Example:
Authorization: Basic *****************
or
Query Params

Responses

🟢200OK
application/json
Success
Body

🟠400Bad Request
Request Request Example
Shell
JavaScript
Java
Swift
curl --location 'https://evo-integracao-api.w12app.com.br/api/v1/appointments/schedule/detail?idMember=undefined&idProspect=undefined&idEmployee=undefined&idActivitySession=undefined&startActivityDate=undefined&endActivityDate=undefined' \
--header 'Authorization: Basic <encoded-value>'
Response Response Example
200 - Example 1
[
    {
        "idActivitySession": 0,
        "idGroupActivity": 0,
        "name": "string",
        "date": "2019-08-24T14:15:22.123Z",
        "instructor": "string",
        "instructorPhoto": "string",
        "area": "string",
        "code": "string",
        "weekDay": 0,
        "timeTick": 0,
        "durationTick": 0,
        "branchName": "string",
        "description": "string",
        "imageUrl": "string",
        "startTime": "string",
        "endTime": "string",
        "status": 0,
        "subStatus": 0,
        "memberStatus": "string",
        "memberName": "string",
        "idMember": 0,
        "idProspect": 0,
        "idEmployee": 0,
        "resources": [
            {
                "idActivityResource": 0,
                "idActivity": 0,
                "name": "string",
                "idResource": 0
            }
        ]
    }
]
Modified at 2026-05-15 04:38:45
Previous
Get activities
Next
Get blocked appointments
Built with