Sign in

v1

latestOpenAPI 3.0.02026-08-063014193.1 MB
Reminders

Return the data for all Reminders

Outlines the parameters, optional and required, used when requesting the data for all Reminders

get/reminders.json

Query parameters

created_sincestring date-time

Filter Reminder records to those having the created_at field after a specific time. (Expects an ISO-8601 timestamp).

fieldsstring

The fields to be returned. See response samples for what fields are available. For more information see the fields section.

ids[]integer

Filter Reminder records to those having the specified unique identifiers.

limitinteger

A limit on the number of Reminder records to be returned. Limit can range between 1 and 200. Default: 200.

notification_method_idinteger

The unique identifier for a single NotificationMethod. The keyword null is not valid for this field. The list will be filtered to include only the Reminder records with the matching property.

order'next_delivery_at(asc)' | 'next_delivery_at(desc)' | 'id(asc)' | 'id(desc)'

Orders the Reminder records by the given field. Default: id(asc).

page_tokenstring

A token specifying which page to return.

state'initializing' | 'scheduling' | 'rescheduling' | 'scheduled' | 'attempting_delivery' | 'delivery_failed' | 'delivered' | 'delivery_skipped' | 'invalid_user'

Filter Reminder records to those with a given state.

subject_idinteger

The unique identifier for a single CalendarEntry or Task. The keyword null is not valid for this field. The list will be filtered to include only the Reminder records with the matching property.

subject_type'calendar_entry' | 'task'

Filter Reminder records to those of a given subject type, required if using subject_id.

updated_sincestring date-time

Filter Reminder records to those having the updated_at field after a specific time. (Expects an ISO-8601 timestamp).

user_idinteger

The unique identifier for a single User. The keyword null is not valid for this field. The list will be filtered to include only the Reminder records with the matching property.

Headers

X-API-VERSIONstring

The API minor version. Default: latest version.

Response

Ok