> ## 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.

# Get one Reminder

> Retrieve a single Reminder record by its Id.

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-Read`** role.
</Note>

## Path Parameters

<ParamField path="id" type="integer" required>
  The Id of the Reminder record to retrieve.
</ParamField>

## Code Examples

<CodeGroup>
  ```bash cURL theme={null}
  curl -X GET \
    "https://spaces.nexudus.com/api/crm/reminders/87654321" \
    -H "Authorization: Bearer YOUR_TOKEN"
  ```

  ```javascript JavaScript theme={null}
  const response = await fetch(
    'https://spaces.nexudus.com/api/crm/reminders/87654321',
    {
      headers: {
        'Authorization': 'Bearer YOUR_TOKEN'
      }
    }
  );

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

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

  response = requests.get(
      'https://spaces.nexudus.com/api/crm/reminders/87654321',
      headers={
          'Authorization': 'Bearer YOUR_TOKEN'
      }
  )

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

## Response

### 200

<ResponseField name="BusinessId" type="integer">
  ID of the business linked to this record.
</ResponseField>

<ResponseField name="BusinessName" type="string">
  Display name of the linked business (read-only).
</ResponseField>

<ResponseField name="Name" type="string">
  The name value for this reminder.
</ResponseField>

<ResponseField name="ForAllContacts" type="boolean">
  Whether for all contacts is enabled.
</ResponseField>

<ResponseField name="ForAllMembers" type="boolean">
  Whether for all members is enabled.
</ResponseField>

<ResponseField name="ForAllChildLocations" type="boolean">
  Whether for all child locations is enabled.
</ResponseField>

<ResponseField name="CoworkerId" type="integer">
  ID of the coworker linked to this record.
</ResponseField>

<ResponseField name="Tariffs" type="integer[]">
  List of tariffs linked to this record.
</ResponseField>

<ResponseField name="ReminderType" type="integer">
  The reminder type value for this reminder. See `eReminderType` enum values: `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.
</ResponseField>

<ResponseField name="ReminderDate" type="string">
  Date/time value for reminder date.
</ResponseField>

<ResponseField name="DaysAfterSignup" type="integer">
  The days after signup value for this reminder.
</ResponseField>

<ResponseField name="ProductId" type="integer">
  ID of the product linked to this record.
</ResponseField>

<ResponseField name="ProductName" type="string">
  Display name of the linked product (read-only).
</ResponseField>

<ResponseField name="SurveyId" type="integer">
  ID of the survey linked to this record.
</ResponseField>

<ResponseField name="SurveyName" type="string">
  Display name of the linked survey (read-only).
</ResponseField>

<ResponseField name="DaysAfterRenewal" type="integer">
  The days after renewal value for this reminder.
</ResponseField>

<ResponseField name="DaysBeforeRenewal" type="integer">
  The days before renewal value for this reminder.
</ResponseField>

<ResponseField name="ReminderAction" type="integer">
  The reminder action value for this reminder. See `eReminderAction` enum values: `1` = SendEmail, `2` = SendCannedMessage, `3` = SendSurvey.
</ResponseField>

<ResponseField name="Email" type="string">
  The email value for this reminder.
</ResponseField>

<ResponseField name="CannedResponseId" type="integer">
  ID of the canned response linked to this record.
</ResponseField>

<ResponseField name="CannedResponseName" type="string">
  Display name of the linked canned response (read-only).
</ResponseField>

<ResponseField name="NextProcessTime" type="string">
  Date/time value for next process time.
</ResponseField>

<ResponseField name="Resources" type="integer[]">
  List of resources linked to this record.
</ResponseField>

<ResponseField name="OnlySendToTeamPayingMembers" type="boolean">
  Whether only send to team paying members is enabled.
</ResponseField>

<ResponseField name="OnlySendToActiveCoworkers" type="boolean">
  Whether only send to active coworkers is enabled.
</ResponseField>

<ResponseField name="BlockingPeriodMinutes" type="integer">
  The blocking period minutes value for this reminder.
</ResponseField>

<ResponseField name="Id" type="integer">
  Unique record identifier.
</ResponseField>

<ResponseField name="UniqueId" type="string">
  UUID of the record.
</ResponseField>

<ResponseField name="CreatedOn" type="string">
  Date and time the record was created (ISO 8601).
</ResponseField>

<ResponseField name="UpdatedOn" type="string">
  Date and time the record was last updated (ISO 8601).
</ResponseField>

<ResponseField name="UpdatedBy" type="string">
  Email of the user who last updated this record.
</ResponseField>

<ResponseField name="IsNew" type="boolean">
  Whether the record was recently created.
</ResponseField>

<ResponseField name="SystemId" type="string">
  External system identifier.
</ResponseField>

```json Example Response theme={null}
{
  "BusinessId": 0,
  "BusinessName": null,
  "Name": "",
  "ForAllContacts": false,
  "ForAllMembers": false,
  "ForAllChildLocations": false,
  "CoworkerId": null,
  "Tariffs": [],
  "ReminderType": 0,
  "ReminderDate": null,
  "DaysAfterSignup": null,
  "ProductId": null,
  "ProductName": null,
  "SurveyId": null,
  "SurveyName": null,
  "DaysAfterRenewal": null,
  "DaysBeforeRenewal": null,
  "ReminderAction": 0,
  "Email": null,
  "CannedResponseId": null,
  "CannedResponseName": null,
  "NextProcessTime": null,
  "Resources": [],
  "OnlySendToTeamPayingMembers": false,
  "OnlySendToActiveCoworkers": false,
  "BlockingPeriodMinutes": null,
  "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
}
```