{% extends "base.html" %} {% load url from future %} {% block content %}
HyperKitty comes with a small REST API allowing you to programatically retrieve emails and information.
This REST API can return the information into several formats.
The default format is html to allow human readibility.
To change the format, just add
?format=<FORMAT> to the url
The list of available formats is:
Using the address /api/list/ you will be able to retrieve the information known about all the mailing-lists.
For example: {% url 'api_list' %}
Using the address /api/email/<list name>/<Message-ID> you will be able to retrieve the information known about a specific email on the specified mailing-list.
For example: {% url 'api_email' mlist_fqdn='devel@fp.o' messageid='13129854572893334' %}
Using the address /api/thread/<list name>/<Message-ID> you will be able to retrieve the all the email for a specific thread on the specified mailing-list.
For example: {% url 'api_thread' mlist_fqdn='devel@fp.o' threadid='13129854572893334' %}
Using the address /api/search/<list name>/<field>/<keyword> you will be able to search for all emails of the specified mailing-list containing the provided keyword in the given field.
The list of available field is:
For example: {% url 'api_search' mlist_fqdn='devel@fp.o' field='From' keyword='pingoured' %}
Using the address /api/tag/ you will be able to retrieve the list of tags.
For example: {% url 'api_tag' %}