List Activity Messages

get

https://api.vcita.biz/v3/communication/activity_messages

Overview

Retrieves a paginated list of activity messages for a business. Activity messages represent communications tied to business activities such as meetings, invoices, payments, and more. Use the available query parameters to filter results by activity type, client, staff, direction, read status, and date range.

Available for Staff tokens.

Message Types Reference

Activity Type	Message Type	Direction	Meaning
Meeting	`schedule_invitation`	`pivot_to_client`	Staff scheduled a new appointment with the client.
Meeting	`schedule`	`client_to_pivot`	Client online scheduled a new appointment, and it was auto-approved.
Meeting	`request`	`client_to_pivot`	Client scheduled a meeting online and it is pending business approval.
Meeting	`request_notification`	`pivot_to_client`	Business sent an automatic reply acknowledging the client's meeting request is being handled.
Meeting	`schedule_update`	`pivot_to_client`	Staff updated the meeting details.
Meeting	`updated`	`pivot_to_client`	Staff updated the meeting details.
Meeting	`updated`	`to_pivot`	Business is notified that meeting details were updated.
Meeting	`cancelled`	`pivot_to_client`	Staff cancelled a meeting with the client.
Meeting	`cancelled`	`client_to_pivot`	Client cancelled a meeting online.
Meeting	`accepted`	`pivot_to_client`	Staff approved a pending meeting request from the client.
Meeting	`accepted`	`client_to_pivot`	Client accepted a tentative meeting scheduled by the staff.
Meeting	`rejected`	`pivot_to_client`	Staff declined a meeting request the client made online.
Meeting	`rejected`	`client_to_pivot`	Client declined a meeting.
Meeting	`completed`	`to_pivot`	The appointment was marked as completed.
Meeting	`reschedule`	`client_to_pivot`	Client rescheduled an appointment online.
Meeting	`reschedule`	`to_pivot`	Business is notified that a meeting was rescheduled.
Meeting	`schedule_client_update`	`client_to_pivot`	Client changed the meeting time online.
Meeting	`schedule_client_update_notification`	`pivot_to_client`	Staff is notified of a change the client made to the appointment online.
Meeting	`propose_time`	`pivot_to_client`	Staff is proposing a new time for the appointment to the client.
Meeting	`please_reschedule`	`pivot_to_client`	Business is asking the client to reschedule the appointment online.
Meeting	`invite`	`pivot_to_client`	Business is inviting the client to schedule online.
Meeting	`rsvp_confirmation`	`client_to_pivot`	Client confirmed attendance to a future meeting.
Meeting	`thank_you_note`	`pivot_to_client`	Staff sent a follow-up thank you message after the meeting.
Meeting	`missed_note`	`pivot_to_client`	Client did not attend the meeting, so staff sends a follow-up message.
Meeting	`expired`	`client_to_pivot`	Client's meeting request expired before the business responded — staff is notified.
Meeting	`expired`	`pivot_to_client`	Client's meeting request expired before the business responded — client is notified.
Meeting	`request_cancelled`	`client_to_pivot`	Client cancelled a meeting request they made online.
Meeting	`request_cancelled`	`pivot_to_client`	Business cancelled a meeting invitation that was not yet approved by the client.
Meeting	`tentative`	`to_client`	Client is notified of a tentatively scheduled meeting pending their confirmation.
Meeting	`meeting_reminder`	`to_pivot`	System sends an upcoming appointment reminder to the business.
Meeting	`meeting_reminder`	`to_client`	System sends an upcoming appointment reminder to the client.
Meeting	`meeting_request_reminder`	`to_client`	Client receives a reminder about their pending meeting request.
Meeting	`meeting_request_reminder`	`to_pivot`	Business receives a reminder about a pending meeting request awaiting approval.
Meeting	`schedule_notification`	`to_client`	Client receives a confirmation notification that a meeting was scheduled.
Meeting	`schedule_update_notification`	`to_pivot`	Business receives a notification that meeting details were updated.
Meeting	`cancelled_notification`	`to_pivot`	Business receives a notification that a meeting was cancelled.
Meeting	`cancelled_notification`	`to_client`	Client receives a notification that a meeting was cancelled.
Meeting	`accepted_notification`	`to_pivot`	Business receives a notification that a meeting request was accepted.
Meeting	`accepted_notification`	`to_client`	Client receives a notification that their meeting was accepted.
Meeting	`add_additional_staff`	`to_pivot`	An additional staff member was assigned to the meeting.
Meeting	`remove_additional_staff`	`to_pivot`	An additional staff member was removed from the meeting.
Meeting	`booking_reassigned`	`to_pivot`	The meeting was reassigned to a different staff member.
Meeting	`dispatch_schedule`	`to_pivot`	A meeting was dispatched and assigned to a staff member.
Meeting	`dispatch_cancel`	`to_pivot`	A dispatched meeting assignment was cancelled.
AppointmentSeries	`scheduled`	`pivot_to_client`	Business scheduled a recurring appointment series with the client.
AppointmentSeries	`scheduled_notification`	`to_pivot`	Business is notified that a recurring appointment series was scheduled.
AppointmentSeries	`schedule_update`	`pivot_to_client`	A recurring appointment series time was updated.
AppointmentSeries	`schedule_update_notification`	`to_pivot`	Business is notified that a recurring appointment series was updated.
AppointmentSeries	`updated`	`pivot_to_client`	Business updated the details of a recurring appointment series.
AppointmentSeries	`updated`	`to_pivot`	Business is notified that a recurring appointment series was updated.
AppointmentSeries	`cancelled`	`pivot_to_client`	Business cancelled a series of appointments.
AppointmentSeries	`cancelled_notification`	`to_pivot`	Business is notified that a recurring appointment series was cancelled.
AppointmentSeries	`add_additional_staff`	`to_pivot`	An additional staff member was assigned to the appointment series.
AppointmentSeries	`remove_additional_staff`	`to_pivot`	An additional staff member was removed from the appointment series.
AppointmentSeries	`booking_reassigned`	`to_pivot`	The appointment series was reassigned to a different staff member.
AppointmentSeries	`dispatch_schedule`	`to_pivot`	An appointment series was dispatched and assigned to a staff member.
AppointmentSeries	`dispatch_cancel`	`to_pivot`	A dispatched appointment series assignment was cancelled.
LinkedBooking	`schedule_invitation`	`pivot_to_client`	Business scheduled several appointments with the client.
LinkedBooking	`cancelled`	`pivot_to_client`	Business cancelled multiple linked meetings with the client.
Invoice	`message_request`	`pivot_to_client`	Staff sent an invoice to the client.
Invoice	`reminder`	`to_pivot`	Business receives a reminder to follow up on an open invoice.
Invoice	`client_reminder`	`to_client`	System sends the client a reminder about an unpaid invoice.
Invoice	`client_reminder`	`pivot_to_client`	Business sends a reminder to the client to pay for an invoice.
Estimate	`request`	`pivot_to_client`	Business sent a new price estimate to the client.
Estimate	`approved`	`client_to_pivot`	Client approved the price estimate.
Estimate	`approved`	`pivot_to_client`	Business sends a confirmed estimate to the client.
Estimate	`rejected`	`client_to_pivot`	Client rejected the price estimate.
Estimate	`rejected`	`pivot_to_client`	Business cancelled a price estimate.
Estimate	`expiring`	`pivot_to_client`	A price estimate is about to expire.
Estimate	`expired`	`to_pivot`	Business is notified that a price estimate has expired.
Payment	`payment_received`	`client_to_pivot`	Client paid online.
Payment	`payment_received`	`to_pivot`	Business is notified that a payment was received.
Payment	`payment_received_notification`	`pivot_to_client`	Client received confirmation of their payment.
Payment	`payment_received_notification`	`to_client`	Client receives a system notification confirming their payment.
Payment	`receipt_sent`	`to_client`	System notification that a receipt was sent to the client.
Payment	`receipt_sent`	`pivot_to_client`	A receipt was sent to the client.
Payment	`receipt_sent`	`to_pivot`	Business is notified that a receipt was sent.
Payment	`bank_payment`	`to_client`	Client receives confirmation of a bank transfer payment.
Payment	`payment_refunded_notification`	`to_client`	System notification that a payment refund was processed.
Payment	`payment_refunded_notification`	`pivot_to_client`	Business refunded a payment to the client.
Payment	`cancelled`	`to_pivot`	Business is notified that a payment was cancelled.
Payment	`payment_pending`	`to_pivot`	Business is notified of a pending payment.
Payment	`payment_failed`	`to_pivot`	Business is notified that a payment attempt failed.
Payment	`payment_offline_refunded_notification`	`to_pivot`	Business is notified of an offline payment refund.
Payment	`archived`	`to_pivot`	Business is notified that a payment was archived.
Payment	`undo_archived`	`to_pivot`	Business is notified that a payment was unarchived.
Payment	`pending_payment_failed`	`to_pivot`	Business is notified that a pending payment failed.
Payment	`scheduled_payment_failed`	`to_pivot`	Business is notified that a scheduled payment failed.
PaymentStatus	`send_link`	`pivot_to_client`	Business sent a payment request link to the client.
PaymentCard	`payment_method_added`	`to_pivot`	Business is notified that a client added a payment method on file.
CardRequest	`card_requested`	`to_client`	Client receives a request to provide their payment card details.
ScheduledPaymentsRule	`scheduled_payments_rule_created`	`pivot_to_client`	Business created a subscription or scheduled payment plan for the client.
EventAttendance	`event_attendance_invite`	`pivot_to_client`	Staff invited the client to register for an event or class.
EventAttendance	`event_attendance_register_notification`	`pivot_to_client`	Staff registered a client for an event or class.
EventAttendance	`event_attendance_client_register`	`client_to_pivot`	Client registered for an event or class online.
EventAttendance	`event_attendance_business_cancel`	`pivot_to_client`	Staff cancelled a client's registration to an event or class.
EventAttendance	`event_attendance_client_cancel`	`client_to_pivot`	Client cancelled their registration to an event or class online.
EventAttendance	`event_attendance_client_cancel_notification`	`pivot_to_client`	Staff is notified that a client cancelled their event or class registration.
EventAttendance	`event_attendance_rescheduled`	`pivot_to_client`	Business changed the time of an event or class.
EventAttendance	`event_attendance_event_cancelled`	`pivot_to_client`	Business cancelled an event or class.
EventAttendance	`rsvp_confirmation`	`client_to_pivot`	Client confirmed arrival to an event or class.
EventAttendance	`event_attendance_reminder`	`to_client`	Client receives a reminder about an upcoming event or class.
EventAttendance	`booking_reassigned`	`to_pivot`	An event registration was reassigned to a different staff member.
EventSeriesAttendance	`event_series_attendance_invite`	`pivot_to_client`	Business invited the client to join a series of events or classes.
EventSeriesAttendance	`event_series_attendance_updated`	`pivot_to_client`	Business updated the details of a series of events or classes.
EventSeriesAttendance	`event_series_attendance_cancelled`	`pivot_to_client`	Business cancelled a client's attendance to a series of events or classes.
EventSeriesAttendance	`booking_reassigned`	`to_pivot`	An event series registration was reassigned to a different staff member.
Waitlist	`register_to_event_waitlist`	`client_to_pivot`	Client requested to join a waitlist for an upcoming event or class.
Waitlist	`register_to_event_waitlist`	`to_client`	Client receives confirmation of their waitlist registration.
Waitlist	`register_to_event_waitlist`	`pivot_to_client`	Business registered a client to a waitlist for an event or class.
Waitlist	`register_to_event_waitlist`	`to_pivot`	Business is notified that a client registered to a waitlist.
Waitlist	`text`	`pivot_to_client`	Business offers a waitlisted client a spot in the event or class.
Waitlist	`cancel_waitlist_registration`	`to_pivot`	Business is notified that a client cancelled their waitlist registration.
ClientBookingPackage	`package_added`	`pivot_to_client`	Business added a package of services to the client's profile.
ClientBookingPackage	`package_purchased`	`client_to_pivot`	Client purchased a package of services online.
ClientBookingPackage	`resend_link`	`pivot_to_client`	Business sent a link to purchase a package to the client.
ProductOrder	`product_added`	`pivot_to_client`	Business added a new product to the client's CRM card.
Announcement	`custom`	`pivot_to_client`	Business sent an invitation to take online actions through the client portal.
Announcement	`close_open_payments`	`pivot_to_client`	Business sent a link to the client portal for payment.
Announcement	`livesite`	`pivot_to_client`	Business is inviting the client to take online actions on their website.
Announcement	`recover_document`	`pivot_to_client`	Business invites the client to re-share a document online.
Document	`document`	`client_to_pivot`	Client shared a document with the business.
Review	`submit_review`	`client_to_pivot`	Client submitted an online review for the business.
VoiceCall	`call`	`client_to_pivot`	Client called the business over the phone (regardless of the call outcome).
General	`text`	`client_to_pivot`	Client replied to the staff.
General	`text`	`pivot_to_client`	Staff replied to the client.
General	`text`	`to_pivot`	A text message was received via an external messaging channel (e.g., Facebook, WhatsApp).
General	`api`	`client_to_pivot`	Client contacted the business (via API-initiated communication).
General	`general_question`	`client_to_pivot`	Client submitted a contact form.
General	`business_text`	`client_to_pivot`	Client replied via SMS to the business.
General	`document`	`client_to_pivot`	Client shared a file with the business.
General	`document`	`pivot_to_client`	Business shared a file with the client.
General	`close_open_payments`	`pivot_to_client`	Business sent a request to the client to pay all open payments.
General	`document_client_pending_approval`	`pivot_to_client`	Business sent a document for client approval.
General	`system`	`client_to_pivot`	Internal CRM activity update.
General	`activity`	`client_to_pivot`	Internal CRM activity recorded for the client.
General	`matter_assigned`	`to_pivot`	A client conversation was assigned to a staff member.
General	`sent_notification`	`to_client`	System notification confirming that a message was sent.
General	`document_client_notification`	`to_client`	Client receives a notification that a document was shared with them.
General	`engagement_reminder`	`to_pivot`	Business receives a reminder to follow up on a client conversation.

