Skip to main content
GET
/
api
/
crm
/
reminders
/
{id}
Get one Reminder
curl --request GET \
  --url https://spaces.nexudus.com/api/crm/reminders/{id} \
  --header 'Authorization: Basic <encoded-value>'
{
  "BusinessId": 123,
  "BusinessName": "<string>",
  "Name": "<string>",
  "ForAllContacts": true,
  "ForAllMembers": true,
  "ForAllChildLocations": true,
  "CoworkerId": 123,
  "Tariffs": [
    123
  ],
  "ReminderType": 123,
  "ReminderDate": "<string>",
  "DaysAfterSignup": 123,
  "ProductId": 123,
  "ProductName": "<string>",
  "SurveyId": 123,
  "SurveyName": "<string>",
  "DaysAfterRenewal": 123,
  "DaysBeforeRenewal": 123,
  "ReminderAction": 123,
  "Email": "<string>",
  "CannedResponseId": 123,
  "CannedResponseName": "<string>",
  "NextProcessTime": "<string>",
  "Resources": [
    123
  ],
  "OnlySendToTeamPayingMembers": true,
  "OnlySendToActiveCoworkers": true,
  "BlockingPeriodMinutes": 123,
  "Id": 123,
  "UniqueId": "<string>",
  "CreatedOn": "<string>",
  "UpdatedOn": "<string>",
  "UpdatedBy": "<string>",
  "IsNew": true,
  "SystemId": "<string>"
}
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

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.

​
Path Parameters

​
id
integer
required
The Id of the Reminder record to retrieve.

​
Code Examples

curl -X GET \
  "https://spaces.nexudus.com/api/crm/reminders/87654321" \
  -H "Authorization: Bearer YOUR_TOKEN"

​
Response

​
200

​
BusinessId
integer
ID of the business linked to this record.
​
BusinessName
string
Display name of the linked business (read-only).
​
Name
string
The name value for this reminder.
​
ForAllContacts
boolean
Whether for all contacts is enabled.
​
ForAllMembers
boolean
Whether for all members is enabled.
​
ForAllChildLocations
boolean
Whether for all child locations is enabled.
​
CoworkerId
integer
ID of the coworker linked to this record.
​
Tariffs
integer[]
List of tariffs linked to this record.
​
ReminderType
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.
​
ReminderDate
string
Date/time value for reminder date.
​
DaysAfterSignup
integer
The days after signup value for this reminder.
​
ProductId
integer
ID of the product linked to this record.
​
ProductName
string
Display name of the linked product (read-only).
​
SurveyId
integer
ID of the survey linked to this record.
​
SurveyName
string
Display name of the linked survey (read-only).
​
DaysAfterRenewal
integer
The days after renewal value for this reminder.
​
DaysBeforeRenewal
integer
The days before renewal value for this reminder.
​
ReminderAction
integer
The reminder action value for this reminder. See eReminderAction enum values: 1 = SendEmail, 2 = SendCannedMessage, 3 = SendSurvey.
​
Email
string
The email value for this reminder.
​
CannedResponseId
integer
ID of the canned response linked to this record.
​
CannedResponseName
string
Display name of the linked canned response (read-only).
​
NextProcessTime
string
Date/time value for next process time.
​
Resources
integer[]
List of resources linked to this record.
​
OnlySendToTeamPayingMembers
boolean
Whether only send to team paying members is enabled.
​
OnlySendToActiveCoworkers
boolean
Whether only send to active coworkers is enabled.
​
BlockingPeriodMinutes
integer
The blocking period minutes value for this reminder.
​
Id
integer
Unique record identifier.
​
UniqueId
string
UUID of the record.
​
CreatedOn
string
Date and time the record was created (ISO 8601).
​
UpdatedOn
string
Date and time the record was last updated (ISO 8601).
​
UpdatedBy
string
Email of the user who last updated this record.
​
IsNew
boolean
Whether the record was recently created.
​
SystemId
string
External system identifier.
Example Response
{
  "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
}