Eventos

Pesquisar

get/events

Request

  • Base URL: https://api.apresenta.me
  • URL: https://api.apresenta.me/events
  • Auth: HTTP bearer

Query parameters

sortstring

Campo para ordenar os registros

Example:id
fieldsstring

Lista de campos separados por vírgula sem espaço para incluir na resposta

Example:id, description
filter[id]integer

ID do Evento

Example:2
filter[father_id]integer

ID do Evento Pai

Example:10
filter[recurrence_id]integer

ID da Recorrência

Example:5
filter[calendar_id]integer

ID do Calendário

Example:3
filter[title]string

Título do Evento

Example:Reunião mensal
filter[type]string

Tipo do Evento. Valores permitidos:

  • task: Tarefa
  • reminder: Lembrete
  • meet: Reunião
  • visit: Visita
  • whatsapp: WhatsApp
  • email: E-mail
  • call: Ligação
  • inspect: Vistoria
  • maintenance: Manutenção
  • billing: Cobrança
Example:task
filter[status]string

Status do Evento Valores permitidos:

  • cancelled: Cancelado
  • concluded: Concluído
  • scheduled: Agendado
  • recurrent: Recorrente
  • late: Atrasado
  • five_days_late: +5 dias de atraso
  • thirty_days_late: +1 mês atrasado
Example:scheduled
filter[guest][]integer[]

IDs dos Convidados

filter[guest_group][]integer[]

IDs dos Grupos de Convidados

filter[guest_access]string

Tipo de acesso dos convidados Valores permitidos:

  • full: Acesso total
  • invite: Editar convidados
  • view: Visualizar
Example:full
filter[tag][]integer[]

IDs das Tags

filter[initial_date]string

date Data inicial do Evento

Example:2025-06-10
filter[final_date]string

date Data final do Evento

Example:2025-06-11
filter[time_zone]string

Fuso horário Valores permitidos:

  • America/Sao_Paulo: Horário de Brasília -3:00
  • America/Noronha: Noronha -2:00
  • America/Manaus: Manaus -4:00
  • America/Rio_Branco: Rio Branco -5:00
  • Atlantic/Azores: Açores -1:00
  • America/Costa_Rica: Costa Rica -6:00
  • America/Tijuana: Tijuana -7:00
  • America/Sitka: Sitka -8:00
  • Pacific/Gambier: Gambier -9:00
  • Pacific/Honolulu: Honolulu -10:00
  • Pacific/Midway: Midway -11:00
Example:America/Sao_Paulo
filter[created_by]integer

ID do Criador

Example:7
filter[building_id]integer

ID do Imóvel

Example:12
filter[deal_id]integer

ID do Negócio

Example:8
filter[contract_id]integer

ID do contrato

Example:123456
filter[person_id]integer

ID da Pessoa

Example:5
filter[invite_person]boolean

Se convidou pessoa

Example:true
filter[endless]boolean

Evento sem fim

Example:true
filter[all_day]boolean

Evento o dia todo

Example:true
filter[description]string

Descrição do Evento

Example:Discussão de metas
filter[address]string

Endereço do Evento

Example:Av. Paulista, 1000
filter[reminder][]string[]

Lembretes do Evento Valores permitidos:

  • START: Ao Iniciar ao Evento
  • 5_MIN: 5 minutos antes de começar
  • 15_MIN: 5 minutos antes de começar
  • 30_MIN: 0 minutos antes de começar
  • 1_HOUR: 1 hora antes de começar
  • 2_HOUR: 2 horas antes de começar
  • 6_HOUR: 6 horas antes de começar
  • 1_DAY: 1 dia antes de começar
  • 2_DAY: 2 dias antes de começar
  • 5_DAY: 5 dias antes de começar
  • 1_WEEK: 1 semana antes de começar
  • 2_WEEK: 2 semanas antes de começar
  • 1_MONTH: 1 mês antes de começar
filter[private]boolean

Evento privado

Example:true
filter[recurrency]string

Recorrência do Evento Valores permitidos:

  • daily: Diária
  • weekly: Semanal
  • monthly: Mensal
  • yearly: Anual
