{% extends "hyperkitty/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:
Endpoint: {% url 'hk_api_mailinglist_list' %}
Using this address you will be able to retrieve the information known about all the mailing-lists.
Endpoint: {% url 'hk_api_thread_list' mlist_fqdn='list-address@example.com' %}
Using this address you will be able to retrieve information about all the threads on the specified mailing-list.
Endpoint: {% url 'hk_api_thread_email_list' mlist_fqdn='list-address@example.com' thread_id='THREAD-ID' %}
Using this address you will be able to retrieve the list of emails in a mailing-list thread.
Endpoint: {% url 'hk_api_email_detail' mlist_fqdn='list-address@example.com' message_id_hash='MESSAGE-ID-HASH' %}
Using this address you will be able to retrieve the information known about a specific email on the specified mailing-list.
Endpoint: {% url 'hk_api_tag_list' %}
Using this address you will be able to retrieve the list of tags.
{% endblock %}