CMS Tool API

CMS Tool API schema

Public API version 1.4.10.

Endpoints

EndpointMethodsAccepts POSTDescriptionSchema
/api/basketGET, POSTYesRead and update shopping baskets and orders.View schema
/api/membergroupsGET, POSTYesRead and update member groups.View schema
/api/memberpointsGET, POSTYesRead and record member points adjustments.View schema
/api/memberpointsbalancesGETNoRead member points balances.View schema
/api/membernotesGET, POSTYesRead and update notes about members.View schema
/api/memberGET, POSTYesRead and update member records.View schema
/api/apistatusGETNoRead the authenticated website's status.View schema
/api/messageGET, POSTYesRead and update form submissions and enquiries.View schema
/api/eventAttendeeGET, POSTYesRead and update event attendees.View schema
/api/eventAttendee/statusMetaDataGETNoRead available attendee statuses.View schema
/api/eventsGET, POSTYesRead and update events.View schema
/api/commentsGET, POSTYesRead and update comments and reviews.View schema
/api/productGET, POSTYesRead and update products.View schema
/api/categoryGET, POSTYesRead and update product categories.View schema
/api/shippingGET, POSTYesRead and update shipping options.View schema
/api/paymentOptionGET, POSTYesRead and update payment options.View schema
/api/discountGET, POSTYesRead and update promotional discounts.View schema
/api/blogGET, POSTYesRead and update articles.View schema
/api/pageGET, POSTYesRead and update website pages.View schema
/api/bookingresourceGET, POSTYesRead and update bookable resources.View schema
/api/bookingGET, POSTYesRead and update bookings.View schema
/api/reference/countriesGETNoRead countries reference data.View schema
/api/reference/currenciesGETNoRead currencies reference data.View schema
/api/reference/fxGETNoRead fx reference data.View schema
/api/reference/categoriesGETNoRead categories reference data.View schema
/api/reference/memberlevelGETNoRead memberlevel reference data.View schema
/api/reference/hostingplansGETNoRead hostingplans reference data.View schema
/api/reference/timezonesGETNoRead timezones reference data.View schema
/api/reference/postcodesGETNoRead postcodes reference data.View schema
/api/webhook_{type}GET, POSTYesRead or update a webhook destination for a supported event type.View schema
/api/webhook_logGETNoRead webhook delivery history.View schema
/api/sendemailPOSTYesSend an email for the authenticated website.View schema
/api/bulkemailGET, POSTYesRead and update bulk email jobs.View schema
/api/statistics/visitorsGETNoRead visitor statistics.View schema
/api/statistics/activityGETNoRead activity statistics.View schema
/api/statistics/salesGETNoRead sales statistics.View schema
/api/files/{filePath}GET, POSTYesRead, upload, and download website files.View schema
/api/images/{imagePath}GET, POSTYesRead and update images under /images/ for the authenticated website.View schema
/api/logGETNoRead website activity entries.View schema
/api/logAPIGETNoRead API activity entries.View schema
/api/logMemberGETNoRead member activity entries.View schema
/api/authGET, POSTYesAuthenticate API clients with OAuth 2.0 and PKCE.View schema
/api/mcpPOSTYesUse authenticated CMS Tool operations through MCP.View schema
/api/schemaGETNoBrowse public API endpoint schemas.View schema
/api/changelogGETNoRead the public API change history.View schema

Machine-readable documentation

This documentation is also available as JSON or Markdown at the same URL. Request JSON with Accept: application/json or Markdown with Accept: text/markdown.