Skip to main content
Contentful logo
  • Category: developer tools
  • Auth: OAUTH2, API_KEY
  • Composio-managed OAuth available? Yes
  • Tools: 124
  • Triggers: 0
  • Slug: CONTENTFUL
  • Version: 20261101_00

Tools

Slug: CONTENTFUL_ACTIVATE_CONTENT_TYPEActivates (publishes) a content type in Contentful. Use this to make a content type available for creating entries. Requires the current version number for optimistic locking.

Input Parameters

integer
required
Current version number of the content type (required for optimistic locking). This is sent via the X-Contentful-Version header.
string
required
ID of the space containing the content type
string
required
ID of the environment containing the content type (typically ‘master’)
string
required
ID of the content type to activate (publish)

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CONTENTFUL_ARCHIVE_ASSETTool to archive an asset in Contentful. Use when you need to archive an asset to remove it from active use without deleting it permanently.

Input Parameters

string
required
ID of the asset to archive
string
required
ID of the space containing the asset
string
required
ID of the environment containing the asset (typically ‘master’)
integer
Version number of the asset to archive. If not provided, the current version will be fetched automatically.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CONTENTFUL_ARCHIVE_ENTRYTool to archive an entry in Contentful. Use when you need to move an entry to archived status. The entry must not be currently published, and you may need to provide the X-Contentful-Version header matching the entry’s current version.

Input Parameters

string
required
ID of the entry to archive
string
required
ID of the space containing the entry
string
required
ID of the environment containing the entry (typically ‘master’)
integer
Version of the entry to archive. Required for version control. Use the current version number of the entry.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CONTENTFUL_ARCHIVE_RELEASETool to archive a release in Contentful. Use when you need to lock a release to prevent modifications. An archived release cannot be edited until unarchived. Requires the current version number for optimistic locking.

Input Parameters

integer
required
Current version of the release for optimistic locking (X-Contentful-Version header)
string
required
The space identifier
string
required
The release identifier to archive
string
required
The environment identifier (typically ‘master’)

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CONTENTFUL_CREATE_APP_DEFINITIONS_KEYSTool to generate an app signing key for a Contentful app definition. Use when you need to create cryptographic keys for app authentication. Either provide generate=true to let Contentful create a key pair (returns private key), or provide a pre-generated public key in JWK format.

Input Parameters

object
JSON Web Key object containing a pre-generated public key to upload. Either this field or generate must be provided.
boolean
Set to true to let Contentful generate the key pair. If true, the response will include the private key. Either this field or jwk must be provided.
string
required
ID of the organization containing the app definition
string
required
ID of the app definition to create a key for

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CONTENTFUL_CREATE_CONTENT_TYPETool to create a new content type in a Contentful environment. Use when you need to define a new content structure with custom fields. Content types define the schema for entries.

Input Parameters

string
required
Name of the content type
array
required
Array of field definitions for the content type. A content type can have up to 50 fields
string
required
ID of the space where the content type will be created
string
Description of the content type explaining its purpose
string
ID of the field to use as the display field (entry title) for this content type. Must match the ‘id’ of one of the fields in the fields array
string
required
ID of the environment where the content type will be created (typically ‘master’)

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CONTENTFUL_CREATE_ENTRY_TASKTool to create a task on a Contentful entry. Use when you need to create workflow tasks for collaboration on entries. Tasks can be assigned to users and are used for managing content review and approval workflows.

Input Parameters

string
required
Description or body content of the task
string
required
Status of the task, typically ‘active’ for new tasks
string
required
ID of the entry to create the task for
string
required
ID of the space containing the entry
object
required
User to assign the task to, with sys.id, sys.linkType=‘User’, and sys.type=‘Link’
string
required
ID of the environment containing the entry (typically ‘master’)

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CONTENTFUL_CREATE_ENVIRONMENTTool to create a new environment within a Contentful space. Use when you need to set up a new environment for content management, such as staging or production. Optionally clone from an existing source environment.

Input Parameters

string
required
Name of the new environment
string
required
ID of the space where the environment will be created
string
ID of the source environment to copy content from. If provided, the new environment will be cloned from this environment. If not provided, an empty environment will be created.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CONTENTFUL_CREATE_LOCALETool to create a new locale in a Contentful space environment. Use when you need to add support for a new language or regional variation to your content. Locales enable multi-language content management by defining which languages are available for translation. Only one locale can be set as the default locale per environment.

Input Parameters

string
required
Locale code identifier used to differentiate translated content (e.g., ‘en-US’, ‘de-DE’, ‘fr-FR’). Must be unique within the environment.
string
required
Human-readable name of the locale (e.g., ‘U.S. English’, ‘German’, ‘French’)
boolean
Whether this locale is optional. If true, content in this locale is not required for publishing.
string
required
ID of the space where the locale will be created
string
Code of the locale to use if there is no translated content for this locale. Set to null if no fallback is desired. Must be an existing locale code in the environment.
string
required
ID of the environment where the locale will be created (typically ‘master’)
boolean
Whether this locale should be available in the Content Delivery API. Defaults to true.
boolean
Whether this locale should be available in the Content Management API. Defaults to true.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CONTENTFUL_CREATE_ORGANIZATIONS_APP_DEF_ACCESS_GRANTSCreates an app definition access grant for a specific organization or all organizations. The request accepts the marketplace end-user license agreement, terms of service, and privacy policy.

Input Parameters

string
required
ID of the organization to grant access to, or ‘all’ to allow all organizations to install the app
string ("Organization")
required
Type of grantee. Must be ‘Organization’
string
required
The ID of the organization that owns the app definition
string
required
The ID of the app definition to grant access to

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CONTENTFUL_CREATE_ORGANIZATIONS_APP_DEFINITIONSTool to create a new app definition in a Contentful organization. Use when you need to register a new app that can be installed into space environments.

Input Parameters

string
URL where the root HTML document of the app can be found
string
required
Name of the app definition
array
Locations where the app can be installed and rendered within Contentful
object
Model for app parameters configuration.
string
required
The ID of the organization where the app definition will be created

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CONTENTFUL_CREATE_ORGANIZATIONS_APP_DEFINITIONS_ACTIONSTool to create an action for a Contentful app definition. Use when you need to define actions that your app can perform, such as endpoint invocations or function calls.

Input Parameters

string
HTTPS URL for the endpoint (required when type is endpoint). Must be a valid HTTPS URL.
string
required
Name of the action to create
string ("endpoint" | "function" | "function-invocation")
required
Type of action - must be one of: endpoint (for HTTP endpoints), function (for Contentful functions), or function-invocation (for function invocations)
string
required
Category ID from available categories (e.g., Entries.v1.0, Notification.v1.0). Use get_organizations_app_actions_categories action to retrieve valid category IDs.
string
required
ID of the organization containing the app definition
string
required
ID of the app definition to create an action for

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CONTENTFUL_CREATE_ORGANIZATIONS_INVITATIONSCreate an invitation to an organization in Contentful (alpha feature). Use this to invite new users to join an organization with a specified role.

Input Parameters