Query Params

activity_type

string

enum

Filter by activity type. Limits results to messages associated with a specific type of business activity (e.g., "meeting", "invoice", "payment", "announcement").

activity_action

string

Filter by the specific action or status of the activity (e.g., "scheduled", "created", "cancelled"). Available values depend on the activity_type.

client_uid

string

Filter by client unique identifier. Returns only activity messages associated with the specified client.

staff_uid

string

Filter by staff unique identifier. Returns only activity messages associated with the specified staff member.

conversation_uid

string

Filter by conversation unique identifier. Returns only activity messages that belong to the specified conversation thread.

direction

string

enum

Filter by message direction. Use "business_to_client" for messages sent from the business to the client, or "client_to_business" for messages sent from the client to the business. Note: the response returns the raw direction values which include four possible values: "pivot_to_client" (business sent to client), "client_to_pivot" (client sent to business), "to_pivot" (system notification to the business side), and "to_client" (system notification to the client side). The filter values "business_to_client" and "client_to_business" match against "pivot_to_client" and "client_to_pivot" respectively.

Allowed:

was_read

boolean

Filter by read status. Set to "true" to return only messages that have been read, or "false" for unread messages.

created_after

date-time

Filter messages created on or after this date. Must be a valid ISO 8601 date-time string (e.g., "2026-01-01T00:00:00Z").

created_before

date-time

Filter messages created on or before this date. Must be a valid ISO 8601 date-time string (e.g., "2026-03-01T23:59:59Z").

sort

string

Sort order for results in the format "field:direction" (e.g., "created_at:desc" or "created_at:asc"). Defaults to "created_at:desc" if not specified.

page

integer

≥ 1

Defaults to 1

Page number for pagination. Starts at 1.

per_page

integer

1 to 100

Defaults to 25

Number of results to return per page. Maximum value is 100.

Responses

200Activity messages retrieved successfully.

400Bad Request. The request contains invalid parameters.

401Unauthorized. The bearer token is missing, invalid or not allowed to access the requested resource.

404Not Found. A referenced resource was not found (e.g., conversation_uid does not exist).