Create, list, and manage meetings
List Meetings
Returns meetings ordered by meeting date (latest/furthest-out first). prospectId, ownerId, meetingType, and meeting date window filters are optional. Results are paginated with limit and pageToken.
query Parameters
prospectIdstringownerIdstringmeetingTypestringmeetingDateAfterOptional lower bound for meetingDate as Unix epoch milliseconds (integer) or ISO 8601 date string.
meetingDateBeforeOptional upper bound for meetingDate as Unix epoch milliseconds (integer) or ISO 8601 date string.
limitinteger · max: 200Default: 50pageTokenstring
Responses
OK
successboolean · requireditemsobject[] · required
nextPageTokenstring | null
Create Meeting
Accepts required meeting scheduling fields prospectId, meetingDate, timeZone, meetingType, ownerId with optional fields, and creates a meeting entry.
Request Body
prospectIdstring · requiredProspect id the meeting is associated with.
meetingDaterequiredMeeting date/time as Unix epoch milliseconds (integer) or ISO 8601 date string.
timeZonestring · requiredIANA time zone name for the meeting (for example, America/New_York).
meetingTypestring · requiredMeeting type label (for example, phone, virtual, in-person).
ownerIdstring · requiredUser id who owns the meeting.
userIdstringOptional user id creating the meeting. When omitted, the meeting is created with
createdBy=null,createdByApi=true, and includes API key attribution metadata when available.locationstring | nullOptional meeting location text.
notesstring | nullOptional internal notes for the meeting.
Responses
Created
idstring · requiredsuccessboolean · required
prospectIdstringmeetingDateinteger · int64Unix timestamp in milliseconds
timeZonestringmeetingTypestringownerIdstringlocationstring | nullnotesstring | nullcreatedBystring | nullcreatedByApibooleanTrue when the meeting was created without a userId via API.
createdByApiKeyIdstring | nullAPI key document id used to create the meeting when authenticated via API key.
createdByApiKeyNamestring | nullAPI key display name used to create the meeting when authenticated via API key.
createdAtinteger · int64Unix timestamp in milliseconds
updatedAtinteger · int64Unix timestamp in milliseconds
reviewobject | null
Get Meeting by ID
Accepts a required meetingId path parameter, retrieves the corresponding meeting record, and returns the meeting object with success status when found.
path Parameters
meetingIdstring · required
Responses
OK
idstring · requiredsuccessboolean · required
prospectIdstringmeetingDateinteger · int64Unix timestamp in milliseconds
timeZonestringmeetingTypestringownerIdstringlocationstring | nullnotesstring | nullcreatedBystring | nullcreatedByApibooleanTrue when the meeting was created without a userId via API.
createdByApiKeyIdstring | nullAPI key document id used to create the meeting when authenticated via API key.
createdByApiKeyNamestring | nullAPI key display name used to create the meeting when authenticated via API key.
createdAtinteger · int64Unix timestamp in milliseconds
updatedAtinteger · int64Unix timestamp in milliseconds
reviewobject | null
Update Meeting
Accepts a required meetingId plus updateable scheduling and ownership fields, applies changes to the existing meeting, and returns a success payload with the meeting id.
path Parameters
meetingIdstring · required
Request Body
userIdstringActing user id for authorization and audit context.
meetingDateUpdated meeting date/time as Unix epoch milliseconds (integer) or ISO 8601 date string.
timeZonestringUpdated IANA time zone name.
meetingTypestringUpdated meeting type label.
ownerIdstringUpdated owner user id.
locationstring | nullUpdated location text, or null to clear.
notesstring | nullUpdated meeting notes, or null to clear.