string ("member" | "developer" | "admin" | "owner")
Enum for invitation role values.
string
required
The email address of the person being invited
string
The invitee’s last name
string
The invitee’s first name
string
required
ID of the organization to create the invitation for

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CONTENTFUL_CREATE_ORGANIZATIONS_SECURITY_CONTACTSCreates a security contact for a specific organization. Use when you need to add an email address to receive security notifications for the organization.

Input Parameters

string
required
Email address for the security contact. This email will receive security-related notifications for the organization.
string
required
The ID of the organization to create a security contact for

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CONTENTFUL_CREATE_ORGANIZATIONS_TAXONOMY_CONCEPTSTool to create a new taxonomy concept in a Contentful organization. Use when you need to add a concept for classifying and organizing content within an organization’s taxonomy.

Input Parameters

string
Optional globally unique identifier (URI) for the concept
object
Alternative labels for the concept with locale as key and array of strings as value (e.g., {‘en-US’: [‘Tech’, ‘IT’]})
array
Formal designations like classification codes
object
required
The preferred label for the concept with locale as key (e.g., {‘en-US’: ‘Technology’}). At least one locale is required.
object
Hidden labels for searching with locale as key and array of strings as value (e.g., {‘en-US’: [‘Hidden1’]})
string
required
The organization ID to create the taxonomy concept in

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CONTENTFUL_CREATE_ORGANIZATIONS_TAXONOMY_CONCEPT_SCHEMESTool to create a new taxonomy concept scheme in an organization. Use when you need to establish a new taxonomy structure or classification system for organizing content.

Input Parameters

string
Optional URI identifier for the concept scheme
object
required
Localized preferred label for the concept scheme. Each key is a locale code (e.g., ‘en-US’) and value is the label text (e.g., {‘en-US’: ‘Product Categories’})
object
Localized definition/description of the concept scheme. Each key is a locale code (e.g., ‘en-US’) and value is the definition text (e.g., {‘en-US’: ‘A classification scheme for products’})
string
required
The ID of the organization to create the concept scheme in

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CONTENTFUL_CREATE_RELEASETool to create a new release in Contentful. Use when you need to group entries and assets into a release for coordinated publishing or tracking. Requires at least one entity to be specified.

Input Parameters

string
required
Title of the release
object
required
Collection of entities (entries/assets) to include in the release
string
required
ID of the space where the release will be created
string
required
ID of the environment where the release will be created (typically ‘master’)

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CONTENTFUL_CREATE_SPACECreates a new space in Contentful. A space is a container for all content types, entries, and assets. Use this action when you need to set up a new workspace for content management. Each space is isolated and has its own API keys and environments.

Input Parameters

string
required
Name of the new space
string
Default locale code for the space. This locale will be used as the fallback locale for content. Common values: ‘en-US’, ‘en’, ‘de-DE’, ‘fr-FR’.
string
Organization ID to create the space under. Required if the authenticated user belongs to multiple organizations. The organization ID is sent via the X-Contentful-Organization header.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CONTENTFUL_CREATE_SPACES_API_KEYSTool to create a new Delivery API key for a Contentful space. Use when you need to generate new API credentials for accessing content delivery. The created key provides access to specified environments within the space.

Input Parameters

string
required
Name for the new API key. This helps identify the key’s purpose
string
required
ID of the space to create the API key in
string
Optional description for the API key to explain its purpose or usage
array
required
List of environments this API key will have access to. Each environment is specified as a link object with sys.id, sys.type, and sys.linkType

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CONTENTFUL_CREATE_SPACES_ENVIRONMENTS_ASSETSCreates a new asset in a Contentful space environment using a file URL for each locale. After creation, the asset must be processed before it’s available, and may need to be published to make it publicly accessible.

Input Parameters

object
required
Asset fields containing file information and optional title/description with locale-specific values
object
Model for asset metadata.
string
required
ID of the space where the asset will be created
string
required
ID of the environment where the asset will be created (typically ‘master’)

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CONTENTFUL_CREATE_SPACES_ENVIRONMENTS_ENTRIESTool to create a new entry in a Contentful space environment. Use when you need to add new content entries. Requires specifying the content type ID via X-Contentful-Content-Type header, and providing fields organized by locale.

Input Parameters

object
required
Entry fields organized by locale. Structure: {fieldName: {locale: value}}. Example: {‘title’: {‘en-US’: ‘Hello World’}}
object
Entry metadata including tags. Example: {‘tags’: [{‘sys’: {‘id’: ‘nyCampaign’, ‘linkType’: ‘Tag’, ‘type’: ‘Link’}}]}
string
required
ID of the space where the entry will be created
string
required
ID of the environment where the entry will be created (typically ‘master’)
string
required
Content type ID that defines the structure of the entry being created. Must be a valid content type ID from your space.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CONTENTFUL_CREATE_SPACES_ENVIRONMENTS_ENTRIES_COMMENTSTool to create a comment on an entry in Contentful. Use when you need to add a comment to a specific entry. Returns the created comment with status ‘active’ by default.

Input Parameters

string
required
The comment text content to create
string
required
ID of the entry to comment on
string
required
ID of the space containing the entry
string
required
ID of the environment containing the entry (typically ‘master’)

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CONTENTFUL_CREATE_SPACES_ENVIRONMENTS_EXTENSIONSTool to create a new UI extension within a Contentful space and environment. Use when you need to add custom field editors or sidebar widgets to enhance content editing capabilities.

Input Parameters

string
required
ID of the space where the extension will be created
object
required
Extension configuration object containing name, source, field types, and other settings
string
required
ID of the environment where the extension will be created (typically ‘master’)

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CONTENTFUL_CREATE_SPACES_SCHEDULED_ACTIONSTool to create a scheduled action for publishing or unpublishing entries/assets in Contentful. Use when you need to schedule an automatic publish or unpublish operation at a specific future time.

Input Parameters

string ("publish" | "unpublish")
required
Type of action to schedule (publish or unpublish)
object
required
Reference to the entry or asset to perform the action on
string
required
ID of the space where the scheduled action will be created
object
required
Reference to the environment where the action will be executed
object
required
Timestamp specification for when to execute the action

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CONTENTFUL_CREATE_WEBHOOKCreates a webhook in a Contentful space to receive notifications about matching events, such as entry creation, publishing, or asset updates. The webhook can include a transformation that specifies the request method.

Input Parameters

string
required
Target URL where webhook payloads will be sent via POST request
string
required
Name of the webhook for identification purposes
array
required
Array of event topics that trigger the webhook. Use patterns like ‘Entry.create’, ‘ContentType.create’, ‘.publish’, ‘Asset.’ to match specific events. Supports wildcards
array
Array of filter conditions that must be met for the webhook to fire. Filters allow conditional webhook triggering based on content properties
array
Array of custom HTTP headers to include with webhook requests. Each header has a ‘key’ and ‘value’ property
string
required
ID of the space where the webhook will be created
object
Model for webhook payload transformation configuration.
string
Password for HTTP Basic Authentication when calling the webhook URL
string
Username for HTTP Basic Authentication when calling the webhook URL

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CONTENTFUL_DELETE_ASSETDeletes an asset by ID from a Contentful environment. Use this when you need to permanently remove an asset. Note: If Contentful rejects deletion for published or archived assets, you must unpublish first using the appropriate CMA endpoints.

