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

# Search Reminders

> Search and list Reminder records with filtering, sorting, and pagination.

A **Reminder** defines an automated message triggered by a specific event or schedule. Reminders can send emails, canned messages, or surveys based on triggers such as sign-up anniversaries, booking activity, invoice due dates, or contract milestones.

## Authentication

<Note>
  This endpoint requires OAuth2 authentication. Include a valid bearer token in the `Authorization` header.
  The authenticated user must be a full unrestricted administrator or have the **`Reminder-List`** role.
</Note>

## Enums

<Accordion title="eReminderType — ReminderType values">
  | Value | Name                            |
  | ----- | ------------------------------- |
  | 1     | FixedDate                       |
  | 2     | DaysAfterSignUp                 |
  | 3     | DaysAfterRenewal                |
  | 4     | DaysBeforeRenewal               |
  | 5     | Birthday                        |
  | 6     | DaysBeforeCancellation          |
  | 7     | AfterABooking                   |
  | 8     | LastActivity                    |
  | 9     | ProductPurchase                 |
  | 10    | DueInvoice                      |
  | 11    | OnFirstCheckIn                  |
  | 12    | OnSignUpFormSubmitted           |
  | 13    | DaysBeforeTerm                  |
  | 14    | RegularBookerStoppedBooking     |
  | 15    | RegularBooking                  |
  | 16    | StoppedBooking                  |
  | 17    | SingleBooking                   |
  | 18    | InvoiceFirstPaid                |
  | 19    | DaysBeforeContractStarts        |
  | 20    | DaysAfterDeliveryNotCollected   |
  | 21    | DaysAfterFirstContractStartDate |
  | 22    | ProductAddedToBooking           |
</Accordion>

<Accordion title="eReminderAction — ReminderAction values">
  | Value | Name              |
  | ----- | ----------------- |
  | 1     | SendEmail         |
  | 2     | SendCannedMessage |
  | 3     | SendSurvey        |
</Accordion>

## Query Parameters

### Pagination & Sorting

<ParamField query="page" type="integer" default="1">
  The page number to retrieve.
</ParamField>

<ParamField query="size" type="integer" default="25">
  The number of records per page.
</ParamField>

<ParamField query="orderBy" type="string">
  The property name to sort results by (e.g. `Name`, `CreatedOn`).
</ParamField>

<ParamField query="dir" type="integer">
  Sort direction. `0` for ascending, `1` for descending.
</ParamField>

### Filters

<ParamField query="Reminder_Business" type="integer">
  Filter by iD of the business linked to this record.
</ParamField>

<ParamField query="Reminder_Business_Name" type="string">
  Filter by display name of the linked business (read-only).
</ParamField>

<ParamField query="Reminder_Name" type="string">
  Filter by the name value for this reminder.
</ParamField>

<ParamField query="Reminder_ForAllContacts" type="boolean">
  Filter by whether for all contacts is enabled.
</ParamField>

<ParamField query="Reminder_ForAllMembers" type="boolean">
  Filter by whether for all members is enabled.
</ParamField>

<ParamField query="Reminder_ForAllChildLocations" type="boolean">
  Filter by whether for all child locations is enabled.
</ParamField>

<ParamField query="Reminder_Coworker" type="integer">
  Filter by iD of the coworker linked to this record.
</ParamField>

<ParamField query="Reminder_ReminderType" type="integer">
  Filter by the reminder type value for this reminder.
</ParamField>

<ParamField query="Reminder_ReminderDate" type="string">
  Filter by date/time value for reminder date.
</ParamField>

<ParamField query="Reminder_DaysAfterSignup" type="integer">
  Filter by the days after signup value for this reminder.
</ParamField>

<ParamField query="Reminder_Product" type="integer">
  Filter by iD of the product linked to this record.
</ParamField>

<ParamField query="Reminder_Product_Name" type="string">
  Filter by display name of the linked product (read-only).
