Search Reminders

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

GET /api/crm/reminders

Search Reminders

cURL

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

200

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

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.

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

Reminder_Business_Name · string

Filter by Business Name.

Reminder_Name · string

Filter by Name.

Reminder_ForAllContacts · boolean

Filter by For All Contacts.

Reminder_ForAllMembers · boolean

Filter by For All Members.

Reminder_ForAllChildLocations · boolean

Filter by For All Child Locations.

Reminder_Coworker · integer

Filter by Coworker Id.

Reminder_ReminderType · integer

Filter by Reminder Type.

Reminder_ReminderDate · string

Filter by Reminder Date.

Reminder_DaysAfterSignup · integer

Filter by Days After Signup.

Reminder_Product · integer

Filter by Product Id.

Reminder_Product_Name · string

Filter by Product Name.

Reminder_Survey · integer

Filter by Survey Id.

Reminder_Survey_Name · string

Filter by Survey Name.

Reminder_DaysAfterRenewal · integer

Filter by Days After Renewal.

Reminder_DaysBeforeRenewal · integer

Filter by Days Before Renewal.

Reminder_ReminderAction · integer

Filter by Reminder Action.

Reminder_Email · string

Filter by Email.

Reminder_CannedResponse · integer

Filter by Canned Response Id.

Reminder_CannedResponse_Name · string

Filter by Canned Response Name.

Reminder_NextProcessTime · string

Filter by Next Process Time.

Reminder_OnlySendToTeamPayingMembers · boolean

Filter by Only Send To Team Paying Members.

Reminder_OnlySendToActiveCoworkers · boolean

Filter by Only Send To Active Coworkers.

Reminder_BlockingPeriodMinutes · integer

Filter by Blocking Period Minutes.

Range Filters

from_Reminder_ReminderDate · string

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

to_Reminder_ReminderDate · string

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

from_Reminder_DaysAfterSignup · integer

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

to_Reminder_DaysAfterSignup · integer

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

from_Reminder_DaysAfterRenewal · integer

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

to_Reminder_DaysAfterRenewal · integer

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

from_Reminder_DaysBeforeRenewal · integer

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

to_Reminder_DaysBeforeRenewal · integer

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

from_Reminder_NextProcessTime · string

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

to_Reminder_NextProcessTime · string

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

from_Reminder_BlockingPeriodMinutes · integer

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

to_Reminder_BlockingPeriodMinutes · integer

Filter by blocking period minutes 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

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

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

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": "[e-mail]",
      "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
}