Input Parameters

string
required
ID of the asset to delete
string
required
ID of the space containing the asset
string
required
ID of the environment containing the asset (typically ‘master’)

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CONTENTFUL_DELETE_CONTENT_TYPEDeletes a content type by ID from a Contentful environment. Use this when you need to permanently remove a content type. Note: Content types must be unpublished before deletion if they are published, and must have no associated entries.

Input Parameters

string
required
ID of the space containing the content type
string
required
ID of the environment containing the content type (typically ‘master’)
string
required
ID of the content type to delete

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CONTENTFUL_DELETE_ENTRYDeletes an entry by ID from a Contentful environment. Use this when you need to permanently remove an entry. Note: If Contentful rejects deletion for published or archived entries, you must unpublish or unarchive first using the appropriate CMA endpoints.

Input Parameters

string
required
ID of the entry to delete
string
required
ID of the space containing the entry
string
required
ID of the environment containing the entry (typically ‘master’)

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CONTENTFUL_DELETE_ENVIRONMENTDeletes an environment by ID from a Contentful space. Use this when you need to permanently remove an environment. Note: You cannot delete the ‘master’ environment or an environment with active aliases.

Input Parameters

string
required
ID of the space containing the environment
string
required
ID of the environment to delete (e.g., ‘master’ or custom environment ID)

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CONTENTFUL_DELETE_EXTENSIONDeletes an extension by ID from a Contentful environment. Use this when you need to permanently remove an extension.

Input Parameters

string
required
ID of the space containing the extension
string
required
ID of the extension to delete
string
required
ID of the environment containing the extension (typically ‘master’)

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CONTENTFUL_DELETE_LOCALEDeletes a locale by ID from a Contentful environment. Use this when you need to permanently remove a locale. This action is irreversible — the locale cannot be recovered once removed. Note: You cannot delete the default locale for an environment.

Input Parameters

string
required
ID of the space containing the locale
string
required
ID of the locale to delete
string
required
ID of the environment containing the locale (typically ‘master’)

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CONTENTFUL_DELETE_ORGANIZATIONS_APP_DEF_EVENT_SUBSCRIPTIONDeletes an app event subscription from a Contentful organization. Use this when you need to remove event subscriptions from an app definition.

Input Parameters

string
required
ID of the organization containing the app definition
string
required
ID of the app definition to delete the event subscription from

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CONTENTFUL_DELETE_ORGANIZATIONS_APP_DEFINITIONS_DETAILSTool to delete app definition details for an organization in Contentful. Use when you need to remove app definition details from an organization.

Input Parameters

string
required
ID of the organization containing the app definition
string
required
ID of the app definition whose details should be deleted

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CONTENTFUL_DELETE_ORGANIZATIONS_APP_DEFINITIONS_KEYSTool to delete an app key from an app definition in a Contentful organization. Use when you need to permanently remove an app key.

Input Parameters

string
required
Key ID (kid) of the app key to delete
string
required
ID of the organization containing the app definition
string
required
ID of the app definition containing the key

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CONTENTFUL_DELETE_ORGANIZATIONS_APP_DEF_SIGNING_SECRETTool to remove the current app signing secret from an app definition. Use when you need to delete an existing signing secret for security or rotation purposes.

Input Parameters

string
required
ID of the organization containing the app definition
string
required
ID of the app definition whose signing secret should be removed

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CONTENTFUL_DELETE_ORGANIZATIONS_SECURITY_CONTACTSDeletes a security contact from a Contentful organization. Use this when you need to remove a security contact from an organization.

Input Parameters

string
required
The ID of the security contact to delete
string
required
The ID of the organization

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CONTENTFUL_DELETE_RELEASEDeletes a release by ID from a Contentful environment. Use this when you need to permanently remove a release.

Input Parameters

string
required
ID of the space containing the release
string
required
ID of the release to delete
string
required
ID of the environment containing the release (typically ‘master’)

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CONTENTFUL_DELETE_SCHEDULED_ACTIONCancels a scheduled action by ID in Contentful. Use this when you need to cancel a scheduled publish, unpublish, or other scheduled operation.

Input Parameters

string
required
ID of the space containing the scheduled action
string
required
ID of the environment (typically ‘master’). Required to identify which environment the scheduled action belongs to.
string
required
ID of the scheduled action to cancel

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CONTENTFUL_DELETE_SPACE_MEMBERSHIPDeletes a space membership by ID from a Contentful space. Use this when you need to remove a user’s access to a space.

Input Parameters

string
required
ID of the space containing the membership
string
required
ID of the space membership to delete

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CONTENTFUL_DELETE_SPACES_API_KEYSTool to delete a single Delivery API key from a Contentful space. Use when you need to permanently remove an API key. This action is useful for revoking access credentials when they are no longer needed or have been compromised.

Input Parameters

string
required
ID of the space containing the API key
string
required
ID of the API key to delete
integer
Version number for optimistic locking. If provided, the API key will only be deleted if this version matches the current version.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CONTENTFUL_DELETE_SPACES_UPLOADDeletes an upload by ID from a Contentful space. Use this when you need to permanently remove an upload. Note: This operation uses the upload.contentful.com base URL instead of the standard API URL.

Input Parameters

string
required
ID of the space containing the upload
string
required
ID of the upload to delete

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CONTENTFUL_DELETE_TAGDeletes a tag by ID from a Contentful environment. Use this when you need to permanently remove a tag.

Input Parameters

string
required
ID of the tag to delete
string
required
ID of the space containing the tag
string
required
ID of the environment containing the tag (typically ‘master’)
integer
Version of the tag to delete (optional, used for optimistic locking)

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CONTENTFUL_DELETE_WEBHOOKDeletes a webhook definition by ID from a Contentful space. Use this action when you need to permanently remove a webhook configuration. This action is irreversible — the webhook cannot be recovered once removed.

Input Parameters

string
required
ID of the space containing the webhook
string
required
ID of the webhook definition to delete

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CONTENTFUL_GET_APP_BUNDLERetrieves details of a specific app bundle by its ID. Use this to get information about an app bundle including its files, metadata, and associated app definition within a Contentful organization.

Input Parameters

string
required
ID of the app bundle to retrieve
string
required
ID of the organization containing the app definition
string
required
ID of the app definition containing the bundle

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CONTENTFUL_GET_APP_DEFINITIONTool to retrieve details of a specific app definition by its ID. Use when you need information about an app definition in an organization.

Input Parameters

string
required
The organization ID that owns the app definition
string
required
The app definition ID to retrieve

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CONTENTFUL_GET_ASSETTool to retrieve a single asset from a Contentful environment by its ID. Use when you need to get details about a specific asset including its file information, metadata, and publication status.

Input Parameters

string
required
ID of the asset to retrieve
string
required
ID of the space containing the asset
string
required
ID of the environment containing the asset (typically ‘master’)

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CONTENTFUL_GET_CONTENT_TYPESRetrieves a page of content types in a Contentful environment, including their structures and fields. Use pagination to retrieve the full collection.

Input Parameters