</ParamField>

<ParamField query="Reminder_Survey" type="integer">
  Filter by iD of the survey linked to this record.
</ParamField>

<ParamField query="Reminder_Survey_Name" type="string">
  Filter by display name of the linked survey (read-only).
</ParamField>

<ParamField query="Reminder_DaysAfterRenewal" type="integer">
  Filter by the days after renewal value for this reminder.
</ParamField>

<ParamField query="Reminder_DaysBeforeRenewal" type="integer">
  Filter by the days before renewal value for this reminder.
</ParamField>

<ParamField query="Reminder_ReminderAction" type="integer">
  Filter by the reminder action value for this reminder.
</ParamField>

<ParamField query="Reminder_Email" type="string">
  Filter by the email value for this reminder.
</ParamField>

<ParamField query="Reminder_CannedResponse" type="integer">
  Filter by iD of the canned response linked to this record.
</ParamField>

<ParamField query="Reminder_CannedResponse_Name" type="string">
  Filter by display name of the linked canned response (read-only).
</ParamField>

<ParamField query="Reminder_NextProcessTime" type="string">
  Filter by date/time value for next process time.
</ParamField>

<ParamField query="Reminder_OnlySendToTeamPayingMembers" type="boolean">
  Filter by whether only send to team paying members is enabled.
</ParamField>

<ParamField query="Reminder_OnlySendToActiveCoworkers" type="boolean">
  Filter by whether only send to active coworkers is enabled.
</ParamField>

<ParamField query="Reminder_BlockingPeriodMinutes" type="integer">
  Filter by the blocking period minutes value for this reminder.
</ParamField>

### Range Filters

<ParamField query="from_Reminder_ReminderDate" type="string">
  Filter by date/time value for reminder date greater than or equal to this value. Format: `YYYY-MM-DDTHH:mm`.
</ParamField>

<ParamField query="to_Reminder_ReminderDate" type="string">
  Filter by date/time value for reminder date less than or equal to this value. Format: `YYYY-MM-DDTHH:mm`.
</ParamField>

<ParamField query="from_Reminder_DaysAfterSignup" type="integer">
  Filter by the days after signup value for this reminder greater than or equal to this value.
</ParamField>

<ParamField query="to_Reminder_DaysAfterSignup" type="integer">
  Filter by the days after signup value for this reminder less than or equal to this value.
</ParamField>

<ParamField query="from_Reminder_DaysAfterRenewal" type="integer">
  Filter by the days after renewal value for this reminder greater than or equal to this value.
</ParamField>

<ParamField query="to_Reminder_DaysAfterRenewal" type="integer">
  Filter by the days after renewal value for this reminder less than or equal to this value.
</ParamField>

<ParamField query="from_Reminder_DaysBeforeRenewal" type="integer">
  Filter by the days before renewal value for this reminder greater than or equal to this value.
</ParamField>

<ParamField query="to_Reminder_DaysBeforeRenewal" type="integer">
  Filter by the days before renewal value for this reminder less than or equal to this value.
</ParamField>

<ParamField query="from_Reminder_NextProcessTime" type="string">
  Filter by date/time value for next process time greater than or equal to this value. Format: `YYYY-MM-DDTHH:mm`.
</ParamField>

<ParamField query="to_Reminder_NextProcessTime" type="string">
  Filter by date/time value for next process time less than or equal to this value. Format: `YYYY-MM-DDTHH:mm`.
</ParamField>

<ParamField query="from_Reminder_BlockingPeriodMinutes" type="integer">
  Filter by the blocking period minutes value for this reminder greater than or equal to this value.
</ParamField>

<ParamField query="to_Reminder_BlockingPeriodMinutes" type="integer">
  Filter by the blocking period minutes value for this reminder less than or equal to this value.
</ParamField>

<ParamField query="from_Reminder_CreatedOn" type="string">
  Filter records created on or after this date. Format: `YYYY-MM-DDTHH:mm`.
