REST API

HyperKitty comes with a small REST API allowing you to programatically retrieve emails and information.

Formats

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:

• json (?format=json)
• json-p (?format=json-p)
• Plain text (?format=txt)
• xml (?format=xml)
• html (?format=html)
• xhtml (?format=xhtml)

List of mailing-lists

Endpoint: /archives/api/lists/

Using this address you will be able to retrieve the information known about all the mailing lists.

Threads in a mailing list

Endpoint: /archives/api/list/list-address@example.com/threads/

Using this address you will be able to retrieve information about all the threads on the specified mailing list.

Emails in a thread

Endpoint: /archives/api/list/list-address@example.com/thread/THREAD-ID/emails/

Using this address you will be able to retrieve the list of emails in a mailing list thread.

An email in a mailing list

Endpoint: /archives/api/list/list-address@example.com/email/MESSAGE-ID-HASH/

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

Tags

Endpoint: /archives/api/tags/

Using this address you will be able to retrieve the list of tags.