Builder's Admin API is a GraphQL API meant to be used by back-end servers or trusted parties performing administrative tasks.
This API gives you a programmatic way to do anything — and more — that you can do through the Builder.io dashboard.
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
Authorization: 'Bearer bpk-xx'
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, click the DOCS tab on the right.
For Node.js, visit Builder's Admin SDK package for more info about querying and mutating your space.
Looking to hire a third party to help with your project?
Submit a project request and our partnerships team will reach out to connect you with an Expert from our partner ecosystem.