Applicable Plans: All plans
Heads Up:
While it’s available on all plans now, this might change in the future.
We might not be able to help with setting up or troubleshooting external services through chat support. Check out our Discord community for past posts or to ask new questions.
What is API Connect (Beta)
API Connect (Beta) lets you fetch data from external services that offer APIs and display it in dynamic lists in STUDIO. For example, you can show data managed in Notion right on STUDIO.
Note: Currently, you can only display API-fetched data in lists, not on dynamic pages.
Requirements
API Methods
STUDIO supports these API methods:GET
POST
Response Data Type
Only array-type response data (list format) can be linked. If the API response doesn’t include array-type fields, the data can’t be used. Even if integration is confirmed, the data won’t display in dynamic lists.
Important: You can only fetch data from external services using GET or POST methods. You can’t export data from STUDIO to external services.
Steps to connect to Notion API and Airtable API
You can connect to APIs from Notion and Airtable directly in the STUDIO editor.
See the following articles for service-specific steps.
Steps to connect to a custom API
If an external service lets you retrieve data using the GET (or POST) method, you can integrate it as a custom API.
1. Prepare API Endpoint (URL) and Access Keys
Get your API endpoint (URL) and access keys ready, then open the STUDIO Design Editor.
2. Connect to API in STUDIO
In the left-hand panel, open the API tab and click [+ Add New].
Select [Custom API] on the displayed screen.
Add the API URL and click [Check API call].
When verified successfully, [API Call has been checked] will be displayed. Click outside the settings frame to return to the editor.
Tip: You can add up to one parameter.
3. Link API Data to Lists
Once integrated, the linked API request will appear under the [API] tab. Click the desired API request to display the API list placeholder, then place it on the page.
Link API data (properties) to text or image boxes within the placeholder list from the Style panel.
For more details on property types and how to link properties to boxes, check out:
You can adjust text properties, like changing the date format or specifying the number of characters displayed.
Note:
Item Display Limit: The dynamic list can display up to 50 items.
“Load More” Button: The “Load More” button available in CMS dynamic lists can’t be used in API dynamic lists.