Contentful

Use this endpoint to delete an AI Provider for a specified organization. via DELETE /organizations/{organization_id}/ai/providers/{provider_id}

Delete an app definition via DELETE /organizations/{organization_id}/app_definitions/{app_definition_id}

Delete One Access Grant via DELETE /organizations/{organization_id}/app_definitions/{app_definition_id}/access_grants/{access_grant_id}

Delete an action via DELETE /organizations/{organization_id}/app_definitions/{app_definition_id}/actions/{app_action_id}

Delete an app bundle via DELETE /organizations/{organization_id}/app_definitions/{app_definition_id}/app_bundles/{app_bundle_id}

Delete app details via DELETE /organizations/{organization_id}/app_definitions/{app_definition_id}/details

Delete an app event subscription via DELETE /organizations/{organization_id}/app_definitions/{app_definition_id}/event_subscription

Delete an app key via DELETE /organizations/{organization_id}/app_definitions/{app_definition_id}/keys/{key_kid}

Deletes the resource provider for an app. Cannot be deleted if it has associated resource types. via DELETE /organizations/{organization_id}/app_definitions/{app_definition_id}/resource_provider

Delete a resource type via DELETE /organizations/{organization_id}/app_definitions/{app_definition_id}/resource_provider/resource_types/{resource_type_id}

Remove the current app signing secret via DELETE /organizations/{organization_id}/app_definitions/{app_definition_id}/signing_secret

Deletes an environment template and all its versions. Entities previously installed from the template are not affected. via DELETE /organizations/{organization_id}/environment_templates/{template_id}

Deletes a logging configuration. This stops future log deliveries for the configuration. via DELETE /organizations/{organization_id}/logging_configurations/{configuration_id}

Delete an organization security contact an admin or owner has access to via DELETE /organizations/{organization_id}/security_contacts/{security_id}

Delete a search index via DELETE /organizations/{organization_id}/semantic/search-index/{index_id}

Delete a concept scheme via DELETE /organizations/{organization_id}/taxonomy/concept-schemes/{concept_scheme_id}

_Deleting concepts does not remove existing references to them in content type validations, or entries._ via DELETE /organizations/{organization_id}/taxonomy/concepts/{concept_id}

Deletes a space and all its resources — content types, entries, and assets. **This action cannot be undone.** via DELETE /spaces/{space_id}

Use this endpoint to delete an AI Action for a specified space. via DELETE /spaces/{space_id}/ai/actions/{ai_action_id}

This endpoint allows you to delete a Delivery API key and its corresponding Preview API key. via DELETE /spaces/{space_id}/api_keys/{api_key_id}

Deletes an environment alias. The `master` alias cannot be deleted. via DELETE /spaces/{space_id}/environment_aliases/{environment_alias_id}

Delete an environment via DELETE /spaces/{space_id}/environments/{environment_id}

Use this endpoint to unpublish an AI Action for a specified space. via DELETE /spaces/{space_id}/environments/{environment_id}/ai/actions/{ai_action_id}/published

Uninstall an app via DELETE /spaces/{space_id}/environments/{environment_id}/app_installations/{app_definition_id}

Deletes an asset and all previously referenced CDN files. CDN removal can take up to 48 hours. via DELETE /spaces/{space_id}/environments/{environment_id}/assets/{asset_id}

Unarchives an asset, restoring it to draft state. Files can take up to an hour to become available on the CDN again. via DELETE /spaces/{space_id}/environments/{environment_id}/assets/{asset_id}/archived

Unpublishing will put the asset back into draft state. via DELETE /spaces/{space_id}/environments/{environment_id}/assets/{asset_id}/published

Delete an automation definition via DELETE /spaces/{space_id}/environments/{environment_id}/automation_definitions/{automation_definition_id}

_Before you can delete a content type you need to deactivate it_. via DELETE /spaces/{space_id}/environments/{environment_id}/content_types/{content_type_id}

Deactivate a content type via DELETE /spaces/{space_id}/environments/{environment_id}/content_types/{content_type_id}/published

Delete an entry via DELETE /spaces/{space_id}/environments/{environment_id}/entries/{entry_id}

Unarchive an entry via DELETE /spaces/{space_id}/environments/{environment_id}/entries/{entry_id}/archived

Deletes an entry comment. Comment creators and space admins can delete comments. via DELETE /spaces/{space_id}/environments/{environment_id}/entries/{entry_id}/comments/{comment_id}

Unpublish an entry via DELETE /spaces/{space_id}/environments/{environment_id}/entries/{entry_id}/published

Deletes a task. Task creators and space admins can delete tasks. via DELETE /spaces/{space_id}/environments/{environment_id}/entries/{entry_id}/tasks/{task_id}

Delete an extension via DELETE /spaces/{space_id}/environments/{environment_id}/extensions/{extension_id}

Deletes a locale and all associated content. **This action cannot be undone.** Locales used as fallbacks by other locales cannot be deleted. via DELETE /spaces/{space_id}/environments/{environment_id}/locales/{locale_id}

Deletes a release by ID. Only the release creator or an admin can delete a release. via DELETE /spaces/{space_id}/environments/{environment_id}/releases/{release_id}

Unarchives a release, re-enabling publish, unpublish, and scheduling actions. Include `X-Contentful-Version`. Not supported for Timeline releases (`sys.schemaVersion` `Release.v2`), which return a 400 error. via DELETE /spaces/{space_id}/environments/{environment_id}/releases/{release_id}/archived

Unpublishes all entities in a release. via DELETE /spaces/{space_id}/environments/{environment_id}/releases/{release_id}/published

Deletes a tag from the entries and/or assets that reference it. via DELETE /spaces/{space_id}/environments/{environment_id}/tags/{tag_id}

Delete an upload via DELETE /spaces/{space_id}/environments/{environment_id}/uploads/{upload_id}