integer
Number of content types to skip for pagination
integer
Maximum number of content types to return (default: 100, max: 1000)
string
Order content types by field (e.g. ‘sys.createdAt’ or ‘-sys.createdAt’ for descending)
string
required
ID of the space containing the content types
string
required
ID of the environment containing the content types (typically ‘master’)

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CONTENTFUL_GET_CONTENT_TYPE_SNAPSHOTTool to retrieve a snapshot of a content type by snapshot ID. Use when you need to view the state of a content type at a specific point in time. Snapshots are only available for content types in the master environment.

Input Parameters

string
required
ID of the space containing the content type
string
required
ID of the snapshot to retrieve
string
required
ID of the content type to retrieve snapshot for

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CONTENTFUL_GET_CONTENT_TYPE_SNAPSHOTSRetrieves a page of snapshots for a content type in a Contentful environment. Use pagination to retrieve its snapshot history.

Input Parameters

integer
Number of snapshots to skip for pagination
integer
Maximum number of snapshots to return (default: 100, max: 1000)
string
required
ID of the space containing the content type
string
required
ID of the environment (typically ‘master’)
string
required
ID of the content type to retrieve snapshots for

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CONTENTFUL_GET_EDITOR_INTERFACETool to retrieve the editor interface configuration for a content type. Use when you need to see how fields are configured in the Contentful UI. The editor interface is automatically created when a content type is first activated.

Input Parameters

string
required
ID of the space containing the content type
string
required
ID of the environment containing the content type (typically ‘master’)
string
required
ID of the content type to get the editor interface for

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CONTENTFUL_GET_ENTRYTool to retrieve a single entry from a Contentful space environment by its ID. Use this action when you need to get details about a specific entry including its content, metadata, and publication status. Returns all localized and unpublished content from the Content Management API.

Input Parameters

string
Specify locale for localized content (e.g., ‘en-US’, ‘de-DE’)
integer
Number of levels to resolve linked entries and assets (0-10, default: 1)
string
required
ID of the entry to retrieve
string
required
ID of the space containing the entry
string
required
ID of the environment containing the entry (typically ‘master’)

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CONTENTFUL_GET_ENTRY_COMMENTTool to retrieve a specific comment from an entry in Contentful. Use when you need to get details of a comment including its body, status, author, and metadata.

Input Parameters

string
required
ID of the entry containing the comment
string
required
ID of the space containing the entry
string
required
ID of the comment to retrieve
string
required
ID of the environment containing the entry (typically ‘master’)

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CONTENTFUL_GET_ENTRY_REFERENCESTool to retrieve references to a specific entry in Contentful. Use when you need to find all entries that reference a particular entry. The include parameter controls how many levels of nested references are returned.

Input Parameters

integer
required
Level of referenced content to include in the response (0-10). Higher values include more nested references.
string
required
ID of the entry to get references for
string
required
ID of the space containing the entry
string
required
ID of the environment containing the entry (typically ‘master’)

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CONTENTFUL_GET_ENTRY_SNAPSHOTSLists snapshots of an entry in Contentful for reviewing its history. Supports pagination.

Input Parameters

integer
Number of snapshots to skip for pagination
integer
Maximum number of snapshots to return (default: 100, max: 1000)
string
required
ID of the entry to retrieve snapshots for
string
required
ID of the space containing the entry
string
required
ID of the environment (typically ‘master’)

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CONTENTFUL_GET_ENVIRONMENTTool to retrieve details of a specific environment by its ID within a space. Use when you need information about a single environment in Contentful.

Input Parameters

string
required
ID of the space containing the environment
string
required
ID of the environment to retrieve

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CONTENTFUL_GET_ORGANIZATIONRetrieves details of a specific organization by its ID. Use this when you need to get information about an organization that an admin or owner has access to.

Input Parameters

string
required
The ID of the organization to retrieve

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CONTENTFUL_GET_ORGANIZATION_ACCESS_GRANTRetrieves the access grant status for a specific organization. Use this to verify whether the authenticated user has access to a specific organization.

Input Parameters

string
required
ID of the organization to check access grant for

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CONTENTFUL_GET_ORGANIZATIONSLists a page of Contentful organizations available to the authenticated account, with limit and skip pagination.

Input Parameters

integer
Number of organizations to skip for pagination
integer
Maximum number of organizations to return (default: 100, max: 1000)

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CONTENTFUL_GET_ORGANIZATIONS_AI_PROVIDERSRetrieves all AI providers configured for an organization in Contentful. Use this to list AI service providers (OpenAI, AWS Bedrock, Google Gemini, etc.) that have been configured for the organization.

Input Parameters

string
required
ID of the organization to get AI providers for

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CONTENTFUL_GET_ORGANIZATIONS_APP_ACTIONS_CATEGORIESRetrieves app action categories for a Contentful organization. Use this to discover available app action categories and their parameters.

Input Parameters

string
required
The ID of the organization

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CONTENTFUL_GET_ORGANIZATIONS_APP_DEF_EVENT_SUBSCRIPTIONTool to retrieve details of an app event subscription by organization and app definition ID. Use when you need to check the configuration of event subscriptions for an app.

Input Parameters

string
required
ID of the organization containing the app definition
string
required
ID of the app definition to retrieve the event subscription from

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CONTENTFUL_GET_ORGANIZATIONS_APP_DEFINITIONSRetrieves all app definitions for a specific organization. Use when you need to list or discover apps owned by an organization.

Input Parameters

string
required
ID of the organization to retrieve app definitions for

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CONTENTFUL_GET_ORGANIZATIONS_APP_DEFINITIONS_ACCESS_GRANTSLists a page of access grants for an app definition within an organization, with limit and skip pagination. Returned grant items contain system metadata.

Input Parameters

integer
Number of access grants to skip for pagination
integer
Maximum number of access grants to return (default: 100, max: 1000)
string
required
The ID of the organization
string
required
The ID of the app definition

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CONTENTFUL_GET_ORGANIZATIONS_APP_DEFINITIONS_ACTIONSTool to get all actions of an app definition within an organization. Use when you need to retrieve the list of actions defined for a specific Contentful app.

Input Parameters

string
required
The ID of the organization
string
required
The ID of the app definition

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CONTENTFUL_GET_ORGANIZATIONS_APP_DEFINITIONS_ACTIONS2Tool to read a specific app action from an app definition within an organization. Use when you need to retrieve details of a particular action defined for a Contentful app.

Input Parameters

string
required
The ID of the specific app action to retrieve
string
required
The ID of the organization that contains the app definition
string
required
The ID of the app definition that contains the action

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CONTENTFUL_GET_ORGANIZATIONS_APP_DEFINITIONS_APP_BUNDLESTool to get all app bundles for a specific app definition within an organization. Use when you need to list all uploaded bundles for a Contentful app.

Input Parameters

string
required
ID of the organization containing the app definition
string
required
ID of the app definition to retrieve bundles for

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CONTENTFUL_GET_ORGANIZATIONS_APP_DEFINITIONS_FUNCTIONSTool to get all functions of an app definition within an organization. Use when you need to retrieve the list of functions defined for a specific Contentful app.

Input Parameters

string
required
The ID of the organization
string
required
The ID of the app definition

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CONTENTFUL_GET_ORGANIZATIONS_APP_DEFINITIONS_KEYSLists app keys for a specific app definition in a Contentful organization. Returns one page of cryptographic keys for app authentication.

