> ## Documentation Index > Fetch the complete documentation index at: https://docs.boxd.sh/llms.txt > Use this file to discover all available pages before exploring further. # Contentful > Contentful is a headless CMS allowing developers to create, manage, and distribute content across multiple channels and devices with an API-first approach Contentful is a headless CMS allowing developers to create, manage, and distribute content across multiple channels and devices with an API-first approach `contentful` · **124 tools** · no triggers ## Connect it ```bash theme={"theme":"github-dark"} run auth contentful run auth contentful --scope team # shared with the organization ``` Or from the [Integrations page](https://app.boxd.sh/integrations) in the console. See [Connections](/guides/integrations/connections) for personal versus shared, and who may remove one. ## Use it ```bash theme={"theme":"github-dark"} run contentful # common commands run contentful --all # every command ``` ```ts theme={"theme":"github-dark"} import { contentful } from "@boxd/run"; ``` ## Common tools | Tool | What it does | | ----------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | `activate-content-type` | Activates (publishes) a content type in Contentful. Use this to make a content type available for creating entries. | | `archive-asset` | Tool to archive an asset in Contentful. Use when you need to archive an asset to remove it from active use without deleting it permanently. | | `archive-entry` | Tool to archive an entry in Contentful. Use when you need to move an entry to archived status. | | `archive-release` | Tool to archive a release in Contentful. Use when you need to lock a release to prevent modifications. | | `create-app-definitions-keys` | Tool to generate an app signing key for a Contentful app definition. | | `create-content-type` | Tool to create a new content type in a Contentful environment. | | `create-entry-task` | Tool to create a task on a Contentful entry. Use when you need to create workflow tasks for collaboration on entries. | | `create-environment` | Tool 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. | | `create-locale` | Tool to create a new locale in a Contentful space environment. | | `create-organizations-app-def-access-grants` | Creates an access grant for an app definition to allow organizations to install the app. | | `create-organizations-app-definitions` | Tool to create a new app definition in a Contentful organization. | | `create-organizations-app-definitions-actions` | Tool 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. | | `create-organizations-invitations` | Create an invitation to an organization in Contentful (alpha feature). | | `create-organizations-security-contacts` | Creates a security contact for a specific organization. Use when you need to add an email address to receive security notifications for the organization. | | `create-organizations-taxonomy-concepts` | Tool to create a new taxonomy concept in a Contentful organization. | | `create-organizations-taxonomy-concept-schemes` | Tool to create a new taxonomy concept scheme in an organization. | | `create-release` | Tool to create a new release in Contentful. Use when you need to group entries and assets into a release for coordinated publishing or tracking. | | `create-space` | Creates a new space in Contentful. A space is a container for all content types, entries, and assets. | | `create-spaces-api-keys` | Tool to create a new Delivery API key for a Contentful space. | | `create-spaces-environments-assets` | Tool to create a new asset in a Contentful space environment. | | `create-spaces-environments-entries` | Tool to create a new entry in a Contentful space environment. | | `create-spaces-environments-entries-comments` | Tool to create a comment on an entry in Contentful. Use when you need to add a comment to a specific entry. | | `create-spaces-environments-extensions` | Tool to create a new UI extension within a Contentful space and environment. | | `create-spaces-scheduled-actions` | Tool to create a scheduled action for publishing or unpublishing entries/assets in Contentful. | | `create-webhook` | Create a new webhook in a Contentful space to receive real-time notifications about content changes. | | Tool | What it does | | -------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | `activate-content-type` | Activates (publishes) a content type in Contentful. Use this to make a content type available for creating entries. | | `archive-asset` | Tool to archive an asset in Contentful. Use when you need to archive an asset to remove it from active use without deleting it permanently. | | `archive-entry` | Tool to archive an entry in Contentful. Use when you need to move an entry to archived status. | | `archive-release` | Tool to archive a release in Contentful. Use when you need to lock a release to prevent modifications. | | `create-app-definitions-keys` | Tool to generate an app signing key for a Contentful app definition. | | `create-content-type` | Tool to create a new content type in a Contentful environment. | | `create-entry-task` | Tool to create a task on a Contentful entry. Use when you need to create workflow tasks for collaboration on entries. | | `create-environment` | Tool 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. | | `create-locale` | Tool to create a new locale in a Contentful space environment. | | `create-organizations-app-def-access-grants` | Creates an access grant for an app definition to allow organizations to install the app. | | `create-organizations-app-definitions` | Tool to create a new app definition in a Contentful organization. | | `create-organizations-app-definitions-actions` | Tool 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. | | `create-organizations-invitations` | Create an invitation to an organization in Contentful (alpha feature). | | `create-organizations-security-contacts` | Creates a security contact for a specific organization. Use when you need to add an email address to receive security notifications for the organization. | | `create-organizations-taxonomy-concepts` | Tool to create a new taxonomy concept in a Contentful organization. | | `create-organizations-taxonomy-concept-schemes` | Tool to create a new taxonomy concept scheme in an organization. | | `create-release` | Tool to create a new release in Contentful. Use when you need to group entries and assets into a release for coordinated publishing or tracking. | | `create-space` | Creates a new space in Contentful. A space is a container for all content types, entries, and assets. | | `create-spaces-api-keys` | Tool to create a new Delivery API key for a Contentful space. | | `create-spaces-environments-assets` | Tool to create a new asset in a Contentful space environment. | | `create-spaces-environments-entries` | Tool to create a new entry in a Contentful space environment. | | `create-spaces-environments-entries-comments` | Tool to create a comment on an entry in Contentful. Use when you need to add a comment to a specific entry. | | `create-spaces-environments-extensions` | Tool to create a new UI extension within a Contentful space and environment. | | `create-spaces-scheduled-actions` | Tool to create a scheduled action for publishing or unpublishing entries/assets in Contentful. | | `create-webhook` | Create a new webhook in a Contentful space to receive real-time notifications about content changes. | | `delete-asset` | Deletes an asset by ID from a Contentful environment. Use this when you need to permanently remove an asset. | | `delete-content-type` | Deletes a content type by ID from a Contentful environment. Use this when you need to permanently remove a content type. | | `delete-entry` | Deletes an entry by ID from a Contentful environment. Use this when you need to permanently remove an entry. | | `delete-environment` | Deletes an environment by ID from a Contentful space. Use this when you need to permanently remove an environment. | | `delete-extension` | Deletes an extension by ID from a Contentful environment. Use this when you need to permanently remove an extension. | | `delete-locale` | Deletes a locale by ID from a Contentful environment. Use this when you need to permanently remove a locale. | | `delete-organizations-app-def-event-subscription` | Deletes an app event subscription from a Contentful organization. | | `delete-organizations-app-definitions-details` | Tool to delete app definition details for an organization in Contentful. | | `delete-organizations-app-definitions-keys` | Tool to delete an app key from an app definition in a Contentful organization. | | `delete-organizations-app-def-signing-secret` | Tool to remove the current app signing secret from an app definition. | | `delete-organizations-security-contacts` | Deletes a security contact from a Contentful organization. Use this when you need to remove a security contact from an organization. | | `delete-release` | Deletes a release by ID from a Contentful environment. Use this when you need to permanently remove a release. | | `delete-scheduled-action` | Cancels a scheduled action by ID in Contentful. Use this when you need to cancel a scheduled publish, unpublish, or other scheduled operation. | | `delete-space-membership` | Deletes a space membership by ID from a Contentful space. Use this when you need to remove a user's access to a space. | | `delete-spaces-api-keys` | Tool to delete a single Delivery API key from a Contentful space. | | `delete-spaces-upload` | Deletes an upload by ID from a Contentful space. Use this when you need to permanently remove an upload. | | `delete-tag` | Deletes a tag by ID from a Contentful environment. Use this when you need to permanently remove a tag. | | `delete-webhook` | Deletes a webhook definition by ID from a Contentful space. Use this action when you need to permanently remove a webhook configuration. | | `get-app-bundle` | Retrieves details of a specific app bundle by its ID. Use this to get information about an app bundle including its files, metadata, and associated... | | `get-app-definition` | Tool to retrieve details of a specific app definition by its ID. | | `get-asset` | Tool to retrieve a single asset from a Contentful environment by its ID. | | `get-content-types` | Retrieves all content types in a Contentful environment. Use this to discover the structure and fields defined for different content types. | | `get-content-type-snapshot` | Tool to retrieve a snapshot of a content type by snapshot ID. | | `get-content-type-snapshots` | Tool to get all snapshots of a content type in Contentful. Use when you need to retrieve the history of changes made to a content type structure. | | `get-editor-interface` | Tool to retrieve the editor interface configuration for a content type. | | `get-entry` | Tool to retrieve a single entry from a Contentful space environment by its ID. | | `get-entry-comment` | Tool to retrieve a specific comment from an entry in Contentful. | | `get-entry-references` | Tool to retrieve references to a specific entry in Contentful. | | `get-entry-snapshots` | Tool to get all snapshots of an entry in Contentful. Use when you need to retrieve the history of changes made to an entry. | | `get-environment` | Tool to retrieve details of a specific environment by its ID within a space. | | `get-organization` | Retrieves 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. | | `get-organization-access-grant` | Retrieves the access grant status for a specific organization. | | `get-organizations` | Tool to get all organizations an account has access to in Contentful. | | `get-organizations-ai-providers` | Retrieves all AI providers configured for an organization in Contentful. | | `get-organizations-app-actions-categories` | Retrieves app action categories for a Contentful organization. | | `get-organizations-app-def-event-subscription` | Tool to retrieve details of an app event subscription by organization and app definition ID. | | `get-organizations-app-definitions` | Retrieves all app definitions for a specific organization. Use when you need to list or discover apps owned by an organization. | | `get-organizations-app-definitions-access-grants` | Get all app access grants for a specific app definition within an organization. | | `get-organizations-app-definitions-actions` | Tool to get all actions of an app definition within an organization. | | `get-organizations-app-definitions-actions2` | Tool to read a specific app action from an app definition within an organization. | | `get-organizations-app-definitions-app-bundles` | Tool to get all app bundles for a specific app definition within an organization. | | `get-organizations-app-definitions-functions` | Tool to get all functions of an app definition within an organization. | | `get-organizations-app-definitions-keys` | Tool to retrieve all app keys for a specific app definition in a Contentful organization. | | `get-organizations-app-definitions-signing-secret` | Tool to retrieve the current app signing secret for an app definition. | | `get-organizations-enablements` | Retrieves feature enablements for a specific organization in Contentful. | | `get-organizations-invitations` | Retrieves a single invitation for an organization (alpha). Use this to get details about a specific invitation including invitee information and status. | | `get-organizations-organization-periodic-usages` | Tool to get organization periodic usage statistics. Use when you need to retrieve API usage metrics for an organization during a specific time... | | `get-organizations-roles` | Retrieves all space roles in an organization. Use this to list roles that define user permissions and access levels within an organization's spaces. | | `get-organizations-security-contacts` | Retrieves security contacts for a specific organization that an admin or owner has access to. | | `get-organizations-space-enablements` | Retrieves all space enablements for a specific organization. | | `get-organizations-space-periodic-usages` | Tool to retrieve space periodic usage data for an organization. | | `get-organizations-taxonomy-concepts` | Retrieves all taxonomy concepts for an organization in Contentful. | | `get-organizations-taxonomy-concepts-ancestors` | Retrieves the list of ancestor concepts for a specific taxonomy concept. | | `get-organizations-taxonomy-concept-schemes` | Tool to retrieve all taxonomy concept schemes from an organization. | | `get-organizations-taxonomy-concept-schemes2` | Tool to retrieve a specific taxonomy concept scheme from an organization. | | `get-organizations-taxonomy-concept-schemes-total` | Retrieves the total count of taxonomy concept schemes for a specific organization. | | `get-organizations-taxonomy-concepts-total` | Retrieves the total count of taxonomy concepts for a specific organization. | | `get-release` | Tool 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. | | `get-space` | Retrieves metadata of a specific space by its ID. Returns space-level details only (name, locales, sys fields) - not entries, content types, or assets. | | `get-space-memberships` | Tool 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. | | `get-spaces-api-keys` | Tool to retrieve all Delivery API keys for a specific Contentful space. | | `get-spaces-environments` | Retrieves all environments of a space in Contentful. Use this to list all environments (including the master environment) within a specific space. | | `get-spaces-environments-app-installations` | Lists all app installations in a specific Contentful environment. | | `get-spaces-environments-assets` | Retrieves all assets from a specific environment in a Contentful space. | | `get-spaces-environments-locales` | Tool to retrieve all locales of a space environment in Contentful. | | `get-spaces-envs-app-installations-functions` | Tool to get all functions for an app installation in a Contentful environment. | | `get-users-me` | Tool to retrieve information about the currently authenticated user. | | `get-webhook` | Tool to retrieve a single webhook definition from a Contentful space. | | `get-webhook-calls` | Tool to retrieve an overview of recent webhook calls for a specific webhook in Contentful. | | `get-webhook-health` | Retrieves health status and call statistics for a specific webhook in Contentful. | | `list-entries` | Tool to retrieve all entries from a Contentful space environment. | | `list-environments` | Lists all environments of a space in Contentful, including the master environment and any custom environments. | | `list-spaces` | Lists all spaces that the authenticated user has access to in Contentful. | | `list-spaces-roles` | Tool to retrieve all roles from a Contentful space. Use this to list roles that define user permissions and access levels within a space. | | `list-webhooks` | Retrieves all webhooks configured for a Contentful space. Webhooks enable real-time notifications when content changes occur. | | `process-asset` | Tool to process an asset file in Contentful for a specific locale. | | `publish-asset` | Tool to publish an asset in Contentful, making it available via the Content Delivery API. | | `publish-entry` | Tool to publish an entry in Contentful, making it available via the Content Delivery API. | | `query-asset-collection` | Tool to retrieve multiple assets with pagination and filtering via GraphQL API. | | `query-graphql-content-type-collection` | Tool to query a collection of entries for a specific content type using GraphQL. | | `unarchive-entry` | Tool to unarchive an entry in Contentful, restoring it to active status. | | `unpublish-content-type` | Unpublishes a content type in Contentful, removing it from the Content Delivery API. | | `update-app-definition` | Tool to update an app definition by ID in a Contentful organization. | | `update-content-type` | Updates an existing content type in a Contentful environment. | | `update-editor-interface` | Tool to update the editor interface configuration for a content type. | | `update-entry` | Tool to create or update an entry in a Contentful space environment. | | `update-locale` | Updates an existing locale in a Contentful environment. Use this action when you need to modify locale properties such as name, code, fallback... | | `update-organizations-app-def-event-subscription` | Tool to update or create an app event subscription in a Contentful organization. | | `update-organizations-app-definitions-actions` | Tool to update an action for a Contentful app definition. Use when you need to modify existing action properties such as name, URL, type, or category. | | `update-organizations-app-definitions-details` | Tool to create or update app definition details for an organization in Contentful. | | `update-organizations-app-def-signing-secret` | Tool to create or overwrite the app signing secret for an app definition. | | `update-organizations-enablements` | Updates feature enablements for a specific organization in Contentful. | | `update-organizations-security-contacts` | Updates an organization security contact that an admin or owner has access to. | | `update-organizations-taxonomy-concepts` | Tool to create or update a taxonomy concept with a user-defined ID in a Contentful organization. | | `update-organizations-taxonomy-concept-schemes` | Tool to create or update a taxonomy concept scheme with a user-defined ID in an organization. | | `update-space` | Updates 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... | | `update-spaces-environments-tags` | Creates 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. | | `update-webhook` | Updates an existing webhook definition in a Contentful space. | | `validate-bulk-action` | Tool 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. | [Open Contentful in the console →](https://app.boxd.sh/integrations/detail/contentful)