Deletes a workflow definition by ID. Only org or space admins can delete workflow definitions. via DELETE /spaces/{space_id}/environments/{environment_id}/workflow_definitions/{workflow_definition_id}

Cancels a workflow. Only org or space admins can cancel by default; step-level permissions can grant access to other users. via DELETE /spaces/{space_id}/environments/{environment_id}/workflows/{workflow_id}

Use this endpoint to delete an existing role. You can only delete roles if there is no user in the space with *only* that role assigned, i.e. a user must have at least one role. via DELETE /spaces/{space_id}/roles/{role_id}

Cancels a scheduled action. Only actions in `scheduled` status can be cancelled. via DELETE /spaces/{space_id}/scheduled_actions/{scheduled_action_id}

Deletes a space membership, revoking the user's space access without deleting their account. All admins can be removed, leaving the space unmanageable until a new admin is added. via DELETE /spaces/{space_id}/space_memberships/{space_membership_id}

Delete a webhook via DELETE /spaces/{space_id}/webhook_definitions/{webhook_definition_id}

Delete a webhook signing secret via DELETE /spaces/{space_id}/webhook_settings/signing_secret

This endpoint deletes a specific OAuth application. via DELETE /users/{user_id}/oauth_applications/{oauth_application_id}

Get all installations of an app within an organization via GET /app_definitions/{app_definition_id}/app_installations

Get all organizations an account has access to via GET /organizations

Get an organization id an admin or owner has access to via GET /organizations/{organization_id}

This endpoint allows you to verify whether the token has access permissions for this organization. via GET /organizations/{organization_id}/access_grant

Returns redacted CMA tokens for all members of the organization; accessible to admins and owners only. Supports the same date-range filters as the personal access tokens endpoint. via GET /organizations/{organization_id}/access_tokens

Returns all the AI Providers that exist in a given organization. via GET /organizations/{organization_id}/ai/providers

Use this endpoint to read an AI Provider for a specified organization. via GET /organizations/{organization_id}/ai/providers/{provider_id}

Get app action categories via GET /organizations/{organization_id}/app_actions_categories

Get all app definitions via GET /organizations/{organization_id}/app_definitions

Get an app definition via GET /organizations/{organization_id}/app_definitions/{app_definition_id}

Query Access Grants of a App Definition via GET /organizations/{organization_id}/app_definitions/{app_definition_id}/access_grants

Get all actions of an app via GET /organizations/{organization_id}/app_definitions/{app_definition_id}/actions

Read an action via GET /organizations/{organization_id}/app_definitions/{app_definition_id}/actions/{app_action_id}

Get all app bundles via GET /organizations/{organization_id}/app_definitions/{app_definition_id}/app_bundles

Get an app bundle via GET /organizations/{organization_id}/app_definitions/{app_definition_id}/app_bundles/{app_bundle_id}

Get app details via GET /organizations/{organization_id}/app_definitions/{app_definition_id}/details

Get an app event subscription via GET /organizations/{organization_id}/app_definitions/{app_definition_id}/event_subscription

Get all functions via GET /organizations/{organization_id}/app_definitions/{app_definition_id}/functions

Get a function via GET /organizations/{organization_id}/app_definitions/{app_definition_id}/functions/{function_id}

Get all app keys via GET /organizations/{organization_id}/app_definitions/{app_definition_id}/keys

Get an app key via GET /organizations/{organization_id}/app_definitions/{app_definition_id}/keys/{key_kid}

Get a resource provider via GET /organizations/{organization_id}/app_definitions/{app_definition_id}/resource_provider

Get all resource types via GET /organizations/{organization_id}/app_definitions/{app_definition_id}/resource_provider/resource_types

Get a resource type via GET /organizations/{organization_id}/app_definitions/{app_definition_id}/resource_provider/resource_types/{resource_type_id}

Get the current app signing secret via GET /organizations/{organization_id}/app_definitions/{app_definition_id}/signing_secret

Get an app upload via GET /organizations/{organization_id}/app_uploads/{app_upload_id}

Use this endpoint to list all the available licenses for an organization, the response is the counted and grouped licenses (by `product Id`). via GET /organizations/{organization_id}/available_licenses

Returns the enablement status of all features in an organization. A default document (all features `false`) is created if none exists yet. via GET /organizations/{organization_id}/enablements

This action returns a collection with all the environment templates in the organization repository. The templates are ordered by creation date descending. via GET /organizations/{organization_id}/environment_templates

This action returns a specific environment template in the organization repository. The returned template is also the latest version in the **/versions** endpoint. via GET /organizations/{organization_id}/environment_templates/{template_id}

This action returns a collection with all installations of an environment template in the organization. via GET /organizations/{organization_id}/environment_templates/{template_id}/template_installations

This action returns all the versions of an environment template. The versions are ordered by version number descending. via GET /organizations/{organization_id}/environment_templates/{template_id}/versions

This action returns a certain version of an environment template. via GET /organizations/{organization_id}/environment_templates/{template_id}/versions/{version_number}

Returns a paginated collection of logging configurations for the organization. via GET /organizations/{organization_id}/logging_configurations

Returns a single logging configuration by ID. via GET /organizations/{organization_id}/logging_configurations/{configuration_id}

Returns cursor-paginated delivery attempt history for a configuration. Records are retained for 180 days. via GET /organizations/{organization_id}/logging_configurations/{configuration_id}/status

**Deprecated. Sunset: 2027-02-28.** Use [Get aggregated usage](/references/content-management-api/usage/get-usage-aggregated) instead. See the [Usage migration guide](/references/content-management-api/usage-migration-guide) for a full mapping of parameters and response shapes.Query organization usage by `metric` for a given date range. If `startAt` and `endAt` are not passed through the query a historical data for the last 45 days will be returned by default. via GET /organizations/{organization_id}/organization_periodic_usages

