{"activeVersionTag":"latest","latestAvailableVersionTag":"latest","collection":{"info":{"_postman_id":"27fc544d-1054-4e48-a505-af3d95b46738","name":"Reminders API","description":"Create an account at [https://reminders-api.com](https://reminders-api.com)\n\nReminders API allows you to create simple or complex reminders that will contact your server every time they fire. For example, you can set a reminder to fire every other Thursday, and you will receive a webhook with the reminder object to your server on that day.\n\n# Getting started\n\n1. Create an account at [https://reminders-api.com](https://reminders-api.com)\n    \n2. Create an API Token at [https://reminders-api.com/user/api-tokens](https://reminders-api.com/user/api-tokens)\n    \n3. Create an application\n    \n4. Create a reminder\n    \n5. Receive a webhook\n    \n\n# Authorization\n\nEach API call expects the bearer token created in step 2 as an authorization header, like so:\n\n`Authorization: Bearer`\n\n# Reminder types\n\nYou can create a variety of reminder rules using the Reminder object.\n\nEach reminder requires a date and time (if the time is not specified it will fall back to the application default), and can have a recurrence rule following the [RFC 5545](https://tools.ietf.org/html/rfc5545). You can find practical examples on [this page](https://icalendar.org/iCalendar-RFC-5545/3-8-5-3-recurrence-rule.html) on the official iCalendar website.\n\nFor example, you can create a reminder to be notified:\n\n- **Every day**\n    \n- **Every 2 weeks**\n    \n- **Every 3 weeks on Wednesday and Firday**\n    \n- **Every month on the 4th and the 21st**\n    \n- **Every 4 months on the last Friday**\n    \n- **Every year in July and December**\n    \n- **Every 2 years on the first Saturday of March**\n    \n- **etc.**\n    \n\nHere are some examples:\n\n## Remind only once\n\n``` json\n{\n    [...]\n    \"date_tz\": \"2020-02-01\",\n    \"time_tz\": \"12:00:00\"\n    [...]\n}\n\n ```\n\n## Repeat every 3 days / weeks / month / years\n\n``` json\n{\n    [...]\n    \"date_tz\": \"2020-02-01\",\n    \"time_tz\": \"12:00\"\n    \"rrule\": \"FREQ=DAILY;INTERVAL=3\",\n    [...]\n}\n\n ```\n\nWill repeat on:\n\n- `2020-02-01 12:00:00`\n    \n- `2020-02-04 12:00:00`\n    \n- `2020-02-07 12:00:00`\n    \n- `etc.`\n    \n\n---\n\n``` json\n{\n    [...]\n    \"date_tz\": \"2020-01-31\",\n    \"time_tz\": \"12:00\"\n    \"rrule\": \"FREQ=MONTHLY;INTERVAL=1\",\n    [...]\n}\n\n ```\n\nWill repeat on:\n\n- `2020-01-31 12:00:00`\n    \n- `2020-02-29 12:00:00`\n    \n- `2020-03-31 12:00:00`\n    \n- `2020-04-30 12:00:00`\n    \n- `etc.`\n    \n\n## Every 2 weeks, on Monday, Wednesday, and Friday\n\n``` json\n{\n    [...]\n    \"date_tz\": \"2020-02-01\",\n    \"time_tz\": \"12:00:00\",\n    \"rrule\": \"FREQ=WEEKLY;INTERVAL=2;BYDAY=MO,WE,FR\",\n    [...]\n}\n\n ```\n\nWill repeat on:\n\n- `2020-02-01 12:00:00` (first notification based on `date_tz` and `time_tz`)\n    \n- `2020-02-10 12:00:00` (Monday)\n    \n- `2020-02-12 12:00:00` (Wednesday)\n    \n- `2020-02-14 12:00:00` (Friday)\n    \n- `2020-02-24 12:00:00` (Monday)\n    \n- `etc.`\n    \n\n## Every 2 months, on the 4th and the 15th\n\n``` json\n{\n    [...]\n    \"date_tz\": \"2020-02-01\",\n    \"time_tz\": \"12:00:00\",\n    \"rrule\": \"FREQ=MONTHLY;INTERVAL=2;BYMONTHDAY=4,15\",\n    [...]\n}\n\n ```\n\nWill repeat on:\n\n- `2020-02-01 12:00:00` (first notification based on `date_tz` and `time_tz`)\n    \n- `2020-02-04 12:00:00`\n    \n- `2020-02-15 12:00:00`\n    \n- `2020-04-04 12:00:00`\n    \n- `2020-04-15 12:00:00`\n    \n- `etc.`\n    \n\n## Every month on the first Sunday\n\n``` json\n{\n    [...]\n    \"date_tz\": \"2020-02-01\",\n    \"time_tz\": \"12:00:00\",\n    \"rrule\": \"FREQ=MONTHLY;INTERVAL=1;BYDAY=1SU\"\n    [...]\n}\n\n ```\n\nWill repeat on:\n\n- `2020-02-01 12:00:00` (first notification based on `date_tz` and `time_tz`)\n    \n- `2020-03-01 12:00:00` (Sunday)\n    \n- `2020-04-05 12:00:00` (Sunday)\n    \n- `etc.`\n    \n\n## Every 2 years, in July and December\n\n``` json\n{\n    [...]\n    \"date_tz\": \"2020-02-01\",\n    \"time_tz\": \"12:00:00\",\n    \"rrule\": \"FREQ=YEARLY;INTERVAL=2;BYMONTH=7,12\"\n    [...]\n}\n\n ```\n\nWill repeat on:\n\n- `2020-02-01 12:00:00` (first notification based on `date_tz` and `time_tz`)\n    \n- `2020-07-01 12:00:00`\n    \n- `2020-12-01 12:00:00`\n    \n- `2022-07-01 12:00:00`\n    \n- `2022-12-01 12:00:00`\n    \n- `etc.`\n    \n\n## Every 2 years, in July and December on the last Thursday\n\n``` json\n{\n    [...] \n    \"date_tz\": \"2020-02-01\",\n    \"time_tz\": \"12:00:00\",\n    \"rrule\": \"FREQ=YEARLY;INTERVAL=2;BYMONTH=7,12;BYDAY=-1TH\"\n    [...]\n}\n\n ```\n\nWill repeat on:\n\n- `2020-02-01 12:00:00` (first notification based on `date_tz` and `time_tz`)\n    \n- `2020-07-30 12:00:00`\n    \n- `2020-12-31 12:00:00`\n    \n- `2022-07-28 12:00:00`\n    \n- `2022-12-29 12:00:00`\n    \n- `etc.`\n    \n\n# The Webhook\n\nWhen one or more reminders fire, you will receive a webhook to the `webhooks_url` specified in your application. The request will send a basic authentication header using the `http_basic_auth_username` and `http_basic_auth_password` you specified, and will have the following body:\n\n``` json\n{\n    \"application\": {\n      \"id\": 1,\n      \"user_id\": 1,\n      \"name\": \"My Application\",\n      \"default_reminder_time_tz\": \"09:00:00\",\n      \"webhook_url\": \"https://your-site-as8df7.com\",\n      \"http_basic_auth_username\": \"user\",\n      \"http_basic_auth_password\": \"pass\",\n      \"created_at\": \"2020-10-07T16:52:47.000000Z\",\n      \"updated_at\": \"2020-10-07T16:52:47.000000Z\"\n    },\n    \"notification_datetime_utc\": \"2020-10-07 16:59:00\",\n    \"reminders_notified\": [\n      {\n        \"id\": 1,\n        \"user_id\": 1,\n        \"application_id\": 1,\n        \"title\": \"Do something\",\n        \"notes\": null,\n        \"timezone\": \"Europe/Tallinn\",\n        \"date_tz\": \"2020-10-07\",\n        \"time_tz\": \"19:59:00\",\n        \"rrule\": null,\n        \"notify_in_advance\": null,\n        \"next_tz\": \"2020-10-07 19:59:00\",\n        \"next_utc\": \"2020-10-07 16:59:00\",\n        \"snoozed\": 0,\n        \"created_at\": \"2020-10-07T16:53:11.000000Z\",\n        \"updated_at\": \"2020-10-07T16:59:02.000000Z\"\n      }\n    ]\n}\n\n ```\n\n# Completing a reminder\n\nThe endpoint `/reminders/:id/complete` will do one of two things, depending on the reminder:\n\n- For one-time reminders (without a `rrule`), it will set the property `exhausted` to true right away.\n    \n- For recurring reminders (with an `rrule`), it will move the next expected occurrence (`next_tz` / `next_utc`) to the following recurrence based on the `rrule`. The property `exhausted` will be set to `true` when all the expected occurrences are finished, based on a COUNT property in the `rrule`, or an end date in the reminder.","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","isPublicCollection":false,"owner":"9648928","team":7037389,"collectionId":"27fc544d-1054-4e48-a505-af3d95b46738","publishedId":"SWEB3wHi","public":true,"publicUrl":"https://documenter-api.postman.tech/view/9648928/SWEB3wHi","privateUrl":"https://go.postman.co/documentation/9648928-27fc544d-1054-4e48-a505-af3d95b46738","customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"3B7CE5"},"documentationLayout":"classic-double-column","version":"8.10.0","publishDate":"2019-12-17T03:39:39.000Z","activeVersionTag":"latest","documentationTheme":"light","metaTags":{},"logos":{}},"statusCode":200},"environments":[],"user":{"authenticated":false,"permissions":{"publish":false}},"run":{"button":{"js":"https://run.pstmn.io/button.js","css":"https://run.pstmn.io/button.css"}},"web":"https://www.getpostman.com/","team":{"logo":"https://res.cloudinary.com/postman/image/upload/t_team_logo_pubdoc/v1/team/9b1383e4d7344377eb1a53d58075e66b10f11477dec14b743be1b1d3c48ec09c","favicon":""},"isEnvFetchError":false,"languages":"[{\"key\":\"csharp\",\"label\":\"C#\",\"variant\":\"HttpClient\"},{\"key\":\"csharp\",\"label\":\"C#\",\"variant\":\"RestSharp\"},{\"key\":\"curl\",\"label\":\"cURL\",\"variant\":\"cURL\"},{\"key\":\"dart\",\"label\":\"Dart\",\"variant\":\"http\"},{\"key\":\"go\",\"label\":\"Go\",\"variant\":\"Native\"},{\"key\":\"http\",\"label\":\"HTTP\",\"variant\":\"HTTP\"},{\"key\":\"java\",\"label\":\"Java\",\"variant\":\"OkHttp\"},{\"key\":\"java\",\"label\":\"Java\",\"variant\":\"Unirest\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"Fetch\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"jQuery\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"XHR\"},{\"key\":\"c\",\"label\":\"C\",\"variant\":\"libcurl\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Axios\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Native\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Request\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Unirest\"},{\"key\":\"objective-c\",\"label\":\"Objective-C\",\"variant\":\"NSURLSession\"},{\"key\":\"ocaml\",\"label\":\"OCaml\",\"variant\":\"Cohttp\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"cURL\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"Guzzle\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"HTTP_Request2\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"pecl_http\"},{\"key\":\"powershell\",\"label\":\"PowerShell\",\"variant\":\"RestMethod\"},{\"key\":\"python\",\"label\":\"Python\",\"variant\":\"http.client\"},{\"key\":\"python\",\"label\":\"Python\",\"variant\":\"Requests\"},{\"key\":\"r\",\"label\":\"R\",\"variant\":\"httr\"},{\"key\":\"r\",\"label\":\"R\",\"variant\":\"RCurl\"},{\"key\":\"ruby\",\"label\":\"Ruby\",\"variant\":\"Net::HTTP\"},{\"key\":\"shell\",\"label\":\"Shell\",\"variant\":\"Httpie\"},{\"key\":\"shell\",\"label\":\"Shell\",\"variant\":\"wget\"},{\"key\":\"swift\",\"label\":\"Swift\",\"variant\":\"URLSession\"}]","languageSettings":[{"key":"csharp","label":"C#","variant":"HttpClient"},{"key":"csharp","label":"C#","variant":"RestSharp"},{"key":"curl","label":"cURL","variant":"cURL"},{"key":"dart","label":"Dart","variant":"http"},{"key":"go","label":"Go","variant":"Native"},{"key":"http","label":"HTTP","variant":"HTTP"},{"key":"java","label":"Java","variant":"OkHttp"},{"key":"java","label":"Java","variant":"Unirest"},{"key":"javascript","label":"JavaScript","variant":"Fetch"},{"key":"javascript","label":"JavaScript","variant":"jQuery"},{"key":"javascript","label":"JavaScript","variant":"XHR"},{"key":"c","label":"C","variant":"libcurl"},{"key":"nodejs","label":"NodeJs","variant":"Axios"},{"key":"nodejs","label":"NodeJs","variant":"Native"},{"key":"nodejs","label":"NodeJs","variant":"Request"},{"key":"nodejs","label":"NodeJs","variant":"Unirest"},{"key":"objective-c","label":"Objective-C","variant":"NSURLSession"},{"key":"ocaml","label":"OCaml","variant":"Cohttp"},{"key":"php","label":"PHP","variant":"cURL"},{"key":"php","label":"PHP","variant":"Guzzle"},{"key":"php","label":"PHP","variant":"HTTP_Request2"},{"key":"php","label":"PHP","variant":"pecl_http"},{"key":"powershell","label":"PowerShell","variant":"RestMethod"},{"key":"python","label":"Python","variant":"http.client"},{"key":"python","label":"Python","variant":"Requests"},{"key":"r","label":"R","variant":"httr"},{"key":"r","label":"R","variant":"RCurl"},{"key":"ruby","label":"Ruby","variant":"Net::HTTP"},{"key":"shell","label":"Shell","variant":"Httpie"},{"key":"shell","label":"Shell","variant":"wget"},{"key":"swift","label":"Swift","variant":"URLSession"}],"languageOptions":[{"label":"C# - HttpClient","value":"csharp - HttpClient - C#"},{"label":"C# - RestSharp","value":"csharp - RestSharp - C#"},{"label":"cURL - cURL","value":"curl - cURL - cURL"},{"label":"Dart - http","value":"dart - http - Dart"},{"label":"Go - Native","value":"go - Native - Go"},{"label":"HTTP - HTTP","value":"http - HTTP - HTTP"},{"label":"Java - OkHttp","value":"java - OkHttp - Java"},{"label":"Java - Unirest","value":"java - Unirest - Java"},{"label":"JavaScript - Fetch","value":"javascript - Fetch - JavaScript"},{"label":"JavaScript - jQuery","value":"javascript - jQuery - JavaScript"},{"label":"JavaScript - XHR","value":"javascript - XHR - JavaScript"},{"label":"C - libcurl","value":"c - libcurl - C"},{"label":"NodeJs - Axios","value":"nodejs - Axios - NodeJs"},{"label":"NodeJs - Native","value":"nodejs - Native - NodeJs"},{"label":"NodeJs - Request","value":"nodejs - Request - NodeJs"},{"label":"NodeJs - Unirest","value":"nodejs - Unirest - NodeJs"},{"label":"Objective-C - NSURLSession","value":"objective-c - NSURLSession - Objective-C"},{"label":"OCaml - Cohttp","value":"ocaml - Cohttp - OCaml"},{"label":"PHP - cURL","value":"php - cURL - PHP"},{"label":"PHP - Guzzle","value":"php - Guzzle - PHP"},{"label":"PHP - HTTP_Request2","value":"php - HTTP_Request2 - PHP"},{"label":"PHP - pecl_http","value":"php - pecl_http - PHP"},{"label":"PowerShell - RestMethod","value":"powershell - RestMethod - PowerShell"},{"label":"Python - http.client","value":"python - http.client - Python"},{"label":"Python - Requests","value":"python - Requests - Python"},{"label":"R - httr","value":"r - httr - R"},{"label":"R - RCurl","value":"r - RCurl - R"},{"label":"Ruby - Net::HTTP","value":"ruby - Net::HTTP - Ruby"},{"label":"Shell - Httpie","value":"shell - Httpie - Shell"},{"label":"Shell - wget","value":"shell - wget - Shell"},{"label":"Swift - URLSession","value":"swift - URLSession - Swift"}],"layoutOptions":[{"value":"classic-single-column","label":"Single Column"},{"value":"classic-double-column","label":"Double Column"}],"versionOptions":[],"environmentOptions":[{"value":"0","label":"No Environment"}],"canonicalUrl":"https://documenter.gw.postman.com/view/metadata/SWEB3wHi"}