Get reminder details | Sample

2 parameters

tokenstringoptional

Authentication token with the `reminders:read` scope.

reminderstringoptional

The identifier of the reminder to retrieve.

2 status codes

200Returns the reminder object, including its identifier, creator, recipient, text, scheduled time, recurring status, and completion timestamp.

okbooleanrequired

Allowed:true

reminderobjectrequired

defaultTypical error response

callstackstringoptional

Note: PHP callstack is only visible in dev/qa

errorstringrequired

Allowed:not_foundnot_authedinvalid_authaccount_inactivetoken_revokedno_permissionorg_login_requireduser_is_botinvalid_arg_nameinvalid_array_arginvalid_charsetinvalid_form_data

okbooleanrequired

Allowed:false

Error handling

The token must grant the reminders:read scope when authentication is required. When supplied, reminder must identify the reminder whose details you want to retrieve.

import { Client } from "acme-sdk";

const client = new Client({
  baseUrl: "https://api.acme.com",
  retry: {
    maxAttempts: 3,
    retryOn: [
      408,
      425,
      429,
      500,
      502,
      503,
      504,
    ],
    backoffMs: 500,
    maxBackoffMs: 8000,
  },
  timeoutMs: 30000,
});

const result = await client.remindersInfo.list({
  token: "sk_live_4eC39Hq",
  reminder: "example",
});

{
  "ok": true
}

Request

Response

Errors