Get an organization security contacts an admin or owner has access to via GET /organizations/{organization_id}/security_contacts

Get all search indices via GET /organizations/{organization_id}/semantic/search-index

Get a search index via GET /organizations/{organization_id}/semantic/search-index/{index_id}

Get semantic settings via GET /organizations/{organization_id}/semantic/settings

Get space add-ons from a specific organization. via GET /organizations/{organization_id}/space_add_ons

Returns enablement status for all features across all spaces in the organization. A default document (all features `false`) is created for any space that lacks one. via GET /organizations/{organization_id}/space_enablements

**Deprecated. Sunset: 2027-02-28.** Use [Get aggregated usage](/references/content-management-api/usage/get-usage-aggregated) with `filter[sys.dimensions.space.sys.id]={spaceId}` instead. See the [Usage migration guide](/references/content-management-api/usage-migration-guide) for a full mapping of parameters and response shapes.Query organization usage by space and `metric` for a given date range. via GET /organizations/{organization_id}/space_periodic_usages

Get concept schemes via GET /organizations/{organization_id}/taxonomy/concept-schemes

Get a concept scheme via GET /organizations/{organization_id}/taxonomy/concept-schemes/{concept_scheme_id}

Returns all taxonomy concepts for an organization, with cursor-based pagination. Filter by `sys.id[in]`, `conceptScheme`, `order`, `limit`, `query`, `pageNext`, and `pagePrev` query parameters. via GET /organizations/{organization_id}/taxonomy/concepts

Get a concept via GET /organizations/{organization_id}/taxonomy/concepts/{concept_id}

Get ancestors of a concept via GET /organizations/{organization_id}/taxonomy/concepts/{concept_id}/ancestors

Get descendants of a concept via GET /organizations/{organization_id}/taxonomy/concepts/{concept_id}/descendants

Get number of concept schemes via GET /organizations/{organization_id}/taxonomy/concepts-schemes/total

Get number of concepts via GET /organizations/{organization_id}/taxonomy/concepts/total

Returns aggregated usage for a single metric over a configurable date range and granularity. This is the recommended endpoint for consuming Usage API data — it replaces the legacy `organization_periodic_usages` and `space_periodic_usages` endpoints (see the [Usage migration guide](/references/content-management-api/usage-migration-guide)). via GET /organizations/{organization_id}/usages/{metric_key}

Returns the top 30 assets by bandwidth used for an organization over a given date range, ranked descending and grouped by asset and space. This is a fixed-shape leaderboard, not a general-purpose query endpoint — unlike [Get aggregated usage](/references/content-management-api/usage/get-usage-aggregated), it does not support `group`, `filter`, or `order` parameters, and covers a single metric (`asset_bandwidth`) only. via GET /organizations/{organization_id}/usages-detailed/asset_bandwidth

Get all spaces an account has access to via GET /spaces

Get a space via GET /spaces/{space_id}

Returns all the AI Actions that exist in a given space. via GET /spaces/{space_id}/ai/actions

Use this endpoint to read an AI Action for a specified space. via GET /spaces/{space_id}/ai/actions/{ai_action_id}

Get all Delivery API keys via GET /spaces/{space_id}/api_keys

This endpoint returns details about an existing Delivery API key. via GET /spaces/{space_id}/api_keys/{api_key_id}

Use this endpoint to list all eligible licenses for a given space under an organization. This will check if the space usage would fit into the licenses limits, and also check if entitlements bank can cover if shortage exists. via GET /spaces/{space_id}/eligible_licenses

Returns the enablement status of all features in a space. A default document (all features `false`) is created if none exists yet. via GET /spaces/{space_id}/enablements

Get all environment aliases of a space via GET /spaces/{space_id}/environment_aliases

Get an environment alias via GET /spaces/{space_id}/environment_aliases/{environment_alias_id}

Get all environments of a space via GET /spaces/{space_id}/environments

Get an environment via GET /spaces/{space_id}/environments/{environment_id}

Use this endpoint to obtain the result of an AI Action Invocation for a specified space, environment, AI Action and Invocation. via GET /spaces/{space_id}/environments/{environment_id}/ai/actions/{ai_action_id}/invocations/{ai_action_invocation_id}

Get all app installations via GET /spaces/{space_id}/environments/{environment_id}/app_installations

Get an app installation via GET /spaces/{space_id}/environments/{environment_id}/app_installations/{app_definition_id}

Get a call via GET /spaces/{space_id}/environments/{environment_id}/app_installations/{app_installation_id}/actions/{app_action_id}/calls/{call_id}

Get raw response via GET /spaces/{space_id}/environments/{environment_id}/app_installations/{app_installation_id}/actions/{app_action_id}/calls/{call_id}/response

Get all functions for an environment via GET /spaces/{space_id}/environments/{environment_id}/app_installations/{app_installation_id}/functions

Get all function logs via GET /spaces/{space_id}/environments/{environment_id}/app_installations/{app_installation_id}/functions/{function_id}/logs

Get a function log via GET /spaces/{space_id}/environments/{environment_id}/app_installations/{app_installation_id}/functions/{function_id}/logs/{log_id}

