├── .github └── ISSUE_TEMPLATE │ ├── bug_report.md │ └── feature_request.md ├── CHANGELOG.md ├── README.md └── images ├── Animation3.png ├── Lab.png └── Run.gif /.github/ISSUE_TEMPLATE/bug_report.md: -------------------------------------------------------------------------------- 1 | --- 2 | name: Bug report 3 | about: Report a Marvin API bug 4 | title: "[BUG]" 5 | labels: bug 6 | assignees: amazingmarvin 7 | 8 | --- 9 | 10 | **Statement of purpose** 11 | 12 | I do solemnly swear (or affirm) that this is an API bug, and not a Marvin bug. For Marvin bugs I would use the in-app "?→Contact Support" feature 13 | 14 | 15 | 16 | **Describe the bug** 17 | A clear and concise description of what the bug is. 18 | 19 | **Endpoint(s) in question** 20 | e.g. `/api/track` 21 | 22 | **To Reproduce** 23 | 24 | e.g. 25 | ``` 26 | curl \ 27 | -XPOST \ 28 | -H'X-API-Token: redacted' \ 29 | --data '{"taskId":"xyz","action":"STOP"}' \ 30 | https://serv.amazingmarvin.com/api/track 31 | ``` 32 | 33 | or sample code, or ? 34 | 35 | **Expected behavior** 36 | A clear and concise description of what you expected to happen. 37 | 38 | **Screenshots** 39 | If applicable, add screenshots to help explain your problem. 40 | 41 | **HTTP client:** 42 | * curl? browser (w/ CORS details)? language library? 43 | 44 | **Additional context** 45 | Add any other context about the problem here. 46 | -------------------------------------------------------------------------------- /.github/ISSUE_TEMPLATE/feature_request.md: -------------------------------------------------------------------------------- 1 | --- 2 | name: Feature request 3 | about: Request a Marvin API feature 4 | title: "[REQUEST]" 5 | labels: request 6 | assignees: amazingmarvin 7 | 8 | --- 9 | 10 | **Statement of purpose** 11 | I do solemnly swear (or affirm) that this is an API feature request and not a Marvin feature request. For a Marvin feature request I would use [Product Board](https://portal.productboard.com/gvwfgxmcwqylldrxlfagmgkw). 12 | 13 | 14 | 15 | **Is your feature request related to a problem? Please describe.** 16 | A clear and concise description of what the problem is. Ex. I'm always frustrated when [...] 17 | 18 | **Describe the solution you'd like** 19 | A clear and concise description of what you want to happen. 20 | 21 | **Describe alternatives you've considered** 22 | A clear and concise description of any alternative solutions or features you've considered. 23 | 24 | **Additional context** 25 | Add any other context or screenshots about the feature request here. 26 | -------------------------------------------------------------------------------- /CHANGELOG.md: -------------------------------------------------------------------------------- 1 | # 2024-05-23 2 | * Fixed review date in Tasks created through API 3 | 4 | # 2024-05-23 5 | * Document change to /api/children 6 | 7 | # 2024-01-03 8 | * Documented ?raw=1 for /api/habits endpoint 9 | 10 | # 2023-03-21 11 | * Now only tasks and projects/categories are returned in /api/children (previously Time Blocks could sneak in) 12 | 13 | # 2023-03-13 14 | * Documented /api/habits 15 | 16 | # 2023-03-09 17 | * Documented /api/updateHabit 18 | 19 | # 2023-03-06 20 | * Improved Reminder documentation 21 | 22 | # 2023-03-01 23 | * Documented /api/children 24 | * Documented /api/todayTimeBlocks 25 | * Improved Category/Project documentation 26 | 27 | # 2023-02-06 28 | * Added X-Auto-Complete to /api/addTask 29 | 30 | # 2023-01-19 31 | * Documented experimental /api/markDone 32 | 33 | # 2022-12-05 34 | * Document /api/goals 35 | * Add ##Goal as shortcut when adding a task via API 36 | 37 | # 2022-09-11 38 | * Document adding date to /api/dueItems 39 | 40 | # 2022-08-08 41 | * ID of new item now sent when creating tasks, projects, and events 42 | 43 | # 2022-04-05 44 | * Document /api/doc/create 45 | * Document /api/doc/delete 46 | * Improve documentation for /api/doc/update 47 | 48 | # 2022-03-26 49 | * Documented bugfix/breaking change in /api/doc 50 | 51 | # 2022-03-24 52 | * Documented /api/update 53 | 54 | # 2022-02-24 55 | * Added Tracking and TrackingSince to /api/me 56 | 57 | # 2022-02-23 58 | * Documented Reminders and Reminder APIs 59 | 60 | # 2022-01-29 61 | * Documented timeZoneFix 62 | 63 | # 2021-11-16 64 | * Documented RecurringTasks, SavedItems, and Recurrence in general 65 | 66 | # 2021-11-15 67 | * Documented /api/todayItems date parameter 68 | 69 | # 2021-08-22 70 | * Documented /api/addEvent 71 | 72 | # 2021-07-11 73 | * Documented /api/tracks 74 | 75 | # 2021-06-30 76 | * Documented new webhooks 77 | * Improved time block documentation 78 | * Documented user configuration (ProfileItems) 79 | 80 | # 2021-06-07 81 | * Improved Webhooks CORS documentation (this is a frequent source of confusion) 82 | 83 | # 2021-06-05 84 | * Documented Rewards 85 | * Documented BillingPeriod (in /api/me) 86 | 87 | # 2021-04-04 88 | * Documented improved tomato timer webhooks. Now "timerDone" is dispatched after each work/break session finishes. 89 | 90 | # 2021-03-08 91 | * Documented Trackers 92 | 93 | # 2021-02-25 94 | * Documented Calendars and Events 95 | 96 | # 2021-02-24 97 | * Documented Habits 98 | 99 | # 2021-02-23 100 | * Documented Goals 101 | 102 | # 2021-02-08 103 | * Documented /api/me 104 | * Documented habit webhooks 105 | 106 | # 2021-01-17 107 | * Documented /api/kudos 108 | 109 | # 2020-10-15 110 | * Documented Webhooks 111 | * Documented Timer formats 112 | * Documented conflicts and `fieldUpdates` in direct database access page 113 | 114 | # 2020-09-08 115 | * Added /api/addProject 116 | * Added support for more task fields in /api/addTask: bonusSection, customSection, timeBlockSection, rewardPoints, rewardId, backburner, reviewDate, timeEstimate, itemSnoozeTime, permaSnoozeTime 117 | * Added /api/claimRewardPoints 118 | * Added /api/unclaimRewardPoints 119 | * Added /api/spendRewardPoints 120 | * Added /api/resetRewardPoints 121 | 122 | # 2020-07-26 123 | * Start/stop time tracking API 124 | 125 | # 2020-07-17 126 | * Published API documentation 127 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # Amazing Marvin API documentation 2 | Head on over to the [wiki](https://github.com/amazingmarvin/MarvinAPI/wiki) to get started. 3 | 4 | 5 | 6 | # API changelog 7 | See [`CHANGELOG.md`](https://github.com/amazingmarvin/MarvinAPI/blob/master/CHANGELOG.md) for changes in the public API. 8 | 9 | 10 | 11 | # API bugs and feature requests 12 | Create an [issue](https://github.com/amazingmarvin/MarvinAPI/issues). 13 | 14 | 15 | -------------------------------------------------------------------------------- /images/Animation3.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/amazingmarvin/MarvinAPI/39fae12f4a230fb58aa83281b637c47e7c54afd4/images/Animation3.png -------------------------------------------------------------------------------- /images/Lab.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/amazingmarvin/MarvinAPI/39fae12f4a230fb58aa83281b637c47e7c54afd4/images/Lab.png -------------------------------------------------------------------------------- /images/Run.gif: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/amazingmarvin/MarvinAPI/39fae12f4a230fb58aa83281b637c47e7c54afd4/images/Run.gif --------------------------------------------------------------------------------