Get all Reminders
Reminders
Get all Reminders
| ⚠️ This endpoint is currently in BETA |
|---|
Returns a page of Reminders visible to the caller.
You can filter reminders using the filter query parameter. The filter parameter is a string
that you can specify conditions based on the following properties.
| Property Name | Type | Allowed Operators | Examples |
|---|---|---|---|
id | int64 | = | id=1|id=2|id=3 |
type | enum | = | type=one-time, type=recurring |
status | enum | = | status=active, status=overdue, status=completed |
resetTrigger | enum | = | resetTrigger=interaction, resetTrigger=email, resetTrigger=event |
dueDate | datetime | >, <, >=, <= | dueDate>=2026-01-01T00:00:00Z |
completedAt | datetime | >, <, >=, <= | completedAt=2026-01-01T00:00:00Z |
createdAt | datetime | >, <, >=, <= | createdAt>=2026-01-01T00:00:00Z |
updatedAt | datetime | >, <, >=, <= | updatedAt>=2026-01-01T00:00:00Z |
owner.id | int64 | =, != | owner.id=1|owner.id=2, owner.id!=3 |
creator.id | int64 | = | creator.id=1 |
completer.id | int64 | = | completer.id=1 |
company.id | int64 | = | company.id=42 |
person.id | int64 | = | person.id=42 |
opportunity.id | int64 | = | opportunity.id=42 |
Results are ordered by dueDate ascending (soonest-due first).
GET
Get all Reminders
Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Query Parameters
Include total count of the collection in the pagination response
Cursor for the next or previous page
Example:
"ICAgICAgYmVmb3JlOjo6Nw"
Number of items to include in the page
Required range:
1 <= x <= 100Example:
100
Filter options
Response
OK
A page of Reminder objects.