Example:weekly
filter[accessible]integer

Filtra eventos acessíveis pelo usuário informado

Example:7
filter[descendant][]integer[]

Filtra eventos descendentes do ID informado

filter[guestsIn][]integer[]

Filtra eventos onde o usuário é convidado

filter[responsibleIn][]integer[]

Filtra eventos onde o usuário é responsável

filter[userIn][]integer[]

Filtra eventos pelo(s) usuário(s) convidado(s)

filter[responsibleGroupIn][]integer[]

Filtra eventos pelo(s) grupo(s) responsável(is)

filter[creatorIn][]integer[]

Filtra eventos pelo(s) criador(es)

filter[calendarIn][]integer[]

Filtra eventos pelo(s) calendário(s)

filter[calendarOrInvitedIn][]integer[]

Filtra pelo(s) calendário(s) e inclui os eventos em que o usuário é convidado em agenda sem acesso

filter[createdBetween][]string[]

Filtra eventos pela data de criação (intervalo)

filter[typeIn][]string[]

Filtra eventos pelos tipos

filter[dateMinMax][]string[]

Filtra eventos pela data inicial (intervalo)

filter[isLate]boolean

Filtra eventos atrasados

Example:true
filter[isNotRecurrence]boolean

Filtra eventos que não são recorrências

Example:true
filter[isCancelled]boolean

Filtra eventos cancelados

Example:true
filter[notCancelled]boolean

Filtra eventos não cancelados

Example:true
filter[scheduledBetween][]string[]

Filtra eventos agendados entre datas

filter[active]boolean

Filtra eventos ativos

Example:true
filter[statusIn][]string[]

Filtra eventos pelos status

filter[statusNotIn][]string[]

Filtra eventos excluindo status

filter[recurrencyIn][]string[]

Filtra eventos pela recorrência

filter[hasReminder]boolean

Filtra eventos com lembrete

Example:true
filter[hasAnyReminder]boolean

Filtra eventos com qualquer lembrete

Example:true
filter[buildingIn][]integer[]

Filtra eventos pelo(s) imóvel(is)

filter[dealIn][]integer[]

Filtra eventos pelo(s) negócio(s)

filter[personIn][]integer[]

Filtra eventos pela(s) pessoa(s)

filter[googleId]string

Filtra eventos pelo Google ID

Example:abc123
filter[occurrenceBetween][]string[]

Filtra eventos por ocorrência entre datas

filter[yearBetween][]string[]

Filtra eventos recorrentes anuais entre datas

filter[monthBetween][]string[]

Filtra eventos recorrentes mensais entre datas

filter[weekBetween][]string[]

Filtra eventos recorrentes semanais entre datas

filter[dayBetween][]string[]

Filtra eventos recorrentes diários entre datas

filter[nonRecurring]boolean

Filtra eventos não recorrentes

Example:true
include[guests]string

Incluir dados dos Convidados

Example:id,name,email
include[guestGroups]string

Incluir dados dos Grupos de Convidados

Example:id,name,users
include[tags]string

Incluir dados das Tags

Example:id,name
include[creator]string

Incluir dados do Criador

Example:id,name,email
include[calendar]string

Incluir dados do Calendário

Example:id,title
include[person]string

Incluir dados da Pessoa

Example:id,name
include[building]string

Incluir dados do Imóvel

Example:id,title
include[deal]string

Incluir dados do Negócio

Example:id,title
include[parent]string

Incluir dados do Evento Pai

Example:id,title
include[childs]string

Incluir dados dos Eventos Filhos

Example:id,title
include[arisingFrom]string

Incluir dados do Evento de Origem

Example:id,title
include[recurrences]string

Incluir dados das Recorrências

Example:id,title
include[cancelled]string

Incluir dados das Recorrências Canceladas

Example:id,title
include[files]string

Incluir arquivos anexados

Example:id,file_name,url
include[lastFeedback]string

Incluir último feedback

Example:id,date,history_type_id
include[contract]string

Incluir dados do Contrato

Example:id,type

Changes

No recorded changes to this operation across all 1 revision of this API.