Get Active Reminders (for current user)

GET

/api/Reminder/Active

GET

/api/Reminder/Active

curl -G https://api.virtuoussoftware.com/api/Reminder/Active \
     -H "Authorization: Bearer <token>" \
     -d skip=1 \
     -d take=1 \
     --data-urlencode search.search=<string>

200Reminders (Deprecated)_getActiveRemindersForCurrentUser_example

{
  "list": [
    {
      "id": "<integer>",
      "message": "<string>",
      "targetDate": "<string>",
      "targetResolutionDateUtc": "<dateTime>",
      "contactId": "<integer>",
      "contactViewUrl": "<string>",
      "contactDisplayName": "<string>",
      "contactAvatarUrl": "<string>",
      "reminderType": "<string>",
      "reminderTypeDisplayName": "<string>",
      "taskStatus": "<string>",
      "taskStatusDisplayName": "<string>",
      "completeUrl": "<string>",
      "dismissUrl": "<string>",
      "description": "<string>",
      "hasContact": "<boolean>",
      "isPastDue": "<boolean>",
      "isUnresolved": "<boolean>",
      "canComplete": "<boolean>",
      "completeActionName": "<string>",
      "canCompleteWithNote": "<boolean>",
      "owner": "<string>",
      "ownerAvatarUrl": "<string>"
    },
    {
      "id": "<integer>",
      "message": "<string>",
      "targetDate": "<string>",
      "targetResolutionDateUtc": "<dateTime>",
      "contactId": "<integer>",
      "contactViewUrl": "<string>",
      "contactDisplayName": "<string>",
      "contactAvatarUrl": "<string>",
      "reminderType": "<string>",
      "reminderTypeDisplayName": "<string>",
      "taskStatus": "<string>",
      "taskStatusDisplayName": "<string>",
      "completeUrl": "<string>",
      "dismissUrl": "<string>",
      "description": "<string>",
      "hasContact": "<boolean>",
      "isPastDue": "<boolean>",
      "isUnresolved": "<boolean>",
      "canComplete": "<boolean>",
      "completeActionName": "<string>",
      "canCompleteWithNote": "<boolean>",
      "owner": "<string>",
      "ownerAvatarUrl": "<string>"
    }
  ],
  "total": "<integer>"
}

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Query parameters

skipintegerOptional

The number of active reminders to skip.

takeintegerOptional

The number of active reminders to take.

search.searchstringOptional

The search criteria.

Response

listlist of objectsOptional

totalstringOptional