v1

latestOpenAPI 3.1.0MIT2026-07-243952451019.0 KB

Appointments::ScheduledEvent

List Scheduled Events

get/workspaces/{workspace_id}/appointments/scheduled_events

Path parameters

workspace_idinteger required

Query parameters

afterstring

ID of item after which the collection should be returned. More examples and info about pagination in our guides.

sort_order'asc' | 'desc'

Sort order of a list response. Use 'desc' to reverse the default 'asc' (ascending) sort order. Examples in our guides.

sort_property'id' | 'updated_at'

Sort property of a list response. The default is id and thus the created_at order. If you sort by other properties, we additionally sort by id implicitly as a secondary sort property, so that you can rely on the sort order to be deterministic even if the main sort property ends up with the same values.

Response

idinteger

Scheduled event ID

public_idstring nullable

The unique public identifier for the scheduled event

workspace_idinteger

Workspace ID

start_onstring date-time

Event Start Time

end_onstring date-time nullable

End On

statusstring nullable

Status

max_inviteesinteger nullable

Max Invitees

order_idstring nullable

Event Payment Order

commentsstring nullable

Please share anything that will help prepare for our meeting.

tzidstring nullable

Timezone

created_atstring date-time nullable

Added

updated_atstring date-time nullable

Updated

Example response

[
  {
    "id": 1,
    "public_id": "mdheDs",
    "workspace_id": 42000,
    "start_on": "2025-01-01T00:00:00.000Z",
    "end_on": "2025-01-01T00:00:00.000Z",
    "status": "scheduled",
    "max_invitees": 1,
    "order_id": null,
    "comments": "This is an example scheduled event for testing purposes.",
    "tzid": "America/Los_Angeles",
    "created_at": "2025-01-01T00:00:00.000Z",
    "updated_at": "2025-01-01T00:00:00.000Z",
    "event_type": {
      "name": "30 Minute Meeting"
    },
    "primary_contact": {
      "id": 1,
      "public_id": "uONtxf",
      "email_address": "test-5cc06c0232058b060025@example.com",
      "first_name": "Shanita",
      "last_name": "Lockman",
      "phone_number": "(224) 508-1342 x59891"
    }
  }
]