Documentation / API reference / Experiences Management API

Experiences Management API

Introduction

The Experiences Management API allows you to programmatically manage experiences, templates, component types, design tokens, fragments, and data assemblies within your Contentful spaces.

All endpoints are scoped to a specific space and environment.

Basic API information

API Base URL https://api.contentful.com

This is a read/write API

Authentication

To use the Experiences Management API, you need a Content Management API access token. Include it in the Authorization header:

Authorization: Bearer <cma_token>

Learn more about authentication.

Version locking

When updating or deleting a resource, include the current version in the X-Contentful-Version header to prevent conflicts.

Pagination

Collection endpoints use cursor-based pagination. Use the limit query parameter to control page size, and pageNext/pagePrev cursor tokens to navigate between pages.

Reference

Design tokens

Design tokens collection

List all design tokens

Design token

Get a design token by ID

Update a design token by ID

Delete a design token by ID

Component types

Component types collection

List all component types

Create a new component type

Component type

Get a component type by ID

Upsert a component type by ID

Delete a component type by ID

Component type published

Publish a component type

Unpublish a component type

Templates

Templates collection

List all templates

Create a new template

Template

Get a template by ID

Delete a template by ID

Update a template by ID

Template published

Publish a template

Unpublish a template

Experiences

Experiences collection

List all experiences

Create a new experience

Experience

Get an experience by ID

Upsert an experience by ID

Delete an experience by ID

Experiences - references

Get referenced entities for an experience

Experience published

Publish an experience

Unpublish an experience

Experience optimization variants

Experience optimization variants collection

Create a new experience optimization variant for an experience

List all experience optimization variants for an experience

Experience optimization variant

Update an existing experience optimization variant for an experience by ID

Delete an existing experience optimization variant for an experience by ID

Get an experience optimization variant by ID

Experience optimization variant published

Publish an experience optimization variant

Unpublish an experience optimization variant

Experience optimization variant archived

Archive an experience optimization variant

Unarchive an experience optimization variant

Fragments

Fragments collection

List all fragments

Create a new fragment

Fragment

Delete a fragment by ID

Update a fragment by ID

Get a fragment by ID

Fragment published

Publish a fragment

Unpublish a fragment

Fragment optimization variants

Fragment optimization variants collection

Create a new fragment optimization variant

List all fragment optimization variants for a fragment

Fragment optimization variant

Get a fragment optimization variant by ID

Update a fragment optimization variant by ID

Delete a fragment optimization variant by ID

Fragment optimization variant published

Publish a fragment optimization variant

Unpublish a fragment optimization variant

Fragment optimization variant archived

Archive a fragment optimization variant

Unarchive a fragment optimization variant

Release experiences

Release experiences collection

List all release-scoped experiences for a release

Create a release-scoped experience

Release experience

Get a release-scoped experience by ID

Update a release-scoped experience

Remove a release-scoped experience from a release

Release fragments

Release fragments collection

List all release-scoped fragments for a release

Create a release-scoped fragment

Release fragment

Get a release-scoped fragment by ID

Update a release-scoped fragment

Remove a release-scoped fragment from a release

Data types

Data types collection

Create a new data type

Data type

Get a data type by ID

Update a data type by ID

Delete a data type by ID

Data assemblies

Data assemblies collection

List draft data assemblies

Create a new data assembly

List published data assemblies

Data assembly

Get a data assembly by ID

Update a data assembly by ID

Delete a data assembly by ID

Get a published data assembly by ID

Data assembly published

Publish a data assembly by ID

Unpublish a previously published data assembly by ID