Input Parameters

string
required
ID of the organization containing the app definition
string
required
ID of the app definition to retrieve keys for

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CONTENTFUL_GET_ORGANIZATIONS_APP_DEFINITIONS_SIGNING_SECRETTool to retrieve the current app signing secret for an app definition. Use when you need to verify the existence or view the last 4 characters of a signing secret. Note: Full secret is only available at creation time.

Input Parameters

string
required
ID of the organization containing the app definition
string
required
ID of the app definition whose signing secret should be retrieved

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CONTENTFUL_GET_ORGANIZATIONS_ENABLEMENTSRetrieves feature enablements for a specific organization in Contentful. Use this to check which AI and vectorization features are enabled for the organization.

Input Parameters

string
required
The ID of the organization to retrieve enablements for

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CONTENTFUL_GET_ORGANIZATIONS_INVITATIONSRetrieves a single invitation for an organization (alpha). Use this to get details about a specific invitation including invitee information and status. Note: This endpoint is in alpha state and may be subject to breaking changes.

Input Parameters

string
required
The ID of the invitation to retrieve
string
required
The ID of the organization

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CONTENTFUL_GET_ORGANIZATIONS_ORGANIZATION_PERIODIC_USAGESTool to get organization periodic usage statistics. Use when you need to retrieve API usage metrics for an organization during a specific time period, with optional filtering by metric type and date range.

Input Parameters

string
Order results by usage
string
Filter by specific metrics (comma-separated values like ‘cma,cpa,gql’)
string
required
The ID of the organization
string
End date for the date range filter (ISO 8601 format: YYYY-MM-DD)
string
Start date for the date range filter (ISO 8601 format: YYYY-MM-DD)

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CONTENTFUL_GET_ORGANIZATIONS_ROLESLists space roles in a Contentful organization, including roles that define permissions and access levels within its spaces. Returns one page of roles.

Input Parameters

string
required
The ID of the organization to retrieve roles from

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CONTENTFUL_GET_ORGANIZATIONS_SECURITY_CONTACTSRetrieves security contacts for a specific organization that an admin or owner has access to. Use this to get the list of security contacts configured for an organization.

Input Parameters

string
required
The ID of the organization to retrieve security contacts for

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CONTENTFUL_GET_ORGANIZATIONS_SPACE_ENABLEMENTSRetrieves all space enablements for a specific organization. Use when you need to check which features are enabled for spaces within an organization.

Input Parameters

string
required
The ID of the organization to retrieve space enablements for

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CONTENTFUL_GET_ORGANIZATIONS_SPACE_PERIODIC_USAGESTool to retrieve space periodic usage data for an organization. Use this when you need to analyze usage metrics, monitor API consumption, or track resource utilization over time.

Input Parameters

string
Order results by usage. Example: ‘usage’ or ‘-usage’
string
Comma-separated list of metrics to filter by (e.g., ‘cma,cpa,gql’)
string
End date for the usage period in ISO 8601 format (e.g., ‘2020-01-05’)
string
required
The ID of the organization to retrieve space periodic usages for
string
Start date for the usage period in ISO 8601 format (e.g., ‘2020-01-01’)

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CONTENTFUL_GET_ORGANIZATIONS_TAXONOMY_CONCEPTSLists taxonomy concepts for an organization in Contentful, with limit and skip pagination. Use this to discover concepts for classifying and organizing content.

Input Parameters

integer
Number of concepts to skip for pagination
integer
Maximum number of concepts to return (default: 100, max: 1000)
string
required
The organization ID to retrieve taxonomy concepts from

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CONTENTFUL_GET_ORGANIZATIONS_TAXONOMY_CONCEPTS_ANCESTORSRetrieves the list of ancestor concepts for a specific taxonomy concept. Use this when you need to understand the hierarchical lineage of a concept in the taxonomy structure.

Input Parameters

string
required
The ID of the taxonomy concept to retrieve ancestors for
string
required
The ID of the organization

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CONTENTFUL_GET_ORGANIZATIONS_TAXONOMY_CONCEPT_SCHEMESLists taxonomy concept schemes for an organization, with limit and skip pagination. Use this to discover the organization’s concept schemes and taxonomy structure.

Input Parameters

integer
Number of concept schemes to skip for pagination
integer
Maximum number of concept schemes to return (default: 100, max: 1000)
string
required
The ID of the organization to retrieve concept schemes from

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CONTENTFUL_GET_ORGANIZATIONS_TAXONOMY_CONCEPT_SCHEMES2Tool to retrieve a specific taxonomy concept scheme from an organization. Use when you need to get detailed information about a taxonomy concept scheme including its concepts, labels, and definitions.

Input Parameters

string
required
The ID of the organization that contains the concept scheme
string
required
The ID of the taxonomy concept scheme to retrieve

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CONTENTFUL_GET_ORGANIZATIONS_TAXONOMY_CONCEPT_SCHEMES_TOTALRetrieves the total count of taxonomy concept schemes for a specific organization. Use this when you need to get the number of concept schemes configured for an organization’s taxonomy.

Input Parameters

string
required
The ID of the organization to retrieve taxonomy concept schemes total for

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CONTENTFUL_GET_ORGANIZATIONS_TAXONOMY_CONCEPTS_TOTALRetrieves the total count of taxonomy concepts for a specific organization. Use this when you need to get the number of concepts configured for an organization’s taxonomy.

Input Parameters

string
required
The ID of the organization to retrieve taxonomy concepts total for

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CONTENTFUL_GET_RELEASETool to get a single release by ID from Contentful. Use when you need to retrieve details about a specific release including its entities, metadata, and archive status.

Input Parameters

string
required
ID of the space containing the release
string
required
ID of the release to retrieve
string
required
ID of the environment containing the release (typically ‘master’)

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CONTENTFUL_GET_SPACERetrieves space-level metadata for a specific Contentful space by ID, including its name and system fields. The returned system version can be used when updating the space.

Input Parameters

string
required
ID of the space to retrieve

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CONTENTFUL_GET_SPACE_MEMBERSHIPSTool to get all space memberships in a Contentful space. Use when you need to list all users who have access to a space and their assigned roles. Returns paginated results with membership details including admin status and role assignments.

Input Parameters

integer
Number of memberships to skip for pagination
integer
Maximum number of memberships to return (default: 25, max: 1000)
string
required
ID of the space to retrieve memberships from

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CONTENTFUL_GET_SPACES_API_KEYSLists a page of Delivery API keys for a Contentful space, with optional pagination. Returns key details including names and access tokens, and policies and associated environments when available.

Input Parameters

integer
Number of API keys to skip for pagination
integer
Maximum number of API keys to return (default: 100, max: 1000)
string
required
ID of the space to retrieve API keys from

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CONTENTFUL_GET_SPACES_ENVIRONMENTSLists environments in a Contentful space, including the master environment. Returns the API’s first page of results with pagination metadata.

Input Parameters

string
required
ID of the space to get environments from

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CONTENTFUL_GET_SPACES_ENVIRONMENTS_APP_INSTALLATIONSLists app installations in a specific Contentful environment. Returns the API’s first page of results with pagination metadata.

