Get a specific reminder

GET

/reminders/{id}

const url = 'http://localhost:8000/api/v1/reminders/1';
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request GET \
  --url http://localhost:8000/api/v1/reminders/1 \
  --header 'Authorization: Bearer <token>'

Authorizations

bearerAuth

Parameters

Path Parameters

required

integer

Responses

200

Successful operation

application/json

object

integer

title

string

description

string

nullable

type

string

Allowed values: daily_tracking weekly_review monthly_summary bill_due budget_alert custom

trigger_at

string format: date-time

nullable

due_at

string format: date-time

nullable

repeat_rule

string

nullable

timezone

string

status

string

Allowed values: active paused snoozed completed cancelled

priority

integer

snoozed_until

string format: date-time

nullable

last_triggered_at

string format: date-time

nullable

next_trigger_at

string format: date-time

nullable

metadata

object

Example

{
  "type": "daily_tracking",
  "repeat_rule": "FREQ=DAILY;BYHOUR=20;BYMINUTE=0",
  "timezone": "UTC",
  "status": "active"
}

404

Reminder not found