Tools

List the full tool registry

Returns the tools currently offered. The three query parameters narrow the list and can be combined; each one is applied only when present.

get/public/tools

Request

  • Base URL: https://api.johnsessentials.com/api/v1
  • URL: https://api.johnsessentials.com/api/v1/public/tools
  • Auth: HTTP bearer

Query parameters

categorystring
Example:pdf

Only tools in this category. Exact, case-sensitive match against each tool's category field, for example pdf, photo, media, convert, analyze or generate. A category no tool has returns an empty list, not an error.

tierstring
Example:starter

Only tools whose tier_required is exactly this plan: free, starter, business or enterprise (case-insensitive). It is not "everything this plan can use" — starter returns the Starter tools and leaves out the free ones. The older names pro and premium are read as starter and business. Any other value is read as free.

enabledboolean

Leave it out (or send anything other than false) to list only the tools currently offered. Send false to include withdrawn tools as well; they carry is_enabled: false. No value lists withdrawn tools on their own.

Response

Tool list.

request_idstring uuid required
successboolean required

Example response

{
  "data": {
    "tools": [
      {
        "category": "pdf",
        "name": "pdf_compress"
      }
    ]
  },
  "meta": {
    "version": "1.0"
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.