Pi Reminder API

Availability	Throughput	Response time
99.9%	—	—

This page provides help for Pi Reminder API usage. The API is only available for Pi Reminder Plus users

Usage

Use following Sample to Add a Reminder.

REST
cURL
PHP

Example HTTP POST Request:

POST https://api.pireminder.com
              /reminder
              ?key=YOUR_API_KEY
              &title=My First API Reminder
              &datetime=TIME_IN_MILLIS
              &visibility=private
              &email=EMAIL_ID

Response:

{
    "error": false,
    "id": 354536
}

Example cURL Request:

curl --location --request POST 'https://api.pireminder.com
              /reminder
              ?key=YOUR_API_KEY
              &title=My First API Reminder
              &datetime=TIME_IN_MILLIS
              &visibility=private
              &email=EMAIL_ID'

Response:

{
    "error": false,
    "id": 354536
}

Example PHP cURL Request:

<?php

$curl = curl_init();

curl_setopt_array($curl, array(
  CURLOPT_URL => 'https://api.pireminder.com
                  /reminder
                  ?key=YOUR_API_KEY
                  &title=My First API Reminder
                  &datetime=TIME_IN_MILLIS
                  &visibility=private
                  &email=EMAIL_ID',
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => '',
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 0,
  CURLOPT_FOLLOWLOCATION => true,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => 'POST',
));

$response = curl_exec($curl);

curl_close($curl);
echo $response;

?>

Response:

{
    "error": false,
    "id": 354536
}

Query Parameters

Name	Description
key	Authentication API key to access this API
title	Title of the reminder shown to the user
datetime	Unix EPOCH timestamp of time in future to set for the reminder
visibility optional	Reminder visibility Possible values are private/public/shared Default value is private
email optional	Email of the user for which the reminder has to be added

API Key

fetching api key...

Webhook URL

You can optionally configure the webhook to receive the reminder notification. Webhooks are triggered when the specified reminder time has reached.

Example Webhook payload:

The payload will be sent through a HTTP GET call

WEBHOOK_URL
            ?id=354536
            &title=My First API Reminder
            &datetime=TIME_IN_MILLIS

Support

Report any error at mail@pireminder.com

The API runs on Digital Ocean.