Skip to main content
GET
List appointments.

Authorizations

Authorization
string
header
required

Authorization header using the Bearer scheme. Accepted values are Leadping user JWT access tokens and WorkOS organization API keys beginning with sk_.

Query Parameters

leadId
string

An optional lead identifier to filter appointments.

dueOnly
boolean

Whether to return only due, undismissed reminders assigned to the current agent.

adminMode
boolean

Whether to browse across organizations. Requires a platform administrator; due-only results remain limited to the current agent.

includeClosed
boolean

Whether to include completed and cancelled appointments. Ignored when dueOnly is true.

Response

The request completed successfully.

isDemo
boolean
createdAt
null | string<date-time>
modifiedAt
null | string<date-time>
history
object[]
id
string
leadId
string
leadFirstName
null | string
leadLastName
null | string
leadEmail
null | string<email>
leadAvatarUrl
null | string<uri>
leadName
string
organizationId
string
organizationName
null | string
assignedToUserId
string
assignedToName
string
startAt
string<date-time>
timeZoneId
string
title
string
notes
null | string
status
string
revision
integer<int64>
reminderAt
string<date-time>
dismissedAt
null | string<date-time>