List Reminder Messages

This endpoint returns the reminder messages Cortex sent for the company's bookings, with their delivery status.

Important Notes

  • Requires reminder_messages:read scope.
  • Served by Cortex, AgendaPro's conversational agent. Phones are returned exactly as stored (e.g. +521… for numbers that came from WhatsApp in Mexico); they are not normalized.
  • from/to need both ends. They are inclusive instants (ISO 8601 date-time with offset, or a date for the whole UTC day); a date that does not exist returns 400, and the range spans at most 31 days.
  • Reminders sent by a reminder automation that was later deleted are not listed: Cortex keeps the sent message but no longer knows it was a reminder.
  • A message can cover several bookings (booking_ids). The client's reply (confirm or cancel) is not stored per message: it changes the booking status, readable with GET /v3/bookings.
  • booking_ids are the bookings in the message's current send group in Cortex, not a snapshot taken when the message was sent. That group can change afterwards (bookings are added to it or removed from it without a new message), so booking_ids is not an exact historical attribution of the bookings the message reminded.

Errors Dictionary

StatusErrorDetailDescription
400invalid_formatlimitlimit is not an integer.
400invalid_rangelimitlimit is out of the allowed range.
400invalid_formatcursorcursor is not a cursor returned by this list.
400requiredfromto was sent without from.
400requiredtofrom was sent without to.
400invalid_formatfromfrom is not a date or an ISO 8601 date-time with offset, or does not exist.
400invalid_formattoto is not a date or an ISO 8601 date-time with offset, or does not exist.
400invalid_rangefromfrom is after to, or the range spans more than 31 days.
400invalid_paramsparamsAnother parameter is invalid.
401unauthorizedinvalid_api_keyMissing or invalid Bearer token.
401unauthorizedapi_config_inactiveAPI access is inactive for this company.
403forbiddenscope_deniedAPI key lacks reminder_messages:read scope.
403forbiddencompany_not_enabledThe company is not enabled to read Cortex data through this API. Contact AgendaPro to enable it; retrying does not help.
429rate_limitedburst_limit_exceededPer-minute request limit exceeded.
429rate_limiteddaily_quota_exceededDaily request quota exceeded.
502upstream_unavailableThe upstream service is unavailable.
502upstream_unavailableupstream_misconfiguredAgendaPro's internal connection to Cortex is misconfigured. It is not a problem with your API key; retry later or contact support.
502upstream_unavailableupstream_errorCortex answered an error. Retry the same request later.
Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params
string

Messages sent at or after this instant. ISO 8601 date-time with offset, or a date (UTC day). Requires to.

string

Messages sent at or before this instant. ISO 8601 date-time with offset, or a date (UTC day). Requires from.

string

Opaque cursor from pagination.next_cursor of the previous page. Omit it for the first page.

integer
1 to 100

Records per page (max 100).

Responses

Language
Credentials
Bearer
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json