Made in Builder

Made in Builder

×

Developers

Product

Use Cases

Pricing

Developers

Resources

Company

Get StartedLogin

Product

Features

Integrations

Talk to an Expert

Pricing

Blog

Home

Resources

Blog

Forum

Github

Login

Signup

×

Visual CMS

Drag-and-drop visual editor and headless CMS for any tech stack

Theme Studio for Shopify

Build and optimize your Shopify-hosted storefront, no coding required

Resources

Blog

Get StartedLogin

Admin API

BETA

Usage

Admin API is a GraphQL API meant to be used by back-end servers or trusted parties performing administrative tasks. The goal of this API is to allow all what can be done through the Builder.io dashboard (and more) to be done through it.

This API is separate from the public Content API, which is meant to be used for consuming Builder content.

When you connect the Admin API to a specific space (by using its private key in the Authorization header) you can:

  • Query space settings.
  • Query model definitions.
  • Create / Read / Update / Delete models.
  • Configure SSO provider.
  • Clone your entire space.

Or you can connect it to an organization, in this case you can:

  • Create a new space under it.
  • Generate an embed token to allow embedding of a specific space within your organization.

It's available on:

Make sure to pass your private key in authorization header

Explorer

To query and mutate your space add your private key to the HTTP Headers section below. For detailed documentation on each of the queries and mutations press on DOCS

For Nodejs

See our Admin SDK package for more info about querying and mutating your space.

Was this article helpful?