To fetch specific assets use [query search parameter](#/reference/search-parameters). via GET /spaces/{space_id}/environments/{environment_id}/assets

Get an asset via GET /spaces/{space_id}/environments/{environment_id}/assets/{asset_id}

Get all automation definitions via GET /spaces/{space_id}/environments/{environment_id}/automation_definitions

Get automation definition via GET /spaces/{space_id}/environments/{environment_id}/automation_definitions/{automation_definition_id}

Get executions for automation definition via GET /spaces/{space_id}/environments/{environment_id}/automation_definitions/{automation_definition_id}/automation_executions

Get all automation executions via GET /spaces/{space_id}/environments/{environment_id}/automation_executions

Get automation execution via GET /spaces/{space_id}/environments/{environment_id}/automation_executions/{automation_execution_id}

Returns a bulk action by ID. Records are retained for 7 days. via GET /spaces/{space_id}/environments/{environment_id}/bulk_actions/actions/{bulk_action_id}

Retrieves bulk operations for the specified space and environment (cursor-paginated). Each item in `items` includes `sys` only (no `payload`, `result`, or `error`). via GET /spaces/{space_id}/environments/{environment_id}/bulk_operations

Returns the status of a bulk operation by ID. Check `sys.status` for state and `result.items` for per-entry outcomes; export jobs return `result.files` with signed ZIP URLs. via GET /spaces/{space_id}/environments/{environment_id}/bulk_operations/{bulk_operation_id}

Get all content types of a space via GET /spaces/{space_id}/environments/{environment_id}/content_types

Get a content type via GET /spaces/{space_id}/environments/{environment_id}/content_types/{content_type_id}

Get the editor interface via GET /spaces/{space_id}/environments/{environment_id}/content_types/{content_type_id}/editor_interface

Get all snapshots of a content type via GET /spaces/{space_id}/environments/{environment_id}/content_types/{content_type_id}/snapshots

Get a snapshot of a content type via GET /spaces/{space_id}/environments/{environment_id}/content_types/{content_type_id}/snapshots/{snapshot_id}

Get all editor interfaces of a space via GET /spaces/{space_id}/environments/{environment_id}/editor_interfaces

To fetch specific entries like e.g. entries of a particular content type use [query search parameters](#/reference/search-parameters). via GET /spaces/{space_id}/environments/{environment_id}/entries

Returns an entry by ID. Empty fields are omitted from the response; include all keys that need to be updated when writing back. via GET /spaces/{space_id}/environments/{environment_id}/entries/{entry_id}

Returns all comments on an entry (unpaginated). Filter by `status` query parameter; any user with read access can read comments. via GET /spaces/{space_id}/environments/{environment_id}/entries/{entry_id}/comments

Returns an entry comment by ID. Any user with read access to the entry can read its comments; space admins can read comments in any entry. via GET /spaces/{space_id}/environments/{environment_id}/entries/{entry_id}/comments/{comment_id}

Get entry references via GET /spaces/{space_id}/environments/{environment_id}/entries/{entry_id}/references

Get all snapshots of an entry via GET /spaces/{space_id}/environments/{environment_id}/entries/{entry_id}/snapshots

Get a snapshot of an entry via GET /spaces/{space_id}/environments/{environment_id}/entries/{entry_id}/snapshots/{snapshot_id}

Returns a paginated list of tasks for an entry. Any user with read access to the entry can read its tasks; space admins can read tasks in any entry. via GET /spaces/{space_id}/environments/{environment_id}/entries/{entry_id}/tasks

Returns an entry task by ID. Any user with read access to the entry can read its tasks; space admins can read tasks in any entry. via GET /spaces/{space_id}/environments/{environment_id}/entries/{entry_id}/tasks/{task_id}

Get all extensions of a space via GET /spaces/{space_id}/environments/{environment_id}/extensions

Get an extension via GET /spaces/{space_id}/environments/{environment_id}/extensions/{extension_id}

The locales endpoint returns a list of all created locales. One will have the flag `default` set to true and is the locale used in the CDA, and you specified no other locale in the request. via GET /spaces/{space_id}/environments/{environment_id}/locales

This endpoint returns a single locale and its metadata. via GET /spaces/{space_id}/environments/{environment_id}/locales/{locale_id}

Retrieves the published versions of all assets in a space. via GET /spaces/{space_id}/environments/{environment_id}/public/assets

Retrieves the activated versions of content types, ignoring any changes made since the last activation. via GET /spaces/{space_id}/environments/{environment_id}/public/content_types

Get all published entries of a space via GET /spaces/{space_id}/environments/{environment_id}/public/entries

Returns release actions across one or more releases. Filter by action type (`validate`, `publish`, `unpublish`), status, and release ID. via GET /spaces/{space_id}/environments/{environment_id}/release_actions

Returns releases for the environment, cursor-paginated. Filter by ID, creator, status, entity membership, and `title[match]`. via GET /spaces/{space_id}/environments/{environment_id}/releases

Returns a single release by ID. via GET /spaces/{space_id}/environments/{environment_id}/releases/{release_id}

Returns a single release action by ID. Accessible to any user with read access to entries; returns 404 if the release or action is not found. via GET /spaces/{space_id}/environments/{environment_id}/releases/{release_id}/actions/{release_action_id}

To fetch specific assets use [query search parameters](#/reference/search-parameters). via GET /spaces/{space_id}/environments/{environment_id}/releases/{release_id}/assets

Get an asset in a release via GET /spaces/{space_id}/environments/{environment_id}/releases/{release_id}/assets/{asset_id}

To fetch specific entries like e.g. entries of a particular content type use [query search parameters](#/reference/search-parameters). via GET /spaces/{space_id}/environments/{environment_id}/releases/{release_id}/entries

Returns a release entry by ID. Empty fields are omitted from the response; include them explicitly when updating to set empty values. via GET /spaces/{space_id}/environments/{environment_id}/releases/{release_id}/entries/{entry_id}

Get all resource types in an environment via GET /spaces/{space_id}/environments/{environment_id}/resource_types

Get all resources in an environment via GET /spaces/{space_id}/environments/{environment_id}/resource_types/{resource_type_id}/resources

Get all environment search indices via GET /spaces/{space_id}/environments/{environment_id}/semantic/search-index

Returns all the tags that exist in a given environment. via GET /spaces/{space_id}/environments/{environment_id}/tags

Returns a single tag based on the given identifier. via GET /spaces/{space_id}/environments/{environment_id}/tags/{tag_id}

Returns paginated tasks assigned to you. Requires `filter=myPendingTasks` query parameter. via GET /spaces/{space_id}/environments/{environment_id}/tasks

Returns all installation objects for a template in the environment, ordered by creation date descending. Each install or update attempt creates a new installation object. via GET /spaces/{space_id}/environments/{environment_id}/template_installations/{template_id}

This endpoint returns the available UI Config in the current environment. via GET /spaces/{space_id}/environments/{environment_id}/ui_config

Get the User UI Config via GET /spaces/{space_id}/environments/{environment_id}/ui_config/me

Retrieve an upload via GET /spaces/{space_id}/environments/{environment_id}/uploads/{upload_id}

Returns a paginated list of workflow definitions for the environment. Accessible to all users. via GET /spaces/{space_id}/environments/{environment_id}/workflow_definitions

Returns a single workflow definition by ID. Accessible to all users. via GET /spaces/{space_id}/environments/{environment_id}/workflow_definitions/{workflow_definition_id}

Returns workflows matching the specified query filters. Accessible to all users. via GET /spaces/{space_id}/environments/{environment_id}/workflows

Returns a workflow by ID. Accessible to all users. via GET /spaces/{space_id}/environments/{environment_id}/workflows/{workflow_id}

Returns all comments for a workflow. Filter by `status` query parameter; accessible to any user with read access to workflows. via GET /spaces/{space_id}/environments/{environment_id}/workflows/{workflow_id}/comments

Returns all comments for a specific workflow version. Accessible to any user with read access to workflows. via GET /spaces/{space_id}/environments/{environment_id}/workflows/{workflow_id}/versions/{version}/comments

Returns workflow changelog records matching the specified filters, sorted by event date descending. Accessible to any user with read access to the specified entry. via GET /spaces/{space_id}/environments/{environment_id}/workflows_changelog

Get all actions of an environment via GET /spaces/{space_id}/environments/{external_environment_id}/actions

Get all Preview API keys via GET /spaces/{space_id}/preview_api_keys

This endpoint returns details about an existing Preview API key. via GET /spaces/{space_id}/preview_api_keys/{preview_api_key_id}

This endpoint returns a paginated list of roles for a given space. Each role contains a name, a description, permissions and policies, which describe what a user can and cannot do. via GET /spaces/{space_id}/roles

Use this endpoint to read an existing single role. via GET /spaces/{space_id}/roles/{role_id}

Returns scheduled actions for the space, cursor-paginated (default page 100, max 1000). Filter by `environment.sys.id` (required), `entity.sys.id`, `sys.status`, and `scheduledFor.datetime`. via GET /spaces/{space_id}/scheduled_actions

Returns a single scheduled action by ID. via GET /spaces/{space_id}/scheduled_actions/{scheduled_action_id}

Get space add-ons from a specific space. via GET /spaces/{space_id}/space_add_ons

This endpoint returns a paginated list of all space memberships. via GET /spaces/{space_id}/space_memberships

This endpoint returns details about an existing space membership. via GET /spaces/{space_id}/space_memberships/{space_membership_id}

This endpoint returns a paginated list of all teams with access to a space. via GET /spaces/{space_id}/teams

Get all webhooks of a space via GET /spaces/{space_id}/webhook_definitions

Get a webhook via GET /spaces/{space_id}/webhook_definitions/{webhook_definition_id}

Get a webhook signing secret via GET /spaces/{space_id}/webhook_settings/signing_secret

Get an overview of recent calls via GET /spaces/{space_id}/webhooks/{webhook_id}/calls

Get the webhook call details via GET /spaces/{space_id}/webhooks/{webhook_id}/calls/{call_id}

Get webhook health via GET /spaces/{space_id}/webhooks/{webhook_id}/health

This endpoint retrieves a list of OAuth applications associated with the current user. via GET /users/{user_id}/oauth_applications

This endpoint retrieves details of a specific OAuth application. via GET /users/{user_id}/oauth_applications/{oauth_application_id}

This endpoint returns details about your Contentful user account. via GET /users/me

Returns all CMA tokens (active and revoked) for the current user, across `PersonalAccessToken`, `CLIToken`, and `OAuthApplication` types. Filter by `sys.type`, `sys.expiresAt`, `sys.revokedAt`, `sys.createdAt`, `sys.lastUsedAt`, and `query`. via GET /users/me/access_tokens

This endpoint returns details about an existing CMA token. via GET /users/me/access_tokens/{token_id}

Use this endpoint to update a specific AI provider using [JSON Patch](http://jsonpatch.com/) format. This is useful for updating credentials, configuration, or selected models without replacing the entire provider configuration. via PATCH /organizations/{organization_id}/ai/providers/{provider_id}

Updates a taxonomy concept scheme using JSON Patch format. Include the current version in `X-Contentful-Version`; operations on unset fields require passing the full sub-object rather than a nested path. via PATCH /organizations/{organization_id}/taxonomy/concept-schemes/{concept_scheme_id}

Updates a taxonomy concept using JSON Patch format. Include the current version in `X-Contentful-Version`; operations on unset fields require passing the full sub-object rather than a nested path. via PATCH /organizations/{organization_id}/taxonomy/concepts/{concept_id}

Updates an entry using JSON Patch format. Include the current version in `X-Contentful-Version`; operations on unset fields require passing the full sub-object. via PATCH /spaces/{space_id}/environments/{environment_id}/entries/{entry_id}

Updates a release entry using JSON Patch format. Include the current version in `X-Contentful-Version`; operations on unset fields require passing the full sub-object. via PATCH /spaces/{space_id}/environments/{environment_id}/releases/{release_id}/entries/{entry_id}

Use this endpoint to create a new AI Provider of a specified type for an organization. via POST /organizations/{organization_id}/ai/providers

Create a new app definition via POST /organizations/{organization_id}/app_definitions

Create One Access Grant via POST /organizations/{organization_id}/app_definitions/{app_definition_id}/access_grants

Create an action via POST /organizations/{organization_id}/app_definitions/{app_definition_id}/actions

Create a new app bundle via POST /organizations/{organization_id}/app_definitions/{app_definition_id}/app_bundles

Create a new app key via POST /organizations/{organization_id}/app_definitions/{app_definition_id}/keys

Create an app upload via POST /organizations/{organization_id}/app_uploads

This action creates an environment template in the organization repository. It implicitly creates a new version for this template. via POST /organizations/{organization_id}/environment_templates

Creates a logging configuration for the organization. AWS S3 destinations require `bucketName`, `iamArn`, and `region` credentials. via POST /organizations/{organization_id}/logging_configurations

Post an organization security contacts an admin or owner has access to via POST /organizations/{organization_id}/security_contacts

Create a search index via POST /organizations/{organization_id}/semantic/search-index

Create a concept scheme via POST /organizations/{organization_id}/taxonomy/concept-schemes

Create a single taxonomy concept. via POST /organizations/{organization_id}/taxonomy/concepts

Create a new space, specifying attributes in the request body. You can optionally pass a `productId` to assign a specific product (from your organization's available licenses) to the new space. via POST /spaces

Use this endpoint to create a new AI Action for a specified space. via POST /spaces/{space_id}/ai/actions

This endpoint allows you to create a Delivery API key and its corresponding Preview API key. via POST /spaces/{space_id}/api_keys

Creates a new environment, optionally cloned from a source environment via `X-Contentful-Source-Environment`. Use a specified ID for automation — auto-generated IDs are not recommended. via POST /spaces/{space_id}/environments

Use this endpoint to invoke an AI Action for a specified space and environment. via POST /spaces/{space_id}/environments/{environment_id}/ai/actions/{ai_action_id}/invoke

Issue a token for an app installation in a space environment via POST /spaces/{space_id}/environments/{environment_id}/app_installations/{app_definition_id}/access_tokens

Create a signed request via POST /spaces/{space_id}/environments/{environment_id}/app_installations/{app_definition_id}/signed_requests

Trigger an action via POST /spaces/{space_id}/environments/{environment_id}/app_installations/{app_installation_id}/actions/{app_action_id}/calls

Creates an asset key used to sign embargoed asset URLs for secure delivery. Specify an `expiresAt` Unix timestamp (maximum 48 hours ahead) to control key validity. via POST /spaces/{space_id}/environments/{environment_id}/asset_keys

When using this endpoint, an ID will be automatically generated for the created asset and returned with the response. via POST /spaces/{space_id}/environments/{environment_id}/assets

Create an automation definition via POST /spaces/{space_id}/environments/{environment_id}/automation_definitions

Create a locale-based bulk action via POST /spaces/{space_id}/environments/{environment_id}/bulk_actions

Publishes all content linked in the payload. Requires publish permissions on each item; limited by the number of active bulk actions. via POST /spaces/{space_id}/environments/{environment_id}/bulk_actions/publish

Unpublishes all content linked in the payload. Requires unpublish permissions on each item; limited by the number of active bulk actions. via POST /spaces/{space_id}/environments/{environment_id}/bulk_actions/unpublish

Validates entities before publishing. Requires publish permissions on each entity; limited by the number of active bulk actions. via POST /spaces/{space_id}/environments/{environment_id}/bulk_actions/validate

Creates a bulk operation from a previous upload, processing entries asynchronously. Omit `sys.id` for auto-generated IDs; existing IDs will fail with `EntryExistsError`. via POST /spaces/{space_id}/environments/{environment_id}/bulk_operations/entries/create

Creates an async export operation for entries matching an optional `query` (max 10,000 entries). Poll the bulk operation endpoint until `sys.status` is `completed`, then download from `result.files`. via POST /spaces/{space_id}/environments/{environment_id}/bulk_operations/entries/export

Creates a content type with an auto-generated ID. Prefer the PUT method to control the content type ID, since IDs are often referenced in code. via POST /spaces/{space_id}/environments/{environment_id}/content_types

Creates a new entry with an auto-generated ID; pass the desired content type in `X-Contentful-Content-Type`. New entries are created as drafts and must be published to appear on the CDA. via POST /spaces/{space_id}/environments/{environment_id}/entries

Creates a comment on an entry with an auto-generated ID; limit is 100 comments per entry. Use `X-Contentful-Parent-Id` to reply to a specific comment. via POST /spaces/{space_id}/environments/{environment_id}/entries/{entry_id}/comments

Creates a task on an entry with an auto-generated ID; limit is 100 tasks per entry. Email notifications are sent to the assignee (and team members if assigned to a team). via POST /spaces/{space_id}/environments/{environment_id}/entries/{entry_id}/tasks

Create an extension via POST /spaces/{space_id}/environments/{environment_id}/extensions

Use this endpoint to create a new locale for the specified space. You cannot create two locales with the same locale code. via POST /spaces/{space_id}/environments/{environment_id}/locales

Creates a new release with an auto-generated ID. via POST /spaces/{space_id}/environments/{environment_id}/releases

Creates a new asset and adds it to the release in one step. An ID is auto-generated and returned with the response. via POST /spaces/{space_id}/environments/{environment_id}/releases/{release_id}/assets

Use this endpoint to create a new entry and add it to the release in one step. via POST /spaces/{space_id}/environments/{environment_id}/releases/{release_id}/entries

Asynchronously validates a release for publishing or unpublishing. Only one validation at a time is allowed per release. via POST /spaces/{space_id}/environments/{environment_id}/releases/{release_id}/validate

This endpoint detects potential duplicate entries based on semantic similarity. via POST /spaces/{space_id}/environments/{environment_id}/semantic/duplicates

This endpoint allows to semantically find similar entries based on the provided entry IDs. via POST /spaces/{space_id}/environments/{environment_id}/semantic/recommendations

This endpoint returns suggested entries that you can reference in a given field based on semantic relevance. via POST /spaces/{space_id}/environments/{environment_id}/semantic/reference-suggestions

This endpoint allows to perform a semantic search for a given query. via POST /spaces/{space_id}/environments/{environment_id}/semantic/search

Installs a template version in the environment, creating a new installation object on success. Defaults to the latest version if no version is specified. via POST /spaces/{space_id}/environments/{environment_id}/template_installations/{template_id}/versions

Creates a new workflow definition. Only org or space admins can create workflow definitions. via POST /spaces/{space_id}/environments/{environment_id}/workflow_definitions

Creates a workflow for an entry. Any user with read access to the entry can create a workflow. via POST /spaces/{space_id}/environments/{environment_id}/workflows

Creates a comment for a specific workflow version; only one comment per version is supported. Accessible to any user with read access to workflows. via POST /spaces/{space_id}/environments/{environment_id}/workflows/{workflow_id}/versions/{version}/comments

Use this endpoint to create a custom role. The role name must be unique within the space. via POST /spaces/{space_id}/roles

Creates a scheduled action with an auto-generated ID. Limit is 200 pending scheduled actions per environment; `scheduledFor.datetime` must be a future ISO 8601 timestamp. via POST /spaces/{space_id}/scheduled_actions

Use this endpoint to create a space membership (or invite a user to a space). A user can and must be flagged as 'admin' or assigned to certain roles. via POST /spaces/{space_id}/space_memberships

Unarchive a space to make it active again. Pass a `productId` in the request body to assign a product license to the space upon unarchiving. via POST /spaces/{space_id}/unarchive

Create a webhook via POST /spaces/{space_id}/webhook_definitions

This endpoint creates a new OAuth application. via POST /users/{user_id}/oauth_applications

Creates a Personal Access Token with the specified scopes (`content_management_read` or `content_management_manage`). The token value is only returned once — copy and store it securely. via POST /users/me/access_tokens

Put an organization id an admin or owner has access to via PUT /organizations/{organization_id}

Update an app definition via PUT /organizations/{organization_id}/app_definitions/{app_definition_id}

Update an action via PUT /organizations/{organization_id}/app_definitions/{app_definition_id}/actions/{app_action_id}

Create or update app details via PUT /organizations/{organization_id}/app_definitions/{app_definition_id}/details

Update or subscribe to events via PUT /organizations/{organization_id}/app_definitions/{app_definition_id}/event_subscription

Creates a resource provider for an app; each app can have only one. The `function.sys.id` in the request must match `functions[0].id` in the app's manifest. via PUT /organizations/{organization_id}/app_definitions/{app_definition_id}/resource_provider

Creates or updates a resource type for an app's resource provider. Requires the app to have an associated resource provider — PUT fails without one. via PUT /organizations/{organization_id}/app_definitions/{app_definition_id}/resource_provider/resource_types/{resource_type_id}

Create or overwrite the app signing secret via PUT /organizations/{organization_id}/app_definitions/{app_definition_id}/signing_secret

Enables or changes features for an organization. Include `X-Contentful-Version` (use `1` if no document exists yet). via PUT /organizations/{organization_id}/enablements

Updates an environment template and implicitly creates a new version. Include `X-Contentful-Version` to lock against concurrent edits. via PUT /organizations/{organization_id}/environment_templates/{template_id}

Replaces credentials for an existing logging configuration. The destination type cannot be changed via this endpoint. via PUT /organizations/{organization_id}/logging_configurations/{configuration_id}/credentials

Update an organization security contact an admin or owner has access to via PUT /organizations/{organization_id}/security_contacts/{security_id}

Create a concept scheme with user-defined ID via PUT /organizations/{organization_id}/taxonomy/concept-schemes/{concept_scheme_id}

Creates a single taxonomy concept with a user-defined ID. via PUT /organizations/{organization_id}/taxonomy/concepts/{concept_id}

Updates a space; send attributes as a JSON payload and include `X-Contentful-Version`. `X-Contentful-Organization` is optional if the account belongs to only one organization. via PUT /spaces/{space_id}

Use this endpoint to update an AI Action for a specified space. via PUT /spaces/{space_id}/ai/actions/{ai_action_id}

Updates a Delivery API key and its corresponding Preview API key. Include the current version in `X-Contentful-Version`. via PUT /spaces/{space_id}/api_keys/{api_key_id}

Enables or changes features for a space. Include `X-Contentful-Version` (use `1` if no document exists); `spaceTemplates` and `crossSpaceLinks` must always be set together. via PUT /spaces/{space_id}/enablements

Creates a new environment alias or changes the environment it references. When updating, include the current alias version in `X-Contentful-Version`. via PUT /spaces/{space_id}/environment_aliases/{environment_alias_id}

Creates a new environment with the specified ID, or clones from a source environment via `X-Contentful-Source-Environment`. When updating an existing environment, include the current version in `X-Contentful-Version`. via PUT /spaces/{space_id}/environments/{environment_id}

Use this endpoint to publish an AI Action for a specified space. via PUT /spaces/{space_id}/environments/{environment_id}/ai/actions/{ai_action_id}/published

Install or update an app via PUT /spaces/{space_id}/environments/{environment_id}/app_installations/{app_definition_id}

Creates a new asset with the specified ID or updates an existing one. When updating, include the current version in `X-Contentful-Version`. via PUT /spaces/{space_id}/environments/{environment_id}/assets/{asset_id}

Archives an asset, removing it and its CDN files. CDN removal can take up to 48 hours. via PUT /spaces/{space_id}/environments/{environment_id}/assets/{asset_id}/archived

Process an asset via PUT /spaces/{space_id}/environments/{environment_id}/assets/{asset_id}/files/{locale_code}/process

Publishes an asset, making it available on the CDA and CDN. Image assets become accessible from `images.ctfassets.net` with Images API query parameter support. via PUT /spaces/{space_id}/environments/{environment_id}/assets/{asset_id}/published

Update an automation definition via PUT /spaces/{space_id}/environments/{environment_id}/automation_definitions/{automation_definition_id}

Creates a new content type with the specified ID or updates an existing one. When updating, include the current version in `X-Contentful-Version`. via PUT /spaces/{space_id}/environments/{environment_id}/content_types/{content_type_id}

You can use this endpoint to update an existing editor interface. You will need to specify its last version with `X-Contentful-Version`. via PUT /spaces/{space_id}/environments/{environment_id}/content_types/{content_type_id}/editor_interface

Activate a content type via PUT /spaces/{space_id}/environments/{environment_id}/content_types/{content_type_id}/published

Creates a new entry with the specified ID or updates an existing one. Pass `X-Contentful-Content-Type` when creating; include `X-Contentful-Version` when updating. via PUT /spaces/{space_id}/environments/{environment_id}/entries/{entry_id}

Archive an entry via PUT /spaces/{space_id}/environments/{environment_id}/entries/{entry_id}/archived

Updates the body of an entry comment. Only the comment creator or a space admin can update a comment. via PUT /spaces/{space_id}/environments/{environment_id}/entries/{entry_id}/comments/{comment_id}

Publish an entry via PUT /spaces/{space_id}/environments/{environment_id}/entries/{entry_id}/published

Updates a task's body, assignee, or status. Task assignees can only update `status`; task creators and admins can update `body` and `assignedTo`. Resolved tasks cannot have `body` or `assignee` changed without unresolving first. via PUT /spaces/{space_id}/environments/{environment_id}/entries/{entry_id}/tasks/{task_id}

Use this endpoint to create a new extension with a specified ID, or to update a specific extension via its ID. When updating an existing extension, you need to specify the last version of the extension you are updating with `X-Contentful-Version`. via PUT /spaces/{space_id}/environments/{environment_id}/extensions/{extension_id}

Updates a locale in a space; include the current version in `X-Contentful-Version`. Changing a locale's `code` affects all future API responses and is not allowed on locales used as fallbacks. via PUT /spaces/{space_id}/environments/{environment_id}/locales/{locale_id}

Updates a release by ID. Include `X-Contentful-Version`. via PUT /spaces/{space_id}/environments/{environment_id}/releases/{release_id}

Archives a release, preventing publish, unpublish, or scheduling actions. Include `X-Contentful-Version`. via PUT /spaces/{space_id}/environments/{environment_id}/releases/{release_id}/archived

Creates a new asset with the specified ID or updates an existing one within the release. Include the current version in `X-Contentful-Version` when updating. via PUT /spaces/{space_id}/environments/{environment_id}/releases/{release_id}/assets/{asset_id}

Process an asset in a release via PUT /spaces/{space_id}/environments/{environment_id}/releases/{release_id}/assets/{asset_id}/files/{locale_code}/process

Updates a release entry by ID. Include the current version in `X-Contentful-Version`; content type ID is not required in the payload. via PUT /spaces/{space_id}/environments/{environment_id}/releases/{release_id}/entries/{entry_id}

Publishes all entities in a release. The release is automatically archived on success. via PUT /spaces/{space_id}/environments/{environment_id}/releases/{release_id}/published

Creates or updates a tag; tag IDs are immutable after creation. Set visibility via `X-Contentful-Tag-Visibility` header (defaults to `private`). via PUT /spaces/{space_id}/environments/{environment_id}/tags/{tag_id}

This action validates the latest version of a template for installation in the environment. via PUT /spaces/{space_id}/environments/{environment_id}/template_installations/{template_id}/validated

This action validates a template version for installation in the environment. via PUT /spaces/{space_id}/environments/{environment_id}/template_installations/{template_id}/versions/{version_number}/validated

You can use this endpoint to update the UI Config in your environment. These settings are visible to everyone in the environment. via PUT /spaces/{space_id}/environments/{environment_id}/ui_config

You can use this endpoint to update your User UI Config. via PUT /spaces/{space_id}/environments/{environment_id}/ui_config/me

Updates a workflow definition by ID. Only org or space admins can update workflow definitions. via PUT /spaces/{space_id}/environments/{environment_id}/workflow_definitions/{workflow_definition_id}

Advances or updates a workflow step. Only org or space admins can update by default; step-level permissions can grant access to other users. via PUT /spaces/{space_id}/environments/{environment_id}/workflows/{workflow_id}

Completes a workflow. Only org or space admins can complete by default; step-level permissions can grant access to other users. via PUT /spaces/{space_id}/environments/{environment_id}/workflows/{workflow_id}/completed

Use this endpoint to update an existing role. You cannot use the endpoint to create a new role with a specific id. via PUT /spaces/{space_id}/roles/{role_id}

Updates the `scheduledFor.datetime` or `scheduledFor.timezone` of a scheduled action. Only fields under `scheduledFor` can be changed; include `X-Contentful-Version`. via PUT /spaces/{space_id}/scheduled_actions/{scheduled_action_id}

Sets the allocation of add-ons for a space. The value is the final amount (not a delta); partial resource subsets are accepted. via PUT /spaces/{space_id}/space_add_ons

This endpoint allows you to change a space membership. Use this to assign additional roles or flag a user as 'admin'. via PUT /spaces/{space_id}/space_memberships/{space_membership_id}

Create or update a webhook via PUT /spaces/{space_id}/webhook_definitions/{webhook_definition_id}

Create a webhook signing secret via PUT /spaces/{space_id}/webhook_settings/signing_secret

This endpoint updates details of a specific OAuth application. via PUT /users/{user_id}/oauth_applications/{oauth_application_id}

Revokes a CMA token, setting `revokedAt` to the current timestamp. **This action cannot be undone.** via PUT /users/me/access_tokens/{token_id}/revoked