HoplaDocs

Endpoints

All API endpoints by group, with links to the API reference.

Base URL: https://app.hopla.page/api/v2, JSON over HTTPS, UTF-8. Every request is authenticated with an API key in the Authorization header. Endpoints with a method other than GET modify the page, except the three web fetching endpoints: a read-only key receives 403 read_only_key on them.

Page

Full page and its settings: profile, theme, social links, colors, SEO.

3 endpoints
GET/pageGet pageGET/settingsGet settingsPATCH/settingsUpdate settings

Blocks

Page blocks: links, headings, text, videos, products, FAQ…

7 endpoints
GET/blocksList blocksPOST/blocksCreate blockGET/blocks/{id}Get blockPATCH/blocks/{id}Update blockDELETE/blocks/{id}Delete blockPOST/blocks/{id}/duplicateDuplicate blockPUT/blocks/orderReorder blocks

Analytics

Views, visitors and clicks, cookieless: visitor IP addresses are never stored.

3 endpoints
GET/analyticsGet analyticsGET/analytics/weekGet weekly viewsGET/analytics/summaryGet analytics summary

Sharing

QR code of the page.

1 endpoint
GET/qr-codeGet QR code

Images

Upload images for profile photos, thumbnails, galleries or backgrounds.

1 endpoint
POST/mediaUpload image

Email list

Subscribers collected by the email signup block: list, export, delete, sync to a newsletter.

4 endpoints
GET/email-listGet email list summaryGET/subscribersList subscribersDELETE/subscribers/{id}Delete subscriberPOST/subscribers/syncSync pending subscribers

Web fetching

Metadata the admin panel reads from a pasted URL: website title and image, feed posts, review rating.

3 endpoints
POST/fetch/previewFetch URL metadataPOST/fetch/feedFetch feedPOST/fetch/ratingFetch review rating

Account

Plan, trial, included features, API keys and data export.

3 endpoints
GET/accountGet accountGET/api-keysList API keysGET/exportExport account data

Reference values

Valid values for themes, social networks, icons and block types.

4 endpoints
GET/social-networksList social networksGET/iconsList iconsGET/block-typesList block typesGET/themesList themes

GET https://app.hopla.page/api/v2, without authentication, returns a plain text version of this documentation, for AI agents.

Reference values

Valid values for themes, social networks, icons and block types.

Errors and rate limits

API rate limits, error format and error codes.