{% extends "hyperkitty/base.html" %} {% load i18n %} {% block content %}

{% trans "REST API" %}

{% trans "HyperKitty comes with a small REST API allowing you to programatically retrieve emails and information." %}

{% trans "Formats" %}

{% trans "This REST API can return the information into several formats. The default format is html to allow human readibility." %}
{% trans 'To change the format, just add ?format=<FORMAT> to the URL.' %}

{% trans "The list of available formats is:" %}

{% trans "List of mailing-lists" %}

{% trans "Endpoint:" %} {% url 'hk_api_mailinglist_list' %}

{% trans "Using this address you will be able to retrieve the information known about all the mailing lists." %}

{% trans "Threads in a mailing list" %}

{% trans "Endpoint:" %} {% url 'hk_api_thread_list' mlist_fqdn='list-address@example.com' %}

{% trans "Using this address you will be able to retrieve information about all the threads on the specified mailing list." %}

{% trans "Emails in a thread" %}

{% trans "Endpoint:" %} {% url 'hk_api_thread_email_list' mlist_fqdn='list-address@example.com' thread_id='THREAD-ID' %}

{% trans "Using this address you will be able to retrieve the list of emails in a mailing list thread." %}

{% trans "An email in a mailing list" %}

{% trans "Endpoint:" %} {% url 'hk_api_email_detail' mlist_fqdn='list-address@example.com' message_id_hash='MESSAGE-ID-HASH' %}

{% trans "Using this address you will be able to retrieve the information known about a specific email on the specified mailing list." %}

{% trans "Tags" %}

{% trans "Endpoint:" %} {% url 'hk_api_tag_list' %}

{% trans "Using this address you will be able to retrieve the list of tags." %}

{% endblock %}