Everything the web and mobile apps do goes through the REST API, including pages and blocks, lists, profiles, content, files, search and actions. You manage keys and access on the API page in Studio, and the NEO client shows how to use it.
API keys and allowed origins, managed in Studio
Pages, blocks and lists as JSON, filtered by permissions
An OAuth 2.0 server for third-party apps
Web
Native
Studio
Agents
How it works
The same endpoints for apps, scripts and agents.
A client connects with an API key or from an allowed origin, and a signed-in member uses their session. The JSON is the same the apps render, filtered by what that member may see.
An API key or an allowed origin, plus the session of a signed-in member
Pages, lists and blocks come back as JSON, paginated and filtered by permissions
Posting, joining, following and messaging are API calls too
Add your own endpoints and modules next to the built-in ones
request
GET /api.php?r=system/get_page_by_request/TemplServicePages
¶ms[]=home
Authorization: Bearer <your-api-key>
response
{
"status": 200,
"module": "system",
"method": "get_page_by_request",
"data": {
"uri": "home",
"title": "Home",
"elements": { … }
}
}
Capabilities
What the API covers.
Keys and origins
Create and revoke API keys in Studio, and choose whether clients connect by key, by allowed origin or both.
Pages and blocks
Any page built in Studio is available as JSON, with its blocks, data, menus and metadata.
Lists and search
Lists for every module with filters, pagination and the same privacy rules as the web.
Actions
Create content, join, follow, react, comment and send messages through the same endpoints the apps use.
OAuth 2.0 server
Issue tokens to partners and your own apps, with UNA as the identity provider.
Reference client
NEO, the Next.js and React Native client, is built on this API and is open source.
Predictable responses
Every call answers with the same envelope: a status, the module and method, and the data.
For builders
Learn it once and use it for every module.
The same sign-in for web, apps, scripts and agents
The same response format and pagination in every module
Documented in the wiki, with NEO as a working example
Get started
Read the API docs and make your first call.
Create a key in Studio, call a page endpoint and build from there. Talk to us when you need custom endpoints.
Custom apps, integrations and design for your use case
Your own branded apps in the App Store and Google Play