API Documentation

API

Note on HTML/JSON responses

HTML/JSON - this indicates whether the endpoint can respond with HTML, JSON or both responses. In all cases, the default response will be JSON unless either:

• an html=true url-encoded parameter is included in the request, or
• An Accept header is used that places text/html above application/json in priority. The Accept headers sent with a request by a browser will prefer HTML by default. In this case, html=false will override any Accept header and force a JSON response.

The HTML view will not be described in the API documentation if it is only a more readable version of the JSON response in the browser.

• System endpoints
  • The authentication system, healthcheck or heartbeat endpoint, JWT token and (browser) cookie generation.
• Link endpoints
  • Create, update, get lists of matching links, and deleting them.
• Groups endpoints
  • Get lists of links tagged with a group id, or delete the full set with a request.
• Motivation/Generator endpoints
  • Get, Add or delete motivation URIs and generator URIs to the registered sets.
• Short IDs and 'slugs'
  • Getting unique numbers, and making slug id links (short URLs that correspond to longer ones.)
• Preset convenience queries
  • Overview of some of the convenience queries (presets of motivation, generators and more for specific tasks.)