The staff API answers at https://<site>/api/v1. It is for the people running a site: the Ergon app, editorial tools, integrations.
Tokens
Create a token under Settings → API → Tokens and choose its abilities (for example content:read, forms:write, commerce:read). Send it as Authorization: Bearer …. A token only reaches what its abilities and the user's role allow.
The Ergon app signs in with POST /api/v1/app/login (email, password, two-factor code) and receives an access token with a refresh token, like the Site API; this needs ERGON_APP_AUTH=true on the site.
Deprecated
GET /api/v1/me answers with Deprecation, Sunset: Wed, 30 Jun 2027 and a Link to GET /api/v1/app/me, which returns the same fields inside data.
Reference
Base URL https://<site>/api/v1.
Generated from an installation with every plugin active; each site's own description is at /api/site/v1/openapi.json.
Account
GET
/me
The signed-in staff user (deprecated)
sign-in
Answers with Deprecation and Sunset (2027-06-30) headers. Use /app/me.
Answer · {"data": …}
Analytics
GET
/analytics
Analytics
sign-in
Answer · {"data": …}
App
POST
/app/login
Staff app sign-in (needs ERGON_APP_AUTH)
JSON body
email * | string (email) | |
password * | string | |
code | string | two-factor |
device | string |
Answer · {"data": …}
POST
/app/logout
Sign out this device
sign-in
Answer · {"data": …}
POST
/app/logout-all
Sign out every device
sign-in
Answer · {"data": …}
GET
/app/me
The signed-in staff user and the token's abilities
sign-in
Answer · {"data": …}
POST
/app/refresh
Renew the staff access token
JSON body
refresh_token * | string |
Answer · {"data": …}
Collections
GET
/collections
Collections.types
sign-in
Answer · {"data": …}
GET
/collections/{typeKey}
Collections.index
sign-in
Parameters
typeKey * | path |
Answer · {"data": …}
POST
/collections/{typeKey}
Collections.store
sign-in
Parameters
typeKey * | path |
Answer · {"data": …}
GET
/collections/{typeKey}/{id}
Collections.show
sign-in
Parameters
typeKey * | path | |
id * | path |
Answer · {"data": …}
PUT
/collections/{typeKey}/{id}
Collections.update
sign-in
Parameters
typeKey * | path | |
id * | path |
Answer · {"data": …}
PATCH
/collections/{typeKey}/{id}
Collections.update
sign-in
Parameters
typeKey * | path | |
id * | path |
Answer · {"data": …}
DELETE
/collections/{typeKey}/{id}
Collections.destroy
sign-in
Parameters
typeKey * | path | |
id * | path |
Answer · {"data": …}
Comments
GET
/comments
Comments.index
sign-in
Answer · {"data": …}
DELETE
/comments/{id}
Comments.destroy
sign-in
Parameters
id * | path |
Answer · {"data": …}
POST
/comments/{id}/approve
Comments.approve
sign-in
Parameters
id * | path |
Answer · {"data": …}
POST
/comments/{id}/reply
Comments.reply
sign-in
Parameters
id * | path |
Answer · {"data": …}
POST
/comments/{id}/unapprove
Comments.unapprove
sign-in
Parameters
id * | path |
Answer · {"data": …}
Commerce
GET
/commerce/coupons
Commerce.coupons.index
sign-in
Answer · {"data": …}
POST
/commerce/coupons
Commerce.coupons.store
sign-in
Answer · {"data": …}
GET
/commerce/coupons/{id}
Commerce.coupons.show
sign-in
Parameters
id * | path |
Answer · {"data": …}
PUT
/commerce/coupons/{id}
Commerce.coupons.update
sign-in
Parameters
id * | path |
Answer · {"data": …}
PATCH
/commerce/coupons/{id}
Commerce.coupons.update
sign-in
Parameters
id * | path |
Answer · {"data": …}
DELETE
/commerce/coupons/{id}
Commerce.coupons.destroy
sign-in
Parameters
id * | path |
Answer · {"data": …}
GET
/commerce/download-files
Commerce.downloads.files
sign-in
Answer · {"data": …}
GET
/commerce/download-grants
Commerce.downloads.grants
sign-in
Answer · {"data": …}
GET
/commerce/invoices
Commerce.invoices.index
sign-in
Answer · {"data": …}
GET
/commerce/invoices/{id}
Commerce.invoices.show
sign-in
Parameters
id * | path |
Answer · {"data": …}
GET
/commerce/orders/{orderId}/messages
Ordercomm.index
sign-in
Parameters
orderId * | path |
Answer · {"data": …}
POST
/commerce/orders/{orderId}/messages
Ordercomm.store
sign-in
Parameters
orderId * | path |
Answer · {"data": …}
POST
/commerce/orders/{orderId}/messages/read
Ordercomm.read
sign-in
Parameters
orderId * | path |
Answer · {"data": …}
GET
/commerce/reviews
Commerce.reviews.index
sign-in
Answer · {"data": …}
DELETE
/commerce/reviews/{id}
Commerce.reviews.destroy
sign-in
Parameters
id * | path |
Answer · {"data": …}
POST
/commerce/reviews/{id}/status
Commerce.reviews.status
sign-in
Parameters
id * | path |
Answer · {"data": …}
GET
/commerce/subscriptions
Commerce.subscriptions.index
sign-in
Answer · {"data": …}
GET
/commerce/subscriptions/{id}
Commerce.subscriptions.show
sign-in
Parameters
id * | path |
Answer · {"data": …}
GET
/commerce/wishlists
Commerce.wishlists
sign-in
Answer · {"data": …}
Devices
POST
/devices
Devices.store
sign-in
Answer · {"data": …}
DELETE
/devices
Devices.destroy
sign-in
Answer · {"data": …}
Forms
GET
/forms
Forms.index
sign-in
Answer · {"data": …}
POST
/forms/submissions/{id}/read
Forms.read
sign-in
Parameters
id * | path |
Answer · {"data": …}
GET
/forms/{id}/submissions
Forms.submissions
sign-in
Parameters
id * | path |
Answer · {"data": …}
Health
GET
/health
Health
sign-in
Answer · {"data": …}
Inquiries
GET
/inquiries
Inquiries.index
sign-in
Answer · {"data": …}
GET
/inquiries/{id}
Inquiries.show
sign-in
Parameters
id * | path |
Answer · {"data": …}
PATCH
/inquiries/{id}
Inquiries.update
sign-in
Parameters
id * | path |
Answer · {"data": …}
POST
/inquiries/{id}/read
Inquiries.read
sign-in
Parameters
id * | path |
Answer · {"data": …}
Live Chat
GET
/live-chat/conversations
Livechat.conversations
sign-in
Answer · {"data": …}
GET
/live-chat/conversations/{conversation}
Livechat.messages
sign-in
Parameters
conversation * | path |
Answer · {"data": …}
POST
/live-chat/conversations/{conversation}
Livechat.reply
sign-in
Parameters
conversation * | path |
Answer · {"data": …}
Media
GET
/media
Media.index
sign-in
Answer · {"data": …}
POST
/media
Media.store
sign-in
Answer · {"data": …}
PUT
/media/{id}
Media.update
sign-in
Parameters
id * | path |
Answer · {"data": …}
PATCH
/media/{id}
Media.update
sign-in
Parameters
id * | path |
Answer · {"data": …}
DELETE
/media/{id}
Media.destroy
sign-in
Parameters
id * | path |
Answer · {"data": …}
Membership
GET
/membership/locks
Membership.locks
sign-in
Answer · {"data": …}
GET
/membership/tiers
Membership.tiers
sign-in
Answer · {"data": …}
POST
/membership/tiers
Membership.tiers.store
sign-in
Answer · {"data": …}
PUT
/membership/tiers/{id}
Membership.tiers.update
sign-in
Parameters
id * | path |
Answer · {"data": …}
PATCH
/membership/tiers/{id}
Membership.tiers.update
sign-in
Parameters
id * | path |
Answer · {"data": …}
DELETE
/membership/tiers/{id}
Membership.tiers.destroy
sign-in
Parameters
id * | path |
Answer · {"data": …}
POST
/membership/tiers/{id}/toggle
Membership.tiers.toggle
sign-in
Parameters
id * | path |
Answer · {"data": …}
Menus
Newsletter
Notifications
GET
/notifications
Notifications.index
sign-in
Answer · {"data": …}
POST
/notifications/read-all
Notifications.read All
sign-in
Answer · {"data": …}
POST
/notifications/{id}/read
Notifications.read
sign-in
Parameters
id * | path |
Answer · {"data": …}
Orders
GET
/orders
Commerce.orders.index
sign-in
Answer · {"data": …}
GET
/orders/{reference}
Commerce.orders.show
sign-in
Parameters
reference * | path |
Answer · {"data": …}
PUT
/orders/{reference}
Commerce.orders.update
sign-in
Parameters
reference * | path |
Answer · {"data": …}
PATCH
/orders/{reference}
Commerce.orders.update
sign-in
Parameters
reference * | path |
Answer · {"data": …}
Pages
GET
/pages
Pages.index
sign-in
Answer · {"data": …}
POST
/pages
Pages.store
sign-in
Answer · {"data": …}
PUT
/pages/{id}
Pages.update
sign-in
Parameters
id * | path |
Answer · {"data": …}
PATCH
/pages/{id}
Pages.update
sign-in
Parameters
id * | path |
Answer · {"data": …}
DELETE
/pages/{id}
Pages.destroy
sign-in
Parameters
id * | path |
Answer · {"data": …}
POST
/pages/{id}/publish
Pages.publish
sign-in
Parameters
id * | path |
Answer · {"data": …}
POST
/pages/{id}/unpublish
Pages.unpublish
sign-in
Parameters
id * | path |
Answer · {"data": …}
GET
/pages/{slug}
Pages.show
sign-in
Parameters
slug * | path |
Answer · {"data": …}
Plugins
GET
/plugins
Plugins.index
sign-in
Answer · {"data": …}
POST
/plugins/activate
Plugins.activate
sign-in
Answer · {"data": …}
POST
/plugins/deactivate
Plugins.deactivate
sign-in
Answer · {"data": …}
POST
/plugins/update
Plugins.update
sign-in
Answer · {"data": …}
Posts
GET
/posts
Blog.posts.index
sign-in
Answer · {"data": …}
POST
/posts
Blog.posts.store
sign-in
Answer · {"data": …}
PUT
/posts/{id}
Blog.posts.update
sign-in
Parameters
id * | path |
Answer · {"data": …}
PATCH
/posts/{id}
Blog.posts.update
sign-in
Parameters
id * | path |
Answer · {"data": …}
DELETE
/posts/{id}
Blog.posts.destroy
sign-in
Parameters
id * | path |
Answer · {"data": …}
POST
/posts/{id}/publish
Blog.posts.publish
sign-in
Parameters
id * | path |
Answer · {"data": …}
POST
/posts/{id}/unpublish
Blog.posts.unpublish
sign-in
Parameters
id * | path |
Answer · {"data": …}
GET
/posts/{slug}
Blog.posts.show
sign-in
Parameters
slug * | path |
Answer · {"data": …}
Posts Taxonomies
GET
/posts-taxonomies
Blog.taxonomies
sign-in
Answer · {"data": …}
POST
/posts-taxonomies/category
Blog.category.create
sign-in
Answer · {"data": …}
POST
/posts-taxonomies/tag
Blog.tag.create
sign-in
Answer · {"data": …}
Products
GET
/products
Commerce.products.index
sign-in
Answer · {"data": …}
POST
/products
Commerce.products.store
sign-in
Answer · {"data": …}
GET
/products/{slug}
Commerce.products.show
sign-in
Parameters
slug * | path |
Answer · {"data": …}
PUT
/products/{slug}
Commerce.products.update
sign-in
Parameters
slug * | path |
Answer · {"data": …}
PATCH
/products/{slug}
Commerce.products.update
sign-in
Parameters
slug * | path |
Answer · {"data": …}
DELETE
/products/{slug}
Commerce.products.destroy
sign-in
Parameters
slug * | path |
Answer · {"data": …}
Search
GET
/search
Search
sign-in
Answer · {"data": …}
Site
GET
/site
The site and what this token may do
sign-in
Answer · {"data": …}
GET
/site/summary
The app's site card
sign-in
Answer · {"data": …}
Site Settings
GET
/site-settings
Settings.show
sign-in
Answer · {"data": …}
PUT
/site-settings
Settings.update
sign-in
Answer · {"data": …}
PATCH
/site-settings
Settings.update
sign-in
Answer · {"data": …}
Stats
GET
/stats
Stats
sign-in
Answer · {"data": …}
Updates
GET
/updates
Updates
sign-in
Answer · {"data": …}
POST
/updates/apply
Updates.apply
sign-in
Answer · {"data": …}