||List all pending tasks.|
||Given a task payload, create a new task.|
||Get task details.|
||Given a JSON task payload, update the task’s details.|
||Mark the existing task as completed.|
Non-users of Taskwarrior may be surprised by the
behavior of this endpoint given that the task is not actually deleted, but
instead marked as completed, but this implementation is much more consistent
with Taskwarrior workflows.
To truly delete a task, see Delete a Task below.
Delete a Task¶
||Mark an existing task as deleted.|
Although using the
DELETE method on the
Task Details endpoint may seem to be more intuitive, it is far
more common for one to mark a task as completed than deleted.
If that doesn’t set your mind at ease, try to think
of the Task List and Task Details endpoints as being listings of
only pending tasks, and that by issuing a
you’re removing it from your pending task list (and
moving it to your completed task list).
Start a Task¶
||Mark an existing task as started.|
Stop a Task¶
||Mark an existing task as stopped.|
Returns an RSS representation of your current pending tasks.
This endpoint is not authenticated, and is thus disabled unless specifically enabled in your configuration.
After enabling this endpoint in your configuration, you will be
given the proper URL to use (including your
||RSS Tasks Feed.|
Do not use this endpoint unless you absolutely know what you are doing. Manually unlocking your repository while an action is in progress may result in data loss!
|DELETE||Manually unlock your repository.|
|GET||Check whether your repository is currently locked. Will return a 200 if it is, and a 404 if it is not.|
You can re-enable synchronization if it has been disabled
by sending an empty
POST to this endpoint.
Returns brief JSON-formatted information about the currently logged-in user.
This endpoint does not require authentication. If you are not authenticated via an API key or a cookie, you will receive only limited information.
||Get user data.|
Returns a JSON-formatted list of recent announcements.
Download my certificate¶
Returns your currently-active certificate used for communicating with Inthe.AM.
Download my key¶
Returns your currently-active key used for communicating with Inthe.AM.
Download CA certificate¶
Returns Inthe.AM’s certificate; this is used for synchronizing with Inthe.AM’s taskd server.
||Get CA certificate.|
Locally, Inthe.AM runs Taskwarrior in a way that’s very similar to
how you interact with Taskwarrior on your personal computer, and a
.taskrc file is read and used for calculating things like UDAs
Use this endpoint to see or set your current
.taskrc’s contents on
Generate a new taskserver certificate¶
If you would like to regenerate your Taskserver certificate, usually because your existing one has expired, you can do so using this endpoint.
||Generate new Taskserver Certificate.|
Reset taskserver settings¶
If you’ve changed your Taskserver settings, but you’d like to reset
them such that Inthe.AM’s built-in taskserver is utilized, send an empty
POST request to this endpoint.
Using this endpoint does a number of things:
- Resets your Taskserver synchronization settings such that Inthe.AM will synchronize with the built-in Taskserver.
- Clears any previously-synced tasks from your Inthe.AM Taskserver account. This is to make sure that you have a clean slate.
- Clears the local Taskwarrior repository’s
None of these should be considered particularly dangerous, but this is not an operation that can be undone without administrative intervention.
||Reset Taskserver configuration.|
SMS messaging (Twilio) integration¶
You can configure or enable SMS integration by
POST request to this endpoint with
two form-encoded variables:
twilio_auth_token: Your Twilio Auth Token. This is used for authenticating the SMS request from Twilio.
sms_whitelist: A newline-separated list of phone numbers from which you would like to accept new tasks.
sms_replies: An integer indicating under what conditions should Inthe.AM send SMS message replies. See the table below for information about what values are appropriate:
Value Meaning 0 Do not reply to any incoming text messages 5 Reply only to error messages 9 Reply to all messages
||Configure SMS Integration.|
You can configure which e-mail addresses are allowed to send new
tasks to your personal task creation e-mail address by sending a
to this address with the following form-encoded variable:
email_whitelist: A newline-separated list of e-mail addresses from which you will allow new tasks to be created when an e-mail email message is received.
||Configure Email Integration.|
Clear task data¶
You can clear your taskserver information by sending a
to this endpoint.
Please note that this does not permanently delete your task information; it only clears your taskserver information; if you would like your taskserver information cleared permanently, please send an email to firstname.lastname@example.org.
||Clear Taskserver information.|
You can configure the colorscheme used when displaying your tasks
by sending a
PUT request to this URL having a body matching
the colorscheme you would like to use.
You can also send a
GET request to find the name of the colorscheme
currently in use.
||Get current colorscheme.|
You can enable or disable the RSS feed showing your upcoming tasks by
- To enable: Send a single form-encoded parameter –
enabledin the request.
- To disable: Send an empty request.
||Enable/Disable RSS feed.|