Input Parameters

string
required
ID of the space to retrieve app installations from
string
required
ID of the environment to retrieve app installations from (typically ‘master’)

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CONTENTFUL_GET_SPACES_ENVIRONMENTS_ASSETSRetrieves all assets from a specific environment in a Contentful space. Use this to list and browse assets like images, videos, and documents. Supports pagination and ordering for large asset collections.

Input Parameters

integer
Number of assets to skip for pagination
integer
Maximum number of assets to return (default: 100, max: 1000)
string
Order assets by field (e.g. ‘sys.createdAt’ or ‘-sys.createdAt’ for descending)
string
required
ID of the space containing the assets
string
required
ID of the environment containing the assets (typically ‘master’)

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CONTENTFUL_GET_SPACES_ENVIRONMENTS_LOCALESLists locales in a Contentful space environment, including their codes, names, default status and fallback configurations. Returns the API’s first page of results with pagination metadata.

Input Parameters

string
required
ID of the space to get locales from
string
required
ID of the environment to get locales from (typically ‘master’)

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CONTENTFUL_GET_SPACES_ENVS_APP_INSTALLATIONS_FUNCTIONSRetrieves functions for an app installation in a Contentful space and environment. An HTTP 404 is returned as an empty functions list.

Input Parameters

string
required
The ID of the Contentful space
string
required
The ID of the environment (e.g., ‘master’)
string
required
The ID of the installed app

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CONTENTFUL_GET_USERS_METool to retrieve information about the currently authenticated user. Use when you need to get details about the user making the API calls, such as their profile information, email, or account status.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CONTENTFUL_GET_WEBHOOKRetrieves a single webhook definition from a Contentful space, including its URL, subscribed topics, headers, and supported filter details. Returned filter details omit condition values.

Input Parameters

string
required
ID of the space containing the webhook
string
required
ID of the webhook definition to retrieve

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CONTENTFUL_GET_WEBHOOK_CALLSTool to retrieve an overview of recent webhook calls for a specific webhook in Contentful. Use this action when you need to inspect webhook call history, debug webhook issues, or monitor webhook performance and reliability. The response includes request/response details, timestamps, status codes, and any errors that occurred.

Input Parameters

string
required
ID of the space containing the webhook
string
required
ID of the webhook to retrieve call history for

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CONTENTFUL_GET_WEBHOOK_HEALTHRetrieves health status and call statistics for a specific webhook in Contentful. Use this action when you need to monitor webhook performance, check success rates, or troubleshoot webhook delivery issues.

Input Parameters

string
required
ID of the space containing the webhook
string
required
ID of the webhook to retrieve health information for

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CONTENTFUL_LIST_ENTRIESLists and searches entries in a Contentful space environment. Supports pagination, sorting, field selection, full-text search, and filtering by content type.

Input Parameters

integer
Number of entries to skip for pagination
integer
Maximum number of entries to return per page (default: 100, max: 1000)
string
Sort results by a specified field (e.g., ‘sys.createdAt’ or ‘-fields.name’ for reverse order)
string
Full-text search query to filter entries
string
Retrieve content in specified language/region code
string
Comma-separated list of specific fields to return (e.g., ‘sys.id,fields.title’). Supports depth of 2 levels maximum.
integer
Number of levels to resolve linked entries and assets (0-10, default: 1)
string
required
ID of the space containing the entries
string
Filter entries by content type ID. Required when filtering by custom fields.
string
required
ID of the environment containing the entries (typically ‘master’)

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CONTENTFUL_LIST_ENVIRONMENTSLists all environments of a space in Contentful, including the master environment and any custom environments. Use this action when you need to discover available environments within a space for content management operations. Supports pagination for spaces with many environments.

Input Parameters

integer
Number of environments to skip for pagination (default: 0)
integer
Maximum number of environments to return per page (default: 25, max: 1000)
string
required
ID of the space to list environments from

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CONTENTFUL_LIST_SPACESLists all spaces that the authenticated user has access to in Contentful. This is a fundamental operation needed before performing any other content management actions since most operations require a space ID. To paginate, increment skip by limit across successive calls; stop when the returned count is less than limit.

Input Parameters

integer
Number of spaces to skip for pagination
integer
Maximum number of spaces to return (default: 100, max: 1000)
string
Order spaces by field (e.g. ‘sys.createdAt’ or ‘-sys.createdAt’)

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CONTENTFUL_LIST_SPACES_ROLESLists roles defining user permissions and access levels in a Contentful space. Returns the API’s first page of results with pagination metadata.

Input Parameters

string
required
ID of the space to retrieve roles from

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CONTENTFUL_LIST_WEBHOOKSRetrieves a page of webhook definitions configured for a Contentful space, including pagination metadata. Use it to inspect webhook configurations and subscriptions.

Input Parameters

string
required
ID of the space to retrieve webhooks from

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CONTENTFUL_PROCESS_ASSETTool to process an asset file in Contentful for a specific locale. Use this action when you need to trigger asset processing after uploading a file. Processing downloads the file from the provided URL, validates it, and makes it available through Contentful’s CDN. After processing completes, the asset can be published to make it publicly accessible.

Input Parameters

string
required
ID of the asset to process
string
required
ID of the space containing the asset
string
required
Locale code for the file to process (e.g., ‘en-US’, ‘de-DE’)
string
required
ID of the environment containing the asset (typically ‘master’)
integer
Version of the asset to process. If not provided, the current version will be fetched automatically.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CONTENTFUL_PUBLISH_ASSETTool to publish an asset in Contentful, making it available via the Content Delivery API. Use when you need to make an asset publicly accessible or move it from draft to published status. The asset must not be archived and should be fully processed before publishing. Publishing increments the asset version and sets publication metadata.

Input Parameters

string
required
ID of the asset to publish
string
required
ID of the space containing the asset
string
required
ID of the environment containing the asset (typically ‘master’)
integer
Version of the asset to publish. Required for version control. Use the current version number of the asset.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CONTENTFUL_PUBLISH_ENTRYTool to publish an entry in Contentful, making it available via the Content Delivery API. Use when you need to make an entry publicly accessible or move it from draft to published status. The entry must not be archived and should have all required fields completed. Publishing increments the entry version.

Input Parameters

string
required
ID of the entry to publish
string
required
ID of the space containing the entry
string
required
ID of the environment containing the entry (typically ‘master’)
integer
Version of the entry to publish. Required for version control. Use the current version number of the entry.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CONTENTFUL_QUERY_ASSET_COLLECTIONTool to retrieve multiple assets with pagination and filtering via GraphQL API. Use when you need to query assets from Contentful with advanced filtering, sorting, and locale selection. Supports preview mode and fallback locale options.

Input Parameters

