Search Reminders - Nexudus Platform

GET

api

crm

reminders

Search Reminders

curl --request GET \
  --url https://spaces.nexudus.com/api/crm/reminders \
  --header 'Authorization: Basic <encoded-value>'

{
  "Records": [
    {}
  ],
  "CurrentPage": 123,
  "CurrentPageSize": 123,
  "CurrentOrderField": "<string>",
  "CurrentSortDirection": 123,
  "FirstItem": 123,
  "LastItem": 123,
  "TotalItems": 123,
  "TotalPages": 123,
  "HasNextPage": true,
  "HasPreviousPage": true
}

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-List role.

Enums

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

eReminderAction — ReminderAction values

Value	Name
1	SendEmail
2	SendCannedMessage
3	SendSurvey

Query Parameters

Pagination & Sorting

page

integer

default:"1"

The page number to retrieve.

size

integer

default:"25"

The number of records per page.

orderBy

string

The property name to sort results by (e.g. Name, CreatedOn).

dir

integer

Sort direction. 0 for ascending, 1 for descending.

Filters

Reminder_Business

integer

Filter by iD of the business linked to this record.

Reminder_Business_Name

string

Filter by display name of the linked business (read-only).

Reminder_Name

string

Filter by the name value for this reminder.

Reminder_ForAllContacts

boolean

Filter by whether for all contacts is enabled.

Reminder_ForAllMembers

boolean

Filter by whether for all members is enabled.

Reminder_ForAllChildLocations

boolean

Filter by whether for all child locations is enabled.

Reminder_Coworker

integer

Filter by iD of the coworker linked to this record.

Reminder_ReminderType

integer

Filter by the reminder type value for this reminder.

Reminder_ReminderDate

string

Filter by date/time value for reminder date.

Filter by the days after signup value for this reminder.

Reminder_Product

integer

Filter by iD of the product linked to this record.

Reminder_Product_Name

string

Filter by display name of the linked product (read-only).

Reminder_Survey

integer

Filter by iD of the survey linked to this record.

Reminder_Survey_Name

string

Filter by display name of the linked survey (read-only).

Reminder_DaysAfterRenewal

integer

Filter by the days after renewal value for this reminder.

Reminder_DaysBeforeRenewal

integer

Filter by the days before renewal value for this reminder.

Reminder_ReminderAction

integer

Filter by the reminder action value for this reminder.

Reminder_Email

string

Filter by the email value for this reminder.

Reminder_CannedResponse

integer

Filter by iD of the canned response linked to this record.

Reminder_CannedResponse_Name

string

Filter by display name of the linked canned response (read-only).

Reminder_NextProcessTime

string

Filter by date/time value for next process time.

Reminder_OnlySendToTeamPayingMembers

boolean

Filter by whether only send to team paying members is enabled.

Reminder_OnlySendToActiveCoworkers

boolean

Filter by whether only send to active coworkers is enabled.

Reminder_BlockingPeriodMinutes

integer

Filter by the blocking period minutes value for this reminder.

Range Filters

from_Reminder_ReminderDate

string

Filter by date/time value for reminder date greater than or equal to this value. Format: YYYY-MM-DDTHH:mm.

to_Reminder_ReminderDate

string

Filter by date/time value for reminder date less than or equal to this value. Format: YYYY-MM-DDTHH:mm.

Filter by the days after signup value for this reminder greater than or equal to this value.

Filter by the days after signup value for this reminder less than or equal to this value.

from_Reminder_DaysAfterRenewal

integer

Filter by the days after renewal value for this reminder greater than or equal to this value.

to_Reminder_DaysAfterRenewal

integer

Filter by the days after renewal value for this reminder less than or equal to this value.

from_Reminder_DaysBeforeRenewal

integer

Filter by the days before renewal value for this reminder greater than or equal to this value.

to_Reminder_DaysBeforeRenewal

integer

Filter by the days before renewal value for this reminder less than or equal to this value.

from_Reminder_NextProcessTime

string

Filter by date/time value for next process time greater than or equal to this value. Format: YYYY-MM-DDTHH:mm.

to_Reminder_NextProcessTime

string

Filter by date/time value for next process time less than or equal to this value. Format: YYYY-MM-DDTHH:mm.

from_Reminder_BlockingPeriodMinutes

integer

Filter by the blocking period minutes value for this reminder greater than or equal to this value.

to_Reminder_BlockingPeriodMinutes

integer

Filter by the blocking period minutes value for this reminder less than or equal to this value.

from_Reminder_CreatedOn

string

Filter records created on or after this date. Format: YYYY-MM-DDTHH:mm.

to_Reminder_CreatedOn

string

Filter records created on or before this date. Format: YYYY-MM-DDTHH:mm.

from_Reminder_UpdatedOn

string

Filter records updated on or after this date. Format: YYYY-MM-DDTHH:mm.

to_Reminder_UpdatedOn

string

Filter records updated on or before this date. Format: YYYY-MM-DDTHH:mm.

Code Examples

Simple listing

curl -X GET \
  "https://spaces.nexudus.com/api/crm/reminders?page=1&size=15&orderBy=Name&dir=0" \
  -H "Authorization: Bearer YOUR_TOKEN"

Filtering by Name

curl -X GET \
  "https://spaces.nexudus.com/api/crm/reminders?Reminder_Name=example-value&orderBy=Name&dir=0" \
  -H "Authorization: Bearer YOUR_TOKEN"

Range filters

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"

Response

200

Records

Reminder[]

The list of Reminder records matching the query. See the Get one Reminder endpoint for the full list of properties returned for each record.

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

CurrentPage

integer

Current page number.

CurrentPageSize

integer

Number of records per page.

CurrentOrderField

string

The field used for sorting.

CurrentSortDirection

integer

The sort direction (0 = ascending, 1 = descending).

FirstItem

integer

Index of the first item on the current page.

LastItem

integer

Index of the last item on the current page.

TotalItems

integer

Total number of matching records across all pages.

TotalPages

integer

Total number of pages.

HasNextPage

boolean

Whether there is a next page of results.

HasPreviousPage

boolean

Whether there is a previous page of results.

Example Response

{
  "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
}

Get one ReminderRetrieve a single Reminder record by its Id.

Search Reminders

curl --request GET \
  --url https://spaces.nexudus.com/api/crm/reminders \
  --header 'Authorization: Basic <encoded-value>'

{
  "Records": [
    {}
  ],
  "CurrentPage": 123,
  "CurrentPageSize": 123,
  "CurrentOrderField": "<string>",
  "CurrentSortDirection": 123,
  "FirstItem": 123,
  "LastItem": 123,
  "TotalItems": 123,
  "TotalPages": 123,
  "HasNextPage": true,
  "HasPreviousPage": true
}

​Authentication

​Enums

​Query Parameters

​Pagination & Sorting

​Filters

​Range Filters

​Code Examples

​Simple listing

​Filtering by Name

​Range filters

​Response

​200

Authentication

Enums

Query Parameters

Pagination & Sorting

Filters

Range Filters

Code Examples

Simple listing

Filtering by Name

Range filters

Response

200