REMINDER API Reference
Module Information
Service Files:
- Private:
service/private/reminder.js
Available Services: 5 Documented Services: 5
reminder.create
Create a new reminder for the current user. Stores a reminder task object linked to the authenticated user via the reminder_create stored procedure.
| Property | Value |
|---|---|
| Scope | Hub (requires hub context) |
| Permission | Write (8) |
Endpoint:
https://hostname/-/svc/reminder.create
Parameters
| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
task | object | Yes | - | - |
Returns
| Field | Type | Description |
|---|---|---|
type | any | - |
description | any | - |
properties | any | - |
Possible Errors
Error codes not documented
reminder.get
Get a specific reminder by ID, node ID, or hub ID. Retrieves a single reminder record matching the provided lookup criteria for the authenticated user.
| Property | Value |
|---|---|
| Scope | Hub (requires hub context) |
| Permission | Read (2) |
Endpoint:
https://hostname/-/svc/reminder.get
Parameters
| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
reminder_id | string | No | - | - |
nid | string | No | - | - |
hub_id | string | No | - | - |
Returns
| Field | Type | Description |
|---|---|---|
type | any | - |
description | any | - |
properties | any | - |
Possible Errors
Error codes not documented
reminder.list
List all reminders for the current user. Returns the full list of reminder records owned by the authenticated user via the reminder_list stored procedure.
| Property | Value |
|---|---|
| Scope | Hub (requires hub context) |
| Permission | Read (2) |
Endpoint:
https://hostname/-/svc/reminder.list
Parameters
No parameters
Returns
| Field | Type | Description |
|---|---|---|
type | any | - |
description | any | - |
items | object | - |
items.id | string | - |
Possible Errors
Error codes not documented
reminder.remove
Remove a reminder by ID. Deletes the reminder record permanently via the reminder_remove stored procedure and returns the deleted record ID.
| Property | Value |
|---|---|
| Scope | Hub (requires hub context) |
| Permission | Write (8) |
Endpoint:
https://hostname/-/svc/reminder.remove
Parameters
| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
id | string | Yes | - | - |
Returns
| Field | Type | Description |
|---|---|---|
type | any | - |
description | any | - |
properties | any | - |
Possible Errors
Error codes not documented
reminder.update
Update an existing reminder. Replaces the task data of an existing reminder identified by ID via the reminder_update stored procedure.
| Property | Value |
|---|---|
| Scope | Hub (requires hub context) |
| Permission | Write (8) |
Endpoint:
https://hostname/-/svc/reminder.update
Parameters
| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
id | string | Yes | - | - |
task | object | Yes | - | - |
Returns
| Field | Type | Description |
|---|---|---|
type | any | - |
description | any | - |
Possible Errors
Error codes not documented
Related Documentation
- ACL System - Permission model
- ACL Specification - Scope, permission and routing reference
- Request Pipeline - How requests are routed
- Error Handling - Error codes