integer
Zero-indexed offset in the collection from which items are fetched. Default is 0
integer
Maximum number of items to fetch. Default is 100, maximum is 1000
array
Order specifications to apply on the collection query. Example: [‘sys_firstPublishedAt_ASC’, ‘sys_id_DESC’]
object
Filter specifications to apply on the collection query (AssetFilter type). Example: {‘contentType’: ‘image/jpeg’}
string
Locale for the collection items. If not set, the default locale is used. Example: ‘en-US’
boolean
When set to true, returns non-published content. Default is false
string
required
ID of the space to query assets from
string
Content Delivery API (CDA) access token. If not provided, will attempt to use token from metadata. Required for GraphQL Content API access. You can obtain this from the space’s API keys.
boolean
When set to false, fields without a value in the requested locale return null instead of the fallback locale. Default is true

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CONTENTFUL_QUERY_GRAPHQL_CONTENT_TYPE_COLLECTIONQueries Contentful’s GraphQL Content API using a supplied query and optional variables, for a space and optionally an environment. It can retrieve content-type collections with filtering, sorting, pagination, or preview mode.

Input Parameters

string
required
GraphQL query string. Must be in the format: { contentTypeIdCollection { items { sys { id } fieldName } } }. The content type ID should be in camelCase with ‘Collection’ suffix. Example: ’{ testArticleCollection { items { sys { id publishedAt } title } } }’
string
required
ID of the Contentful space
object
Optional GraphQL variables for parameterized queries. Used to pass dynamic values to the query (e.g., filters, pagination parameters). Example: {‘limit’: 10, ‘preview’: true}
string
Content Delivery API (CDA) access token. If not provided, will attempt to use token from metadata. Required for GraphQL Content API access.
string
ID of the environment (optional, omit for default environment). Use ‘master’ for production environment.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CONTENTFUL_UNARCHIVE_ENTRYTool to unarchive an entry in Contentful, restoring it to active status. Use when you need to restore an archived entry to make it available for editing and publishing. The entry must be currently archived. You may need to provide the X-Contentful-Version header matching the entry’s current version.

Input Parameters

string
required
ID of the entry to unarchive
string
required
ID of the space containing the entry
string
required
ID of the environment containing the entry (typically ‘master’)
integer
Version of the entry to unarchive. Required for version control. Use the current version number of the entry.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CONTENTFUL_UNPUBLISH_CONTENT_TYPEUnpublishes a content type in a Contentful space and environment, taking it offline from the Content Delivery API while retaining it for further modification. Requires the content type’s current version for optimistic locking.

Input Parameters

integer
required
Current version number of the content type (required for optimistic locking). This is sent via the X-Contentful-Version header.
string
required
ID of the space containing the content type
string
required
ID of the environment containing the content type (typically ‘master’)
string
required
ID of the content type to unpublish

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CONTENTFUL_UPDATE_APP_DEFINITIONTool to update an app definition by ID in a Contentful organization. Use when you need to modify an app’s name, source URL, locations, or parameters.

Input Parameters

string
The source URL where the root HTML document of the app is hosted
string
The name of the app
array
Array of location objects specifying where the app will be rendered in the Contentful web app
object
Model for app parameters.
string
required
The organization ID that owns the app definition
string
required
The app definition ID to update

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CONTENTFUL_UPDATE_CONTENT_TYPEUpdates an existing content type in a Contentful environment. Use when you need to modify a content type’s name, description, display field, or field definitions. Requires the current version number for optimistic locking. The API does not merge partial updates - you must provide the complete content type definition including all existing fields.

Input Parameters

string
required
Name of the content type
array
required
Array of field definitions for the content type. A content type can have up to 50 fields. Must include ALL fields from the existing content type - the API does not merge partial updates
integer
required
Current version number of the content type for optimistic locking. This is sent via the X-Contentful-Version header to prevent conflicting updates
string
required
ID of the space containing the content type
string
Description of the content type explaining its purpose
string
ID of the field to use as the display field (entry title) for this content type. Must match the ‘id’ of one of the fields in the fields array
string
required
ID of the environment containing the content type (typically ‘master’)
string
required
ID of the content type to update

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CONTENTFUL_UPDATE_EDITOR_INTERFACETool to update the editor interface configuration for a content type. Use when you need to customize how fields are displayed and edited in the Contentful UI. The version number is required to prevent conflicts when multiple users update the same editor interface.

Input Parameters

integer
required
Current version of the editor interface used for optimistic locking. Get this from the sys.version field when fetching the editor interface. Sent via the X-Contentful-Version header.
array
required
Array of control objects defining how each field should be displayed and edited in the Contentful UI
string
required
ID of the space containing the content type
string
required
ID of the environment containing the content type (typically ‘master’)
string
required
ID of the content type to update the editor interface for

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CONTENTFUL_UPDATE_ENTRYCreates or updates an entry with a specific ID in a Contentful space environment. Requires a content type ID, a version number, and field values organized by locale.

Input Parameters

object
required
Entry field values organized by field name and locale. Structure: {field_name: {locale: value}}. Example: {‘title’: {‘en-US’: ‘My Title’}, ‘body’: {‘en-US’: ‘Content’}}. Available fields and their types depend on the content_type definition.
integer
required
Current entry version for optimistic locking. Provide the latest value from sys.version. This is sent via the X-Contentful-Version header to prevent conflicting updates.
string
required
ID of the entry to create or update
object
Entry metadata including tags. Example: {‘tags’: []} or {‘tags’: [{‘sys’: {‘type’: ‘Link’, ‘linkType’: ‘Tag’, ‘id’: ‘tagId’}}]}
string
required
ID of the space containing the entry
string
required
Content type ID for this entry (e.g., ‘testArticle’, ‘blogPost’). Must match an existing content type in the space.
string
required
ID of the environment containing the entry (typically ‘master’)

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CONTENTFUL_UPDATE_LOCALEUpdates an existing locale in a Contentful environment. Use this action when you need to modify locale properties such as name, code, fallback settings, or API availability flags. Requires the current version number for optimistic locking to prevent concurrent modifications.

Input Parameters

string
required
Locale code identifier used to differentiate translated content (e.g., ‘en-US’, ‘de-DE’)
string
required
Human-readable name of the locale (e.g., ‘U.S. English’, ‘German’)
integer
required
Current locale version used for optimistic locking. Provide the latest value from sys.version; it is sent via the X-Contentful-Version header. Must match the current sys.version exactly (retrieve via CONTENTFUL_GET_SPACES_ENVIRONMENTS_LOCALES); an outdated value causes a version conflict error.
boolean
Whether this locale is optional. If true, content entries do not require this locale to be published
string
required
ID of the space containing the locale
string
required
ID of the locale to update
string
Code of the locale to use if there is no translated content for this locale. Set to null if no fallback is desired
string
required
ID of the environment containing the locale (typically ‘master’)
boolean
Whether this locale is available via the Content Delivery API
boolean
Whether this locale is available via the Content Management API

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CONTENTFUL_UPDATE_ORGANIZATIONS_APP_DEF_EVENT_SUBSCRIPTIONTool to update or create an app event subscription in a Contentful organization. Use when you need to configure event subscriptions for an app definition to receive webhooks.

Input Parameters

array
required
List of event topics to subscribe to (e.g., ‘Entry.create’, ‘Entry.update’, ‘Asset.create’). Events matching these topics will be sent to the targetUrl.
string
required
Subscription URL that will receive events. Must be a valid HTTPS URL.
string
required
ID of the organization containing the app definition
string
required
ID of the app definition to update the event subscription for

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CONTENTFUL_UPDATE_ORGANIZATIONS_APP_DEFINITIONS_ACTIONSUpdates an action for a Contentful app definition, supplying its name, type, category, and URL together.

