Loading ...

REST API: Get Reminders | Axero Documentation

Home » axero documentation » Wiki » Documentation » REST API Overview » REST API: Content » REST API: Events » REST API: Event Reminders » REST API: Get Reminders
Axero Documentation  Wiki
Public Space
Activity Stream Content
Version 25

REST API: Get Reminders

0 
 /5
0 (0votes)
Open API Guide
GET/api/events/{EventID}/reminders

Enables administrators and developers to programmatically retrieve a list of reminders a user has set for a certain event.

Request

Request Header

HeaderRequiredValueDescription
AuthorizationYESBearer YOUR_TOKENBearer token for the authenticated user. Learn how to create Bearer tokens.

Required Parameters

ParameterTypeRequiredLocationDescription
EventIDIntegerYESPathUnique ID of the event

Optional Parameters

ParameterTypeRequiredLocationDescription
UserIDIntegerNOQueryUnique ID of the user to return reminders for. Note: Only a site administrator can get reminders of other users.

Example

Request Header

Authorization: Bearer YOUR_TOKEN

Request URL

https://your-site.com/api/events/153/reminders?UserID=1017

Success Response

{
  "IsError": false,
  "ResponseMessage": "",
  "ResponseData": [
    {
      "ReminderID": 627,
      "EntityType": 5,
      "EntityID": 153,
      "ReminderType": 1,
      "ReminderTime": 30,
      "UserID": 1017,
      "ReminderSent": false
    },
    {
      "ReminderID": 628,
      "EntityType": 5,
      "EntityID": 153,
      "ReminderType": 1,
      "ReminderTime": 10,
      "UserID": 1017,
      "ReminderSent": false
    },
    {
      "ReminderID": 629,
      "EntityType": 5,
      "EntityID": 153,
      "ReminderType": 1,
      "ReminderTime": 2,
      "UserID": 1017,
      "ReminderSent": false
    }
  ]
}

Error Response

{
  "IsError": true,
  "ResponseMessage": "Required parameter is missing or invalid.",
  "ResponseData": null
}

Error Handling

Status CodeLikely CauseNext Action
400 Bad RequestEventID in the path is not an integer.Send the event's numeric ID.
401 UnauthorizedMissing or invalid Bearer token.Check token validity. Learn how to create Bearer tokens →
403 ForbiddenUser does not have sufficient permissions.Confirm the user has the required roles for this action.
500 Server ErrorInternal failure.Retry later.
200 with IsErrorUserID is another user and the caller is not a site administrator (No permission), or the reminders could not be read; ResponseMessage says which.Ask for your own reminders, or call as a site administrator.

Rate Limits

While Axero does not enforce hard rate limits by default, we recommend the following best practices to ensure optimal performance:

  • Sustained Request Rate: Do not exceed 5 API calls per second
  • Sequential Processing: Wait for each request to complete before sending the next in automated workflows
  • Concurrent Connections: If parallel processing is required, limit to 3 or fewer simultaneous requests
  • Response Timeout: Ensure API responses complete within 15 seconds during testing

Axero may implement temporary rate restrictions if excessive API usage affects overall site performance. For high-volume integrations, contact Axero to discuss your requirements.

Wiki Index

Pages