> ## Documentation Index
> Fetch the complete documentation index at: https://deepline.com/docs/llms.txt
> Use this file to discover all available pages before exploring further.

# Affinity: V2 Reminders Get

> Get all Reminders. Affinity V2 Reminders Get reference includes SDK V2 and CLI requests, input constraints, response fields, and Deepline cost.

Get all Reminders.

<Info>
  Tool ID: `affinity_v2_reminders_get`
</Info>

## Run this action

Use the TypeScript SDK for a single call. Put `ctx.tools.execute(...)` inside a Play when the call should be durable, scheduled, or run across a CSV.

```ts theme={null}
import { Deepline } from 'deepline';

const deepline = await Deepline.connect();
const result = await deepline.tools.execute(
  'affinity_v2_reminders_get',
  {
    "totalCount": false,
    "cursor": "cursor_123",
    "limit": 100
  },
);

console.log(result.toolResponse.raw);
```

### CLI

```bash theme={null}
deepline tools execute affinity_v2_reminders_get --input '{
  "totalCount": false,
  "cursor": "cursor_123",
  "limit": 100
}' --json
```

## Example response

The static output schema is not detailed enough to generate a reliable example. Use `deepline tools get affinity_v2_reminders_get --json` for the complete live contract.

## Input reference

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` | `&gt;`, ` =`, ` =2026-01-01T00:00:00Z` | | `completedAt` | `datetime` | `&gt;`, ` =`, ` `, ` =`, ` =2026-01-01T00:00:00Z` | | `updatedAt` | `datetime` | `&gt;`, ` =`, ` =2026-01-01T00:00:00Z` | | `owner.id` | `int64` | `=`, `!=` | `owner.id=1\\|owner.id=2`, `owner.id!=3` | | See the live schema below for the complete notes.

| Name                 | Type      | Required | Default | Details                                                                           |
| -------------------- | --------- | -------- | ------- | --------------------------------------------------------------------------------- |
| `payload.totalCount` | `boolean` | No       | `false` | Include total count of the collection in the pagination response                  |
| `payload.cursor`     | `string`  | No       | —       | Cursor for the next or previous page                                              |
| `payload.limit`      | `integer` | No       | `100`   | Number of items to include in the page Format: `int32`. Minimum: 1. Maximum: 100. |
| `payload.filter`     | `string`  | No       | —       | Filter options                                                                    |

<details>
  <summary>Show raw input schema</summary>

  ### Input JSON Schema

  ```json theme={null}
  {
    "type": "object",
    "description": "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` | `>`, ` =`, ` =2026-01-01T00:00:00Z` | | `completedAt` | `datetime` | `>`, ` =`, ` `, ` =`, ` =2026-01-01T00:00:00Z` | | `updatedAt` | `datetime` | `>`, ` =`, ` =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).",
    "properties": {
      "totalCount": {
        "type": "boolean",
        "description": "Include total count of the collection in the pagination response",
        "default": false
      },
      "cursor": {
        "type": "string",
        "description": "Cursor for the next or previous page"
      },
      "limit": {
        "type": "integer",
        "description": "Number of items to include in the page",
        "default": 100,
        "minimum": 1,
        "maximum": 100,
        "format": "int32"
      },
      "filter": {
        "type": "string",
        "description": "Filter options"
      }
    },
    "required": [],
    "additionalProperties": false
  }
  ```
</details>

## Output reference

| Name                                         | Type                                                            | Required | Default | Details                                                 |
| -------------------------------------------- | --------------------------------------------------------------- | -------- | ------- | ------------------------------------------------------- |
| `result.data`                                | `object`                                                        | Yes      | —       | —                                                       |
| `result.data.data`                           | `array`                                                         | Yes      | —       | Maximum items: 100.                                     |
| `result.data.data[].id`                      | `integer`                                                       | Yes      | —       | Format: `int64`. Minimum: 1. Maximum: 9007199254740991. |
| `result.data.data[].content`                 | `string \| null`                                                | Yes      | —       | —                                                       |
| `result.data.data[].dueDate`                 | `string`                                                        | Yes      | —       | Format: `date-time`.                                    |
| `result.data.data[].creator`                 | `object`                                                        | Yes      | —       | —                                                       |
| `result.data.data[].creator.id`              | `integer`                                                       | Yes      | —       | Format: `int64`. Minimum: 1. Maximum: 9007199254740991. |
| `result.data.data[].owner`                   | `object`                                                        | Yes      | —       | —                                                       |
| `result.data.data[].owner.id`                | `integer`                                                       | Yes      | —       | Format: `int64`. Minimum: 1. Maximum: 9007199254740991. |
| `result.data.data[].completer`               | `record`                                                        | Yes      | —       | —                                                       |
| `result.data.data[].company`                 | `record`                                                        | Yes      | —       | —                                                       |
| `result.data.data[].person`                  | `record`                                                        | Yes      | —       | —                                                       |
| `result.data.data[].opportunity`             | `record`                                                        | Yes      | —       | —                                                       |
| `result.data.data[].createdAt`               | `string`                                                        | Yes      | —       | Format: `date-time`.                                    |
| `result.data.data[].updatedAt`               | `string \| null`                                                | Yes      | —       | Format: `date-time`.                                    |
| `result.data.data[].type`                    | `"one-time" \| "recurring"`                                     | Yes      | —       | Allowed: `one-time`, `recurring`.                       |
| `result.data.data[].status`                  | `"active" \| "overdue" \| "completed" \| "active" \| "overdue"` | Yes      | —       | —                                                       |
| `result.data.data[].completedAt`             | `string \| null`                                                | Yes      | —       | Format: `date-time`.                                    |
| `result.data.data[].recurrence`              | `object \| null`                                                | Yes      | —       | —                                                       |
| `result.data.data[].recurrence.resetTrigger` | `"interaction" \| "email" \| "event"`                           | Yes      | —       | Allowed: `interaction`, `email`, `event`.               |
| `result.data.data[].recurrence.periodDays`   | `integer`                                                       | Yes      | —       | Format: `int32`. Minimum: 1. Maximum: 2147483647.       |
| `result.data.pagination`                     | `object`                                                        | Yes      | —       | —                                                       |
| `result.data.pagination.prevUrl`             | `string \| null`                                                | No       | —       | Format: `uri`.                                          |
| `result.data.pagination.nextUrl`             | `string \| null`                                                | No       | —       | Format: `uri`.                                          |
| `result.meta`                                | `object`                                                        | No       | —       | —                                                       |

<details>
  <summary>Show raw output schema</summary>

  ### Output JSON Schema

  ```json theme={null}
  {
    "type": "object",
    "properties": {
      "data": {
        "type": "object",
        "properties": {
          "data": {
            "type": "array",
            "maxItems": 100,
            "items": {
              "type": "object",
              "properties": {
                "id": {
                  "type": "integer",
                  "minimum": 1,
                  "maximum": 9007199254740991,
                  "format": "int64"
                },
                "content": {
                  "type": [
                    "string",
                    "null"
                  ]
                },
                "dueDate": {
                  "type": "string",
                  "format": "date-time"
                },
                "creator": {
                  "type": "object",
                  "properties": {
                    "id": {
                      "type": "integer",
                      "minimum": 1,
                      "maximum": 9007199254740991,
                      "format": "int64"
                    }
                  },
                  "required": [
                    "id"
                  ],
                  "additionalProperties": false
                },
                "owner": {
                  "type": "object",
                  "properties": {
                    "id": {
                      "type": "integer",
                      "minimum": 1,
                      "maximum": 9007199254740991,
                      "format": "int64"
                    }
                  },
                  "required": [
                    "id"
                  ],
                  "additionalProperties": false
                },
                "completer": {
                  "type": "object",
                  "additionalProperties": true
                },
                "company": {
                  "type": "object",
                  "additionalProperties": true
                },
                "person": {
                  "type": "object",
                  "additionalProperties": true
                },
                "opportunity": {
                  "type": "object",
                  "additionalProperties": true
                },
                "createdAt": {
                  "type": "string",
                  "format": "date-time"
                },
                "updatedAt": {
                  "type": [
                    "string",
                    "null"
                  ],
                  "format": "date-time"
                },
                "type": {
                  "type": "string",
                  "enum": [
                    "one-time",
                    "recurring"
                  ]
                },
                "status": {
                  "anyOf": [
                    {
                      "type": "string",
                      "enum": [
                        "active",
                        "overdue",
                        "completed"
                      ]
                    },
                    {
                      "type": "string",
                      "enum": [
                        "active",
                        "overdue"
                      ]
                    }
                  ]
                },
                "completedAt": {
                  "type": [
                    "string",
                    "null"
                  ],
                  "format": "date-time"
                },
                "recurrence": {
                  "type": [
                    "object",
                    "null"
                  ],
                  "properties": {
                    "resetTrigger": {
                      "type": "string",
                      "enum": [
                        "interaction",
                        "email",
                        "event"
                      ]
                    },
                    "periodDays": {
                      "type": "integer",
                      "minimum": 1,
                      "maximum": 2147483647,
                      "format": "int32"
                    }
                  },
                  "required": [
                    "resetTrigger",
                    "periodDays"
                  ],
                  "additionalProperties": false
                }
              },
              "required": [
                "id",
                "content",
                "dueDate",
                "creator",
                "owner",
                "completer",
                "company",
                "person",
                "opportunity",
                "createdAt",
                "updatedAt",
                "type",
                "status",
                "completedAt",
                "recurrence"
              ],
              "anyOf": [
                {
                  "type": "object",
                  "properties": {
                    "id": {
                      "type": "integer",
                      "minimum": 1,
                      "maximum": 9007199254740991,
                      "format": "int64"
                    },
                    "content": {
                      "type": [
                        "string",
                        "null"
                      ]
                    },
                    "dueDate": {
                      "type": "string",
                      "format": "date-time"
                    },
                    "creator": {
                      "type": "object",
                      "properties": {
                        "id": {
                          "type": "integer",
                          "minimum": 1,
                          "maximum": 9007199254740991,
                          "format": "int64"
                        }
                      },
                      "required": [
                        "id"
                      ],
                      "additionalProperties": false
                    },
                    "owner": {
                      "type": "object",
                      "properties": {
                        "id": {
                          "type": "integer",
                          "minimum": 1,
                          "maximum": 9007199254740991,
                          "format": "int64"
                        }
                      },
                      "required": [
                        "id"
                      ],
                      "additionalProperties": false
                    },
                    "completer": {
                      "type": "object",
                      "additionalProperties": true
                    },
                    "company": {
                      "type": "object",
                      "additionalProperties": true
                    },
                    "person": {
                      "type": "object",
                      "additionalProperties": true
                    },
                    "opportunity": {
                      "type": "object",
                      "additionalProperties": true
                    },
                    "createdAt": {
                      "type": "string",
                      "format": "date-time"
                    },
                    "updatedAt": {
                      "type": [
                        "string",
                        "null"
                      ],
                      "format": "date-time"
                    }
                  },
                  "required": [
                    "id",
                    "content",
                    "dueDate",
                    "creator",
                    "owner",
                    "completer",
                    "company",
                    "person",
                    "opportunity",
                    "createdAt",
                    "updatedAt"
                  ],
                  "additionalProperties": false
                },
                {
                  "type": "object",
                  "properties": {
                    "id": {
                      "type": "integer",
                      "minimum": 1,
                      "maximum": 9007199254740991,
                      "format": "int64"
                    },
                    "content": {
                      "type": [
                        "string",
                        "null"
                      ]
                    },
                    "dueDate": {
                      "type": "string",
                      "format": "date-time"
                    },
                    "creator": {
                      "type": "object",
                      "properties": {
                        "id": {
                          "type": "integer",
                          "minimum": 1,
                          "maximum": 9007199254740991,
                          "format": "int64"
                        }
                      },
                      "required": [
                        "id"
                      ],
                      "additionalProperties": false
                    },
                    "owner": {
                      "type": "object",
                      "properties": {
                        "id": {
                          "type": "integer",
                          "minimum": 1,
                          "maximum": 9007199254740991,
                          "format": "int64"
                        }
                      },
                      "required": [
                        "id"
                      ],
                      "additionalProperties": false
                    },
                    "completer": {
                      "type": "object",
                      "additionalProperties": true
                    },
                    "company": {
                      "type": "object",
                      "additionalProperties": true
                    },
                    "person": {
                      "type": "object",
                      "additionalProperties": true
                    },
                    "opportunity": {
                      "type": "object",
                      "additionalProperties": true
                    },
                    "createdAt": {
                      "type": "string",
                      "format": "date-time"
                    },
                    "updatedAt": {
                      "type": [
                        "string",
                        "null"
                      ],
                      "format": "date-time"
                    }
                  },
                  "required": [
                    "id",
                    "content",
                    "dueDate",
                    "creator",
                    "owner",
                    "completer",
                    "company",
                    "person",
                    "opportunity",
                    "createdAt",
                    "updatedAt"
                  ],
                  "additionalProperties": false
                }
              ],
              "additionalProperties": false
            }
          },
          "pagination": {
            "type": "object",
            "properties": {
              "prevUrl": {
                "type": [
                  "string",
                  "null"
                ],
                "format": "uri"
              },
              "nextUrl": {
                "type": [
                  "string",
                  "null"
                ],
                "format": "uri"
              }
            },
            "additionalProperties": false
          }
        },
        "required": [
          "data",
          "pagination"
        ],
        "additionalProperties": false
      },
      "meta": {
        "type": "object",
        "additionalProperties": true
      }
    },
    "required": [
      "data"
    ],
    "additionalProperties": false
  }
  ```
</details>

## Deepline cost

* Pricing model: `fixed` (per call).
* Estimated Deepline credits: `0` per pricing unit.
* Provider-native pricing may still exist outside Deepline credit billing.

## Related documentation

* [Affinity provider guide](/docs/providers/affinity/guide)
* [SDK V2 quickstart](/docs/sdk-v2/quickstart)
* [SDK reference](/docs/sdk-v2/sdk-reference)
* [Run tools across a CSV](/docs/sdk-v2/batch-csv)
