Reminders
Get all Reminders
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/v2/reminders
Query parameters
totalCountboolean
Include total count of the collection in the pagination response
cursorstring
Example:ICAgICAgYmVmb3JlOjo6Nw
Cursor for the next or previous page
limitinteger
Example:100
Number of items to include in the page
filterstring
Filter options
Response
OK
Example response
{
"data": [
{
"id": 1,
"content": "Follow up about the funding round",
"dueDate": "2026-06-01T17:00:00Z",
"creator": {
"id": 1
},
"owner": {
"id": 1
},
"completer": {
"id": 1
},
"company": {
"id": 1
},
"person": {
"id": 1
},
"opportunity": {
"id": 1
},
"createdAt": "2023-01-01T00:00:00Z",
"updatedAt": "2023-01-01T00:00:00Z"
}
],
"pagination": {
"prevUrl": "https://api.affinity.co/v2/foo?cursor=ICAgICAgYmVmb3JlOjo6Nw",
"nextUrl": "https://api.affinity.co/v2/foo?cursor=ICAgICAgIGFmdGVyOjo6NA"
}
}