</ParamField>

<ParamField query="to_Reminder_CreatedOn" type="string">
  Filter records created on or before this date. Format: `YYYY-MM-DDTHH:mm`.
</ParamField>

<ParamField query="from_Reminder_UpdatedOn" type="string">
  Filter records updated on or after this date. Format: `YYYY-MM-DDTHH:mm`.
</ParamField>

<ParamField query="to_Reminder_UpdatedOn" type="string">
  Filter records updated on or before this date. Format: `YYYY-MM-DDTHH:mm`.
</ParamField>

## Code Examples

### Simple listing

<CodeGroup>
  ```bash cURL theme={null}
  curl -X GET \
    "https://spaces.nexudus.com/api/crm/reminders?page=1&size=15&orderBy=Name&dir=0" \
    -H "Authorization: Bearer YOUR_TOKEN"
  ```

  ```javascript JavaScript theme={null}
  const response = await fetch(
    'https://spaces.nexudus.com/api/crm/reminders?' + new URLSearchParams({
      page: 1,
      size: 15,
      orderBy: 'Name',
      dir: 1 // Ascending
    }),
    {
      headers: {
        'Authorization': 'Bearer YOUR_TOKEN'
      }
    }
  );

  const data = await response.json();
  ```

  ```python Python theme={null}
  import requests

  response = requests.get(
      'https://spaces.nexudus.com/api/crm/reminders',
      params={
          'page': 1,
          'size': 15,
          'orderBy': 'Name',
          'dir': 0 // Ascending
      },
      headers={
          'Authorization': 'Bearer YOUR_TOKEN'
      }
  )

  data = response.json()
  ```
</CodeGroup>

### Filtering by Name

<CodeGroup>
  ```bash cURL theme={null}
  curl -X GET \
    "https://spaces.nexudus.com/api/crm/reminders?Reminder_Name=example-value&orderBy=Name&dir=0" \
    -H "Authorization: Bearer YOUR_TOKEN"
  ```

  ```javascript JavaScript theme={null}
  const response = await fetch(
    'https://spaces.nexudus.com/api/crm/reminders?' + new URLSearchParams({
      Reminder_Name: 'example-value',
      orderBy: 'Name',
      dir: 1
    }),
    {
      headers: {
        'Authorization': 'Bearer YOUR_TOKEN'
      }
    }
  );

  const data = await response.json();
  ```

  ```python Python theme={null}
  import requests

  response = requests.get(
      'https://spaces.nexudus.com/api/crm/reminders',
      params={
          'Reminder_Name': 'example-value',
          'orderBy': 'Name',
          'dir': 0 // Ascending
      },
      headers={
          'Authorization': 'Bearer YOUR_TOKEN'
      }
  )

  data = response.json()
  ```
</CodeGroup>

### Range filters

<CodeGroup>
  ```bash cURL theme={null}
  curl -X GET \
    "https://spaces.nexudus.com/api/crm/reminders?from_Reminder_UpdatedOn=2025-01-01T00:00&to_Reminder_UpdatedOn=2025-12-31T23:59&orderBy=UpdatedOn&dir=0" \
    -H "Authorization: Bearer YOUR_TOKEN"
  ```

  ```javascript JavaScript theme={null}
  const response = await fetch(
    'https://spaces.nexudus.com/api/crm/reminders?' + new URLSearchParams({
      from_Reminder_UpdatedOn: '2025-01-01T00:00',
      to_Reminder_UpdatedOn: '2025-12-31T23:59',
      orderBy: 'UpdatedOn',
      dir: 1 // Descending
     }),
    {
      headers: {
        'Authorization': 'Bearer YOUR_TOKEN'
      }
    }
  );

  const data = await response.json();
  ```

  ```python Python theme={null}
  import requests

  response = requests.get(
      'https://spaces.nexudus.com/api/crm/reminders',
      params={
          'from_Reminder_UpdatedOn': '2025-01-01T00:00',
          'to_Reminder_UpdatedOn': '2025-12-31T23:59',
          'orderBy': 'UpdatedOn',
          'dir': 1 // Descending
      },
      headers={
          'Authorization': 'Bearer YOUR_TOKEN'
      }
  )

  data = response.json()
  ```
