BUILDER

Features

Developers

Documentation

Pricing

Github

Docs

App

This page was made in Builder!

USER GUIDES

Creating Content

Learning the visual editor

Responsive design tricks

Saving layers as templates

Importing your site pages

Connecting custom data

Interactive pages with state and actions

Creating reusable components with Symbols

Targeting and scheduling content

Building custom forms

How To

Sidebar Menu

Dropdown Menu

Platforms

Shopify

Wordpress

Custom

DEVELOPER GUIDES

Github

Builder Content API

Usage

With the Content API, you can make requests to retrieve data about any of your models within Builder. The Content API supports advanced query filtering via url parameters to allow you to get exactly the data you need. The best way to get familiar with the API is to explore it using your personalized api explorer, which you can find by clicking the blue button below.

Try Out the Interactive API Explorer

Sample Request and Response

curl https://builder.io/api/v2/content/YOUR_MODEL_NAME?apiKey=YOUR_API_KEY

# Example response
# {
#   "results": [
#     {
#       "id": "c923kd89",
#       "name": "My first homepage",
#       "data: {
#         "customField": "customValue"
#          ...
#       }
#    ]
# }

Supported Query Params

Name	Required	Description
apiKey	Yes	Your API key
userAttributes.*	No	Optionally use this to send targeting attributes, e.g.: `&userAttributes.device=desktop &userAttributes.urlPath=/about &userAttributes.userLoggedIn=true`
query.*	No	Mongodb style query of your data. E.g.: `&query.data.id=abc123 &query.data.myCustomField=someValue &query.data.someNumber.$ne=20`
fields	No	Only include these fields. E.g. `&fields=id,name,data.customField`
omit	No	Omit only these fields, E.g.: `&omit=data.bigField,data.blocks`
limit	No	Max number of results to return. Default is 1
offset	No	Results offset (for pagination). Default is 0
includeRefs	No	Include content of references in response
cacheSeconds	No	Seconds to cache content (sets the max-age of the cache-control header response header). Make higher for better performance, and lower for content that will change more frequently `&cacheSeconds=1230`

Questions or comments?

Give us a chat, we respond quickly and are here to help!

Chat Us Now