Pular para o conteúdo

GET /v1/calendar/appointments

GET
/v1/calendar/appointments
curl --request GET \
--url 'https://seu-endereco-da-api/v1/calendar/appointments?from=example&to=example' \
--header 'Authorization: Bearer <token>'

Permissão que a Chave de acesso precisa: Ler agenda (calendar:read).

from
required
string
to
required
string
resourceId
string format: uuid
serviceId
string format: uuid
assignedUserId
string format: uuid
status
Array<string>
Allowed values: agendado confirmado atendido cancelado faltou

Separados por vírgula: agendado, confirmado, atendido, cancelado, faltou

cursor
string
limit
number
>= 1

1 a 200; padrão 50

Media typeapplication/json
object
items
required
Array<object>
object
id
required
string
startsAt
required
string format: date-time
endsAt
required
string format: date-time
status
required
string
source
required
string
notes
required
string
nullable
cancelReason
required
string
nullable
createdAt
required
string format: date-time
resourceId
required
string
resourceName
required
string
resourceColor
required
string
timezone
required
string
ownerUserId
required
string
nullable
serviceId
required
string
serviceName
required
string
contactId
required
string
contactName
required
string
contactPhoneNumber
required
string
nullable
conversationId
required
string
nullable
createdByUserId
required
string
nullable
createdByName
required
string
nullable
reminderScheduleId
required
string
nullable
taskId
required
string
nullable
meetingUrl
required

Link da reunião (Google Meet ou o link fixo do profissional)

string
nullable
confirmedAt
required

Quando o contato confirmou presença

string format: date-time
nullable
nextCursor
required
string
nullable

Example generated

{
"items": [
{
"id": "example",
"startsAt": "2026-04-15T12:00:00Z",
"endsAt": "2026-04-15T12:00:00Z",
"status": "example",
"source": "example",
"notes": "example",
"cancelReason": "example",
"createdAt": "2026-04-15T12:00:00Z",
"resourceId": "example",
"resourceName": "example",
"resourceColor": "example",
"timezone": "example",
"ownerUserId": "example",
"serviceId": "example",
"serviceName": "example",
"contactId": "example",
"contactName": "example",
"contactPhoneNumber": "example",
"conversationId": "example",
"createdByUserId": "example",
"createdByName": "example",
"reminderScheduleId": "example",
"taskId": "example",
"meetingUrl": "example",
"confirmedAt": "2026-04-15T12:00:00Z"
}
],
"nextCursor": "example"
}