</CodeGroup>

## Response

### 200

<ResponseField name="Records" type="Reminder[]">
  The list of Reminder records matching the query. See the [Get one Reminder](/rest-api/crm/get-reminders-by-id) endpoint for the full list of properties returned for each record.
</ResponseField>

<Warning>
  **Partial records** — The listing endpoint returns a summary representation of each Reminder. The following fields are **not populated** in the `Records[]` response: `CoworkerId`, `ReminderDate`, `DaysAfterSignup`, `ProductId`, `SurveyId`, `DaysAfterRenewal`, `DaysBeforeRenewal`, `Email`, `CannedResponseId`, `BlockingPeriodMinutes`.

  To get all fields, fetch the full record using the [Get one Reminder](/rest-api/crm/get-reminders-by-id) endpoint.

  **Important for updates:** When updating a record via `PUT`, always retrieve the full record with a `GET` request first, apply your changes to that complete data, and then send the updated record. Do not use data from a listing response as the base for a `PUT` request, as missing fields may be unintentionally cleared.
</Warning>

<ResponseField name="CurrentPage" type="integer">
  Current page number.
</ResponseField>

<ResponseField name="CurrentPageSize" type="integer">
  Number of records per page.
</ResponseField>

<ResponseField name="CurrentOrderField" type="string">
  The field used for sorting.
</ResponseField>

<ResponseField name="CurrentSortDirection" type="integer">
  The sort direction (`0` = ascending, `1` = descending).
</ResponseField>

<ResponseField name="FirstItem" type="integer">
  Index of the first item on the current page.
</ResponseField>

<ResponseField name="LastItem" type="integer">
  Index of the last item on the current page.
</ResponseField>

<ResponseField name="TotalItems" type="integer">
  Total number of matching records across all pages.
</ResponseField>

<ResponseField name="TotalPages" type="integer">
  Total number of pages.
</ResponseField>

<ResponseField name="HasNextPage" type="boolean">
  Whether there is a next page of results.
</ResponseField>

<ResponseField name="HasPreviousPage" type="boolean">
  Whether there is a previous page of results.
</ResponseField>

```json Example Response theme={null}
{
  "Records": [
    {
      "BusinessId": 0,
      "BusinessName": null,
      "Name": "",
      "ForAllContacts": false,
      "ForAllMembers": false,
      "ForAllChildLocations": false,
      "Tariffs": [],
      "ReminderType": 0,
      "ProductName": null,
      "SurveyName": null,
      "ReminderAction": 0,
      "CannedResponseName": null,
      "NextProcessTime": null,
      "Resources": [],
      "OnlySendToTeamPayingMembers": false,
      "OnlySendToActiveCoworkers": false,
      "Id": 87654321,
      "UpdatedOn": "2025-01-15T10:30:00Z",
      "CreatedOn": "2025-01-10T08:00:00Z",
      "UniqueId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
      "UpdatedBy": "admin@example.com",
      "IsNew": false,
      "SystemId": null,
      "ToStringText": "Reminder Example",
      "LocalizationDetails": null,
      "CustomFields": null
    }
  ],
  "CurrentPageSize": 15,
  "CurrentPage": 1,
  "CurrentOrderField": "Name",
  "CurrentSortDirection": 1,
  "FirstItem": 1,
  "HasNextPage": false,
  "HasPreviousPage": false,
  "LastItem": 1,
  "PageNumber": 1,
  "PageSize": 15,
  "TotalItems": 1,
  "TotalPages": 1
}
```