REST API endpoint for listing prospect appointments

The appointments endpoint returns scheduled appointments across every prospect in your company. You can filter by date range to build a daily or weekly calendar view, sync upcoming appointments to an external calendar system, or report on appointment volume over time. Each appointment record includes a reference to the parent prospect and the user who created it.

Calendar access must be enabled on your plan. Requests from accounts without calendar access return 403 with the message "Calendar access not available on your plan".

List appointments

GET /api/appointments

Returns all non-deleted appointments for prospects in your company, ordered by appointmentTime ascending (earliest first).

Query parameters

string

ISO 8601 date string. Returns only appointments scheduled on or after this date. Example: 2024-06-01

string

ISO 8601 date string. Returns only appointments scheduled on or before this date. Example: 2024-06-30

Response

Returns an array of appointment objects directly (not paginated).

number

Appointment ID.

string | null

ISO 8601 scheduled time for the appointment.

number | null

Duration of the appointment in minutes.

string

ISO 8601 creation timestamp.

object

Summary of the associated prospect.

Show prospect

number

Prospect ID.

string | null

Prospect’s full name.

object | null

Show address

string

Street line 1.

string

City.

string

State.

string

ZIP code.

object

The user who created this appointment.

Show createdBy

number

User ID.

string

First name.

string

Last name.

curl --request GET \
  --url 'https://app.leadscoutapp.com/api/appointments?dateFrom=2024-06-01&dateTo=2024-06-30' \
  --header 'Authorization: Bearer YOUR_ACCESS_TOKEN'

const response = await fetch(
  'https://app.leadscoutapp.com/api/appointments?dateFrom=2024-06-01&dateTo=2024-06-30',
  { headers: { Authorization: `Bearer ${accessToken}` } }
);
const appointments = await response.json();

To create or delete an appointment on a specific prospect, use POST /api/prospects/:id/appointments or DELETE /api/prospects/:id/appointments/:appointmentId. The /api/appointments endpoint is read-only and is best used for calendar aggregation.

Overview

Endpoints

REST API endpoint for listing prospect appointments

List appointments

Query parameters

Response

​List appointments

​Query parameters

​Response

List appointments

Query parameters

Response