Input Parameters

string
required
HTTPS URL for the endpoint (required when type is endpoint). Must be a valid HTTPS URL.
string
required
Updated name of the action
string ("endpoint" | "function" | "function-invocation")
required
Type of action - must be one of: endpoint (for HTTP endpoints), function (for Contentful functions), or function-invocation (for function invocations)
string
required
Category ID from available categories (e.g., Entries.v1.0, Notification.v1.0). Use get_organizations_app_actions_categories action to retrieve valid category IDs.
string
required
ID of the app action to update
string
required
ID of the organization containing the app definition
string
required
ID of the app definition containing the action

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CONTENTFUL_UPDATE_ORGANIZATIONS_APP_DEFINITIONS_DETAILSSends an empty-body request to create or update details for a Contentful app definition.

Input Parameters

string
required
ID of the organization containing the app definition
string
required
ID of the app definition whose details should be updated

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CONTENTFUL_UPDATE_ORGANIZATIONS_APP_DEF_SIGNING_SECRETTool to create or overwrite the app signing secret for an app definition. Use when you need to set up webhook signature verification or rotate an existing secret. Note: This operation overwrites any existing signing secret.

Input Parameters

string
required
The signing secret value. Must be a 64-character hexadecimal string used to verify webhook signatures from Contentful.
string
required
ID of the organization containing the app definition
string
required
ID of the app definition for which to create or update the signing secret

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CONTENTFUL_UPDATE_ORGANIZATIONS_ENABLEMENTSUpdates an organization’s AI action and vectorization feature enablements in Contentful. All three settings must be supplied together, along with the current version for optimistic locking.

Input Parameters

integer
required
Current version of the enablements document for optimistic locking. Provide the latest value from sys.version; it is sent via the X-Contentful-Version header.
object
required
Vectorization configuration. All three enablement fields (builtInAiActions, customAiActions, vectorization) are required by the API.
object
required
Custom AI actions configuration. All three enablement fields (builtInAiActions, customAiActions, vectorization) are required by the API.
string
required
The ID of the organization to update enablements for
object
required
Built-in AI actions configuration. All three enablement fields (builtInAiActions, customAiActions, vectorization) are required by the API.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CONTENTFUL_UPDATE_ORGANIZATIONS_SECURITY_CONTACTSUpdates an organization security contact that an admin or owner has access to. Use this to change the email address of a security contact.

Input Parameters

string
required
The updated email address for the security contact
string
required
The ID of the security contact to update
string
required
The ID of the organization

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CONTENTFUL_UPDATE_ORGANIZATIONS_TAXONOMY_CONCEPTSTool to create or update a taxonomy concept with a user-defined ID in a Contentful organization. Use when you need to create a concept with a specific ID or update an existing concept’s properties.

Input Parameters

string
Optional globally unique identifier (URI) for the concept
integer
Version number for updates (used for optimistic locking). Required when updating an existing concept, not needed when creating a new concept with a user-defined ID. Sent via X-Contentful-Version header.
object
Alternative labels for the concept with locale as key and array of strings as value (e.g., {‘en-US’: [‘Tech’, ‘IT’]})
array
Formal designations like classification codes
object
required
The preferred label for the concept with locale as key (e.g., {‘en-US’: ‘Technology’}). At least one locale is required.
string
required
User-defined ID for the taxonomy concept to create or update
object
Hidden labels for searching with locale as key and array of strings as value (e.g., {‘en-US’: [‘Hidden1’]})
string
required
The organization ID containing the taxonomy concept

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CONTENTFUL_UPDATE_ORGANIZATIONS_TAXONOMY_CONCEPT_SCHEMESTool to create or update a taxonomy concept scheme with a user-defined ID in an organization. Use when you need to create a new classification scheme or update an existing one with localized labels and definitions.

Input Parameters

string
Optional URI identifier for the concept scheme
integer
Version number for updates (used for optimistic locking). Required when updating an existing concept scheme, not needed for creation. Sent via X-Contentful-Version header.
object
required
Localized preferred label for the concept scheme. Keys are locale codes (e.g., ‘en-US’), values are the labels in that locale.
object
Localized definition for the concept scheme. Keys are locale codes (e.g., ‘en-US’), values are the definitions in that locale.
string
required
The ID of the organization to create/update the concept scheme in
string
required
User-defined ID for the concept scheme. This will be used as the unique identifier for the concept scheme.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CONTENTFUL_UPDATE_SPACEUpdates the name of a specific space. Notes: - The version number is required to ensure you’re updating the latest version of the space. - You can get the current version from the sys.version field when fetching space details. - Only the name of the space can be updated.

Input Parameters

string
required
New name for the space
integer
required
Current space version used for optimistic locking. Provide the latest value from sys.version; it is sent via the X-Contentful-Version header. Must match the current sys.version exactly (retrieve via CONTENTFUL_GET_SPACE); an outdated value causes a version conflict error.
string
required
ID of the space to update

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CONTENTFUL_UPDATE_SPACES_ENVIRONMENTS_TAGSCreates or updates a tag in a Contentful environment. Use this when you need to modify an existing tag’s name or create a new one.

Input Parameters

object
required
System metadata for the tag (must include id and type fields)
string
required
Display name for the tag
string
required
ID of the tag to update
string
required
ID of the space containing the tag
string
required
ID of the environment containing the tag (typically ‘master’)
integer
Version of the tag to update (used for optimistic locking). If not provided, the API will use version 1.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CONTENTFUL_UPDATE_WEBHOOKUpdates an existing webhook definition in a Contentful space. Use this action when you need to modify webhook configuration such as the target URL, event topics, custom headers, filters, or authentication settings. Contentful uses optimistic locking via the version parameter or X-Contentful-Version header to prevent concurrent modification conflicts.

Input Parameters

string
required
Target URL where webhook events will be sent
string
required
Name of the webhook for identification purposes
array
required
Array of event topics that trigger the webhook. Use patterns like ‘Entry.create’, ‘ContentType.create’, ‘.publish’, ‘Asset.’
array
Content filters to selectively trigger the webhook based on content properties
array
Custom HTTP headers to include in webhook requests
integer
Current version number of the webhook. Required for optimistic locking to prevent concurrent updates. If not provided, X-Contentful-Version header should be set externally.
string
required
ID of the space containing the webhook
object
Model for webhook transformation configuration.
string
HTTP Basic Auth password for webhook endpoint authentication
string
HTTP Basic Auth username for webhook endpoint authentication
string
required
ID of the webhook definition to update

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CONTENTFUL_VALIDATE_BULK_ACTIONTool to validate a bulk action before executing it. Use when you need to check if multiple entries or assets can be published in bulk without actually publishing them. This helps identify potential issues before attempting the actual bulk operation.

Input Parameters

string ("publish")
Enum for bulk action types.
object
required
Collection of entities (entries or assets) to validate for bulk action
string
required
ID of the space containing the entries/assets to validate
string
required
ID of the environment containing the entries/assets to validate (typically ‘master’)

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not