Contentfulconnector v1.0 | OneTeg Documentation

Version 1.0

Connector Overview: This page documents all 229 actions for the Contentfulconnector v1.0.

Access Grant

DELETE Delete One Access Grant

/organizations/{organization_id}/app_definitions/{app_definition_id}/access_grants/{access_grant_id}

Permanently delete a specific access grant from an app definition.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Organization Id`	Identifier of the organization that owns the app definition.
`App Definition Id`	Identifier of the app definition from which to delete the access grant.
`Access Grant Id`	Identifier of the access grant to delete.
`Response Type`	The response format expected from the API (e.g. application/json).

Access Grants Collection (2)

POST Create One Access Grant

/organizations/{organization_id}/app_definitions/{app_definition_id}/access_grants

Create a new access grant for an app definition.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Organization Id`	Identifier of the organization that owns the app definition.
`App Definition Id`	Identifier of the app definition to which the access grant will be assigned.
`X-contentful-marketplace`	Marketplace context header for the request.
`Response Type`	The response format expected from the API (e.g. application/json).

Options (2)

Option Name	Description
`Granteeid`	Identifier of the grantee (user or team) receiving the access grant.
`Granteetype`	Type of the grantee, such as "user" or "team".

GET Query Access Grants of a App Definition

/organizations/{organization_id}/app_definitions/{app_definition_id}/access_grants

Retrieve a list of all access grants assigned to a specific app definition.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Organization Id`	Identifier of the organization that owns the app definition.
`App Definition Id`	Identifier of the app definition whose access grants are queried.
`Response Type`	The response format expected from the API (e.g. application/json).

Access token

GET Get a single access token

/users/me/access_tokens/{token_id}

This endpoint returns details about an existing CMA token.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Token Id`	ID of the personal access token in a form of a string
`Response Type`	The response format expected from the API (e.g. application/json).

Access tokens collection (2)

POST Create a Personal access token

/users/me/access_tokens

This endpoint allows you to create a Personal Access Token. When creating a token, you must specify at least one scope, which is used to limit a tokens access. The following scopes are supported:

content_management_read - Read-only access

content_management_manage - Read and write access

Since content_management_manage allows you to read and write, specifying

"scopes": ["content_management_manage"] is equivalent to:

"scopes": ["content_management_read", "content_management_manage"]

expiresIn – Time-to-live (TTL) of the token expressed in seconds. This is an optional field. If the field isn't passed, then TTL is not set. Therefore, the token will not auto-expire.

Note: This is the only time you will be displayed the token attribute, which contains your access token for the Content Management API. Please ensure you copy it and keep it in a safe place (e.g. outside of your source code repository, an environment variable on your server, ...)

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Response Type`	The response format expected from the API (e.g. application/json).

Options (3)

Option Name	Description
`Name`	A human-readable name for the token to help identify its purpose.
`Scopes`	List of scopes that define the token's permissions.
`Expiresin`	Number of seconds until the token expires.

GET Get all access tokens

/users/me/access_tokens

This endpoint will return all active CMA tokens, including revoked tokens. The possible types of tokens are PersonalAccessToken, CLIToken and OAuthApplication.

The following table contains all the filters (query params) available for this endpoint:

Filter |Description
-------------------|----------------------------------------------------------
sys.type[in] | Filter tokens to those matching the comma-separated list of types (e.g. sys.type[in]=PersonalAccessToken,CLIToken,OAuthApplication)
sys.expiresAt[gt] | Filter tokens by expiresAt date greater then provided value in ISO 8601 format (e.g. sys.expiresAt[gt]=2023-08-17T09:00:00)
sys.expiresAt[lt] | Filter tokens by expiresAt date less then provided value in ISO 8601 format (e.g. sys.expiresAt[lt]=2023-08-17T09:00:00)
sys.expiresAt=NULL | Filter tokens by expiresAt date equals null, it returns all tokens without an expiration date. Also works with ommited value, for example ?sys.expiresAt
sys.revokedAt[gt] | Filter tokens by revokedAt date greater then provided value in ISO 8601 format (e.g. sys.revokedAt[gt]=2023-08-17T09:00:00)
sys.revokedAt[lt] | Filter tokens by revokedAt date less then provided value in ISO 8601 format (e.g. sys.revokedAt[lt]=2023-08-17T09:00:00)
sys.revokedAt=NULL | Filter tokens by revokedAt date equals null, it returns all tokens without an expiration date. Also works with ommited value, for example ?sys.revokedAt
sys.createdAt[gt] | Filter tokens by createdAt date greater then provided value in ISO 8601 format (e.g. sys.createdAt[gt]=2023-08-17T09:00:00)
sys.createdAt[lt] | Filter tokens by createdAt date less then provided value in ISO 8601 format (e.g. sys.createdAt[lt]=2023-08-17T09:00:00)
order | Orders the query results. The available options include sys.createdAt, -sys.createdAt, sys.expiresAt and -sys.expiresAt
query | Search parameter. Search implemented by 4 last characters of the token or the name of the token (e.g. ?query=token,?query=bQrU)

More examples with date range filters:

?sys.expiresAt[gt]=${now_as_iso_date}&revokedAt=null – Returns all active tokens.

?sys.expiresAt[lt]=${now_as_iso_date}&revokedAt=null – Returns all expired tokens.

?revokedAt[lt]=${now_as_iso_date} – Returns all revoked tokens.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Response Type`	The response format expected from the API (e.g. application/json).

Activated content type collection

GET Get all activated content types of a space

/spaces/{space_id}/environments/{environment_id}/public/content_types

Retrieves the activated versions of content types, ignoring any changes made since the last activation.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Space Id`	ID of the space in form of a string
`Environment Id`	ID of the environment in form of a string
`Response Type`	The response format expected from the API (e.g. application/json).

App Action call

POST Trigger an action

/spaces/{space_id}/environments/{environment_id}/app_installations/{app_installation_id}/actions/{app_action_id}/calls

Trigger an app action call for a specific app installation in a space environment.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Space Id`	Identifier of the space containing the environment.
`Environment Id`	Identifier of the environment where the app is installed.
`App Installation Id`	Identifier of the app installation to call the action on.
`App Action Id`	Identifier of the action to trigger.
`Response Type`	The response format expected from the API (e.g. application/json).

App Action (3)

DELETE Delete an action

/organizations/{organization_id}/app_definitions/{app_definition_id}/actions/{app_action_id}

Permanently delete a specific app action from an app definition.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Organization Id`	Identifier of the organization that owns the app definition.
`App Definition Id`	Identifier of the app definition containing the action.
`App Action Id`	Identifier of the action to delete.
`Content-type`	Content type header for the request.
`Response Type`	The response format expected from the API (e.g. application/json).

GET Read an action

/organizations/{organization_id}/app_definitions/{app_definition_id}/actions/{app_action_id}

Retrieve the details of a specific app action from an app definition.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Organization Id`	Identifier of the organization that owns the app definition.
`App Definition Id`	Identifier of the app definition containing the action.
`App Action Id`	Identifier of the action to read.
`Response Type`	The response format expected from the API (e.g. application/json).

PUT Update an action

/organizations/{organization_id}/app_definitions/{app_definition_id}/actions/{app_action_id}

Update the properties of an existing app action.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Organization Id`	Identifier of the organization that owns the app definition.
`App Definition Id`	Identifier of the app definition containing the action.
`App Action Id`	Identifier of the action to update.
`Response Type`	The response format expected from the API (e.g. application/json).

Options (3)

Option Name	Description
`Name`	New name for the app action.
`Category`	New category for the app action.
`Description`	New description for the app action.

App Actions collection (2)

POST Create an action

/organizations/{organization_id}/app_definitions/{app_definition_id}/actions

Create a new app action within an app definition.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Organization Id`	Identifier of the organization that owns the app definition.
`App Definition Id`	Identifier of the app definition to which the action will be added.
`Response Type`	The response format expected from the API (e.g. application/json).

Options (3)

Option Name	Description
`Name`	Name for the new app action.
`Category`	Category for the new app action.
`Description`	Description for the new app action.

GET Get all actions of an app

/organizations/{organization_id}/app_definitions/{app_definition_id}/actions

Retrieve a list of all app actions defined for an app definition.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Organization Id`	Identifier of the organization that owns the app definition.
`App Definition Id`	Identifier of the app definition whose actions are queried.
`Content-type`	Content type header for the request.
`Response Type`	The response format expected from the API (e.g. application/json).

App Actions of Environment

GET Get all actions of an environment

/spaces/{spaceId}/environments/{externalEnvironmentId}/actions

Retrieve a list of all app actions available in a specific space environment.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Spaceid`	Identifier of the space containing the environment.
`Externalenvironmentid`	Identifier of the environment to query actions for.
`Content-type`	Content type header for the request.
`Response Type`	The response format expected from the API (e.g. application/json).

App access token

POST Issue a token for an app installation in a space environment

/spaces/{space_id}/environments/{environment_id}/app_installations/{app_definition_id}/access_tokens

Issue an access token for a specific app installation in a space environment.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Space Id`	Identifier of the space containing the environment.
`Environment Id`	Identifier of the environment where the app is installed.
`App Definition Id`	Identifier of the app definition (app installation) for which to issue the token.
`Response Type`	The response format expected from the API (e.g. application/json).

App bundle (2)

DELETE Delete an app bundle

/organizations/{organization_id}/app_definitions/{app_definition_id}/app_bundles/{app_bundle_id}

Permanently delete an app bundle. Use this action to remove an app bundle that is no longer needed.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Organization Id`	Identifier of the organization that owns the app definition.
`App Definition Id`	Identifier of the app definition (app installation) for which to issue the token.
`App Bundle Id`	The unique identifier of the app bundle to delete.
`Response Type`	The response format expected from the API (e.g. application/json).

GET Get one app bundle

/organizations/{organization_id}/app_definitions/{app_definition_id}/app_bundles/{app_bundle_id}

Retrieve details of a single app bundle by its identifier. Use this action to fetch information about a specific app bundle.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Organization Id`	Identifier of the organization that owns the app definition.
`App Definition Id`	Identifier of the app definition (app installation) for which to issue the token.
`App Bundle Id`	The unique identifier of the app bundle to retrieve.
`Response Type`	The response format expected from the API (e.g. application/json).

App bundles collection (2)

POST Create a new app bundle

/organizations/{organization_id}/app_definitions/{app_definition_id}/app_bundles

Create a new app bundle within an app definition. Use this action to add a new bundle for deployment.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Organization Id`	Identifier of the organization that owns the app definition.
`App Definition Id`	Identifier of the app definition (app installation) for which to issue the token.
`Response Type`	The response format expected from the API (e.g. application/json).

Options (1)

Option Name	Description
`Comment`	A comment describing the purpose or changes of the app bundle.

GET Get all app bundles

/organizations/{organization_id}/app_definitions/{app_definition_id}/app_bundles

Retrieve a list of all app bundles for a given app definition. Use this action to browse or search through existing bundles.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Organization Id`	Identifier of the organization that owns the app definition.
`App Definition Id`	Identifier of the app definition (app installation) for which to issue the token.
`Response Type`	The response format expected from the API (e.g. application/json).

App definition (3)

DELETE Delete an app definition

/organizations/{organization_id}/app_definitions/{app_definition_id}

Permanently delete an app definition and all its associated bundles and details. Use this action to remove an app that is no longer needed.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Organization Id`	Identifier of the organization that owns the app definition.
`App Definition Id`	Identifier of the app definition (app installation) for which to issue the token.
`Response Type`	The response format expected from the API (e.g. application/json).

GET Get one app definition

/organizations/{organization_id}/app_definitions/{app_definition_id}

Retrieve details of a single app definition by its identifier. Use this action to fetch information about a specific app.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Organization Id`	Identifier of the organization that owns the app definition.
`App Definition Id`	Identifier of the app definition (app installation) for which to issue the token.
`Response Type`	The response format expected from the API (e.g. application/json).

PUT Update an app definition

/organizations/{organization_id}/app_definitions/{app_definition_id}

Update the properties of an existing app definition. Use this action to modify the source URL or other configuration.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Organization Id`	Identifier of the organization that owns the app definition.
`App Definition Id`	Identifier of the app definition (app installation) for which to issue the token.
`Response Type`	The response format expected from the API (e.g. application/json).

Options (2)

Option Name	Description
`Name`	Name for the new app action.
`Src`	The source URL or location for the app definition.

App definitions collection (2)

POST Create a new app definition

/organizations/{organization_id}/app_definitions

Create a new app definition under an organization. Use this action to register a new app with Contentful.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Organization Id`	Identifier of the organization that owns the app definition.
`Response Type`	The response format expected from the API (e.g. application/json).

Options (2)

Option Name	Description
`Name`	Name for the new app action.
`Src`	The source URL or location for the new app definition.

GET Get all app definitions

/organizations/{organization_id}/app_definitions

Retrieve a list of all app definitions for an organization. Use this action to view or manage all registered apps.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Organization Id`	Identifier of the organization that owns the app definition.
`Response Type`	The response format expected from the API (e.g. application/json).

App details (3)

PUT Create or update app details

/organizations/{organization_id}/app_definitions/{app_definition_id}/details

Create or replace the details of an app definition. Use this action to set or update metadata for an app.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Organization Id`	Identifier of the organization that owns the app definition.
`App Definition Id`	Identifier of the app definition (app installation) for which to issue the token.
`Response Type`	The response format expected from the API (e.g. application/json).

DELETE Delete app details

/organizations/{organization_id}/app_definitions/{app_definition_id}/details

Delete the details associated with an app definition. Use this action to remove any custom metadata from the app.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Organization Id`	Identifier of the organization that owns the app definition.
`App Definition Id`	Identifier of the app definition (app installation) for which to issue the token.
`Response Type`	The response format expected from the API (e.g. application/json).

GET Get app details

/organizations/{organization_id}/app_definitions/{app_definition_id}/details

Retrieve the details of an app definition. Use this action to fetch the current metadata for an app.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Organization Id`	Identifier of the organization that owns the app definition.
`App Definition Id`	Identifier of the app definition (app installation) for which to issue the token.
`Response Type`	The response format expected from the API (e.g. application/json).

App event subscription (3)

DELETE Delete an app event subscription

/organizations/{organization_id}/app_definitions/{app_definition_id}/event_subscription

Delete the event subscription for an app definition. Use this action to stop receiving events for that app.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Organization Id`	Identifier of the organization that owns the app definition.
`App Definition Id`	Identifier of the app definition (app installation) for which to issue the token.
`Response Type`	The response format expected from the API (e.g. application/json).

GET Get an app event subscription

/organizations/{organization_id}/app_definitions/{app_definition_id}/event_subscription

Retrieve the current event subscription configuration for an app definition. Use this action to check which events are being subscribed to.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Organization Id`	Identifier of the organization that owns the app definition.
`App Definition Id`	Identifier of the app definition (app installation) for which to issue the token.
`Response Type`	The response format expected from the API (e.g. application/json).

PUT Update or subscribe to events

/organizations/{organization_id}/app_definitions/{app_definition_id}/event_subscription

Create or update the event subscription for an app definition. Use this action to configure which events to listen for and where to send them.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Organization Id`	Identifier of the organization that owns the app definition.
`App Definition Id`	Identifier of the app definition (app installation) for which to issue the token.
`Response Type`	The response format expected from the API (e.g. application/json).

Options (2)

Option Name	Description
`Targeturl`	The URL where event notifications should be sent.
`Topics`	A list of event topics to subscribe to, such as 'Entry.publish' or 'Asset.save'.

App installation (3)

GET Get one app installation

/spaces/{space_id}/environments/{environment_id}/app_installations/{app_definition_id}

Retrieve a single app installation by its app definition ID within a specific space and environment.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Space Id`	Identifier of the space containing the environment.
`Environment Id`	Identifier of the environment where the app is installed.
`App Definition Id`	Identifier of the app definition (app installation) for which to issue the token.
`Response Type`	The response format expected from the API (e.g. application/json).

PUT Install or update an app

/spaces/{space_id}/environments/{environment_id}/app_installations/{app_definition_id}

Install a new app or update an existing app installation for a given app definition, space, and environment.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Space Id`	Identifier of the space containing the environment.
`Environment Id`	Identifier of the environment where the app is installed.
`App Definition Id`	Identifier of the app definition (app installation) for which to issue the token.
`Response Type`	The response format expected from the API (e.g. application/json).

DELETE Uninstall an app

/spaces/{space_id}/environments/{environment_id}/app_installations/{app_definition_id}

Remove an app installation from a space and environment, effectively uninstalling the app.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Space Id`	Identifier of the space containing the environment.
`Environment Id`	Identifier of the environment where the app is installed.
`App Definition Id`	Identifier of the app definition (app installation) for which to issue the token.
`Response Type`	The response format expected from the API (e.g. application/json).

App installations collection

GET Get all app installations

/spaces/{space_id}/environments/{environment_id}/app_installations

Retrieve a list of all app installations within a specific space and environment.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Space Id`	Identifier of the space containing the environment.
`Environment Id`	Identifier of the environment where the app is installed.
`Response Type`	The response format expected from the API (e.g. application/json).

App installations for organization

GET Get all installations of an app within an organization

/app_definitions/{app_definition_id}/app_installations

Retrieve all installations of a specific app across organizations, with optional filtering by organization IDs.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Sys.organization.sys.id[in]`	Filter app installations by organization IDs using the 'in' operator on the organization sys.id field.
`App Definition Id`	Identifier of the app definition (app installation) for which to issue the token.
`Response Type`	The response format expected from the API (e.g. application/json).

App key (2)

DELETE Delete an app key

/organizations/{organization_id}/app_definitions/{app_definition_id}/keys/{key_kid}

Permanently delete a specific app key identified by its key ID (KID).

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Organization Id`	Identifier of the organization that owns the app definition.
`App Definition Id`	Identifier of the app definition (app installation) for which to issue the token.
`Key Kid`	The key ID (KID) of the app key to delete.
`Response Type`	The response format expected from the API (e.g. application/json).

GET Get one app key

/organizations/{organization_id}/app_definitions/{app_definition_id}/keys/{key_kid}

Retrieve a single app key by its key ID (KID).

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Organization Id`	Identifier of the organization that owns the app definition.
`App Definition Id`	Identifier of the app definition (app installation) for which to issue the token.
`Key Kid`	The key ID (KID) of the app key to retrieve.
`Response Type`	The response format expected from the API (e.g. application/json).

App keys (2)

POST Create a new app key

/organizations/{organization_id}/app_definitions/{app_definition_id}/keys

Create a new app key for a given app definition within an organization.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Organization Id`	Identifier of the organization that owns the app definition.
`App Definition Id`	Identifier of the app definition (app installation) for which to issue the token.
`Response Type`	The response format expected from the API (e.g. application/json).

GET Get all app keys

/organizations/{organization_id}/app_definitions/{app_definition_id}/keys

Retrieve a list of all app keys for a given app definition within an organization.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Organization Id`	Identifier of the organization that owns the app definition.
`App Definition Id`	Identifier of the app definition (app installation) for which to issue the token.
`Response Type`	The response format expected from the API (e.g. application/json).

App signed request

POST Create a signed request

/spaces/{space_id}/environments/{environment_id}/app_installations/{app_definition_id}/signed_requests

Generate a signed request for an app installation, used for secure communication between the app and Contentful.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Space Id`	ID of the space
`Environment Id`	ID of the environment
`App Definition Id`	ID of the app definition
`Response Type`	The response format expected from the API (e.g. application/json).

Options (3)

Option Name	Description
`Method`	The HTTP method for the signed request (e.g., GET, POST).
`Path`	The request path for the signed request.
`Body`	The request body to include in the signed request, if any.

App signing secret (3)

PUT Create or overwrite the app signing secret

/organizations/{organization_id}/app_definitions/{app_definition_id}/signing_secret

Set or replace the signing secret for an app definition, used to verify signed requests.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Organization Id`	ID of the organization
`App Definition Id`	ID of the app definition
`Response Type`	The response format expected from the API (e.g. application/json).

Options (1)

Option Name	Description
`Value`	The new signing secret value to store.

GET Get the current app signing secret

/organizations/{organization_id}/app_definitions/{app_definition_id}/signing_secret

Retrieve the current signing secret for an app definition.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Organization Id`	ID of the organization
`App Definition Id`	ID of the app definition
`Response Type`	The response format expected from the API (e.g. application/json).

DELETE Remove the current app signing secret

/organizations/{organization_id}/app_definitions/{app_definition_id}/signing_secret

Delete the current signing secret for an app definition, disabling signed request verification.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Organization Id`	ID of the organization
`App Definition Id`	ID of the app definition
`Response Type`	The response format expected from the API (e.g. application/json).

App upload

GET Get one app upload

/organizations/{organization_id}/app_uploads/{app_upload_id}

Retrieve a specific app upload by its upload ID.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Organization Id`	Identifier of the organization that owns the app definition.
`App Upload Id`	The unique identifier of the app upload to retrieve.
`Response Type`	The response format expected from the API (e.g. application/json).

App uploads collection

POST Creating an app upload

/organizations/{organization_id}/app_uploads

Initiate a new app upload for an organization, providing the upload options.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Organization Id`	Identifier of the organization that owns the app definition.
`Response Type`	The response format expected from the API (e.g. application/json).

Options (1)

Option Name	Description
`Options`	The upload options, typically a JSON object with details like file size and content type.

Archived release (2)

PUT Archive release

/spaces/{space_id}/environments/{environment_id}/releases/{release_id}/archived

Use this method to archive a release. Archiving a release will prevent publishes, unpublishes or schedules in the target release.

Permissions

Users with access to the release can archive it.

Errors

400 Error is returned in case:
The release is already archived

409 Error is returned in case:
Incorrect release version passed in the X-Contentful-Version header

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Space Id`	ID of the space in form of a string
`Environment Id`	ID of the environment in form of a string
`Release Id`	ID of the release in form of a string
`X-contentful-version`	The version of the release to archive, used for optimistic concurrency control.
`Response Type`	The response format expected from the API (e.g. application/json).

DELETE Unarchive release

/spaces/{space_id}/environments/{environment_id}/releases/{release_id}/archived

Use this method to unarchive an archived release. Unarchiving a release will enable publishing, unpublishing or scheduling in the target release.

Permissions

Users with access to the release can archive it.

Errors

400 Error is returned in case:
The release is not archived

409 Error is returned in case:
Incorrect release version passed in the X-Contentful-Version header

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Space Id`	ID of the space in form of a string
`Environment Id`	ID of the environment in form of a string
`Release Id`	ID of the release in form of a string
`X-contentful-version`	The version of the release to unarchive, used for optimistic concurrency control.
`Response Type`	The response format expected from the API (e.g. application/json).

Asset archiving (2)

PUT Archive an asset

/spaces/{space_id}/environments/{environment_id}/assets/{asset_id}/archived

Archiving an asset will remove the current asset and all previously referenced files on the CDN. It can take up to 48 hours until these files will be made unavailable from (assets|images|downloads|videos).ctfassets.net.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Space Id`	ID of the Space in form of a string
`Environment Id`	ID of the environment in form of a string
`Asset Id`	ID of the Asset in form of a string
`X-contentful-version`	The version of the asset to archive, used for optimistic concurrency control.
`Response Type`	The response format expected from the API (e.g. application/json).

DELETE Unarchive an asset

/spaces/{space_id}/environments/{environment_id}/assets/{asset_id}/archived

Unarchiving an asset will bring back the asset, the current and all previously referenced files into a draft state. It can take up to an hour for the files to be available on the CDN again.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Space Id`	ID of the Space in form of a string
`Environment Id`	ID of the environment in form of a string
`Asset Id`	ID of the Asset in form of a string
`X-contentful-version`	The version of the asset to archive, used for optimistic concurrency control.
`Response Type`	The response format expected from the API (e.g. application/json).

Asset key

POST Create an asset key

/spaces/{space_id}/environments/{environment_id}/asset_keys

To sign embargoed asset URLs, you need to create an asset key. Secure asset URLs delivered by the CDA, CMA, or CPA will have a host of (images,assets,videos,downloads).secure.ctfassets.net. They cannot be accessed without first signing the URL.

Signing an embargoed asset URL is accomplished by the following steps:

1. Create an asset key for the space the asset URL belongs to. You must specify an expiresAt value, a Unix epoch timestamp in seconds, and this can be no more than 48 hours in the future.

2. Create a JWT with the embargoed asset URL as the sub (JWT subject). Sign the JWT with the asset key's secret.

3. Affix to the original embargoed asset URL the following query parameters:

policy - the asset key's policy
token - the JWT created in step 2

4. You may affix other query parameters as well, for example when using the Images API. These do not impact the validity of the signed URL.

By default, a signed asset URL will stop functioning after the expiresAt value that was specified when creating the asset key. When generating the JWT, you may optionally specify an exp (expiry) that will cause the signed URL to be unusable at the specified expiry time. If a per-URL expiry is greater than the expiresAt value specified when creating the asset key, the asset key's expiresAt value will be used instead.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Space Id`	Alphanumeric id of the space to retrieve.
`Environment Id`	ID of the environment in form of a string.
`Response Type`	The response format expected from the API (e.g. application/json).

Options (1)

Option Name	Description
`Expiresat`	Specify the expiration timestamp for the asset key, as an integer representing seconds since epoch.

Asset processing

PUT Process an asset

/spaces/{space_id}/environments/{environment_id}/assets/{asset_id}/files/{locale_code}/process

Trigger processing of an asset file for a specific locale, useful to re-process or process newly uploaded files.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Space Id`	ID of the space in form of a string
`Environment Id`	ID of the environment in form of a string
`Asset Id`	ID of the asset in form of a string
`Locale Code`	Locale for which files should be processed
`X-contentful-version`	The version of the asset to archive, used for optimistic concurrency control.
`Response Type`	The response format expected from the API (e.g. application/json).

Asset publishing (2)

PUT Publish an asset

/spaces/{space_id}/environments/{environment_id}/assets/{asset_id}/published

After publishing the asset, it will be available via the Content Delivery API. It will also be available from our asset domain assets.ctfassets.net as specified in the fields.file.url of the asset or if it is an image, it is available from images.ctfassets.net. In this case, you can use query parameters to define the image size, cropping parameters and other options. Find out more in our Images API reference. Published assets do not need any authentication on the Images or Assets API.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Space Id`	ID of the space in form of a string
`Environment Id`	ID of the environment in form of a string
`Asset Id`	ID of the asset in form of a string
`X-contentful-version`	The version of the asset to archive, used for optimistic concurrency control.
`Response Type`	The response format expected from the API (e.g. application/json).

DELETE Unpublish an asset

/spaces/{space_id}/environments/{environment_id}/assets/{asset_id}/published

Unpublishing will put the asset back into draft state.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Space Id`	ID of the space in form of a string
`Environment Id`	ID of the environment in form of a string
`Asset Id`	ID of the asset in form of a string
`X-contentful-version`	The version of the asset to archive, used for optimistic concurrency control.
`Response Type`	The response format expected from the API (e.g. application/json).

Asset (3)

PUT Create/update an asset

/spaces/{space_id}/environments/{environment_id}/assets/{asset_id}

Use this endpoint to create a new asset with a specified ID, or update an existing asset with its ID.

Note: When updating an existing asset, you need to specify the last version you have of the asset with X-Contentful-Version.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Space Id`	ID of the Space in form of a string
`Environment Id`	ID of the environment in form of a string
`Asset Id`	ID of the Asset in form of a string
`Response Type`	The response format expected from the API (e.g. application/json).

DELETE Delete an asset

/spaces/{space_id}/environments/{environment_id}/assets/{asset_id}

Deleting an asset will remove the current asset and all previously referenced files on the CDN. It can take up to 48 hours until these files will be made unavailable from (assets|images|downloads|videos).ctfassets.net.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Space Id`	ID of the Space in form of a string
`Environment Id`	ID of the environment in form of a string
`Asset Id`	ID of the Asset in form of a string
`X-contentful-version`	The version of the asset to archive, used for optimistic concurrency control.
`Response Type`	The response format expected from the API (e.g. application/json).

GET Get a single asset

/spaces/{space_id}/environments/{environment_id}/assets/{asset_id}

Retrieve details of a single asset by its ID from a given space environment.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Space Id`	Alphanumeric id of the space to retrieve.
`Environment Id`	ID of the environment in form of a string.
`Asset Id`	Alphanumeric id of the asset to retrieve.
`Response Type`	The response format expected from the API (e.g. application/json).

Assets collection (2)

POST Create an asset

/spaces/{space_id}/environments/{environment_id}/assets

When using this endpoint, an ID will be automatically generated for the created asset and returned with the response.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Space Id`	ID of the space in form of a string
`Environment Id`	ID of the environment in form of a string
`Response Type`	The response format expected from the API (e.g. application/json).

GET Get all assets of a space

/spaces/{space_id}/environments/{environment_id}/assets

Fetch a list of all assets in a space environment.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Space Id`	Alphanumeric id of the space to retrieve.
`Environment Id`	ID of the environment in form of a string.
`Response Type`	The response format expected from the API (e.g. application/json).

Assigned Tasks collection

GET Get all tasks that are assigned to you

/spaces/{space_id}/environments/{environment_id}/tasks

Use this endpoint to get all the tasks that are assigned to you. This API does offer
pagination, calls to it will return a paginated list containing the tasks that are assigned to you and your team.

It is important to note that this endpoint expects the query parameter filter=myPendingTasks. A call without this parameter will return a 501 status code.

Permissions

Any user with read access to entries in the given space-environment can call this endpoint.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Filter`	Provide a filter string to narrow down tasks by criteria such as status or assignee.
`Space Id`	ID of the space in form of a string
`Environment Id`	ID of the environment in form of a string string
`Response Type`	The response format expected from the API (e.g. application/json).

Bulk action

GET Fetch bulk action

/spaces/{space_id}/environments/{environment_id}/bulk_actions/actions/{bulk_action_id}

Use this method to fetch the bulk action by id.

Permissions

Only the user that created the bulk action or a user with the Admin role can view bulk actions.

Retention

Bulk action records are retained for 7 days.

Errors

404 Error is returned in case:
The bulk action is not found
The space is not found
The current user is not allowed to see the bulk action

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Space Id`	ID of the space as a string
`Environment Id`	ID of the environment as a string, falls back to master if not specified.
`Bulk Action Id`	ID of the bulk action as a string
`Response Type`	The response format expected from the API (e.g. application/json).

Cancel a scheduled action

DELETE Cancel a scheduled action

/spaces/{space_id}/scheduled_actions/{scheduled_action_id}

Use this method to mark a scheduled action as canceled.

Permissions

Any user with publish access to an entry can set a scheduled action to canceled state.

Errors

400 Error is returned in case:
The sys.status is not in a scheduled state

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Environment.sys.id`	Specify the environment system ID to identify which environment the scheduled action belongs to.
`Space Id`	ID of the space in form of a string
`Scheduled Action Id`	ID of the scheduled action in form of a string
`Response Type`	The response format expected from the API (e.g. application/json).

Comment (3)

DELETE Delete a comment

/spaces/{space_id}/environments/{environment_id}/entries/{entry_id}/comments/:comment_id

Use this method to delete a comment.

Permissions

Comment creators can delete their own comments. Admins can delete any comment on any
entry.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Space Id`	ID of the space in form of a string
`Environment Id`	ID of the environment in form of a string
`Entry Id`	ID of the entry in form of a string
`X-contentful-version`	The version of the asset to archive, used for optimistic concurrency control.
`Response Type`	The response format expected from the API (e.g. application/json).

GET Get a single comment

/spaces/{space_id}/environments/{environment_id}/entries/{entry_id}/comments/:comment_id

Use this endpoint to fetch a comment with a specified ID.

Permissions

Any user with read access to an entry can read a comment in the entry. Space admins
can read any comment in any entry.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Space Id`	ID of the space in form of a string
`Environment Id`	ID of the environment in form of a string
`Entry Id`	ID of the entry in form of a string
`Response Type`	The response format expected from the API (e.g. application/json).

PUT Update a comment

/spaces/{space_id}/environments/{environment_id}/entries/{entry_id}/comments/:comment_id

Use this method to modify the body of the comment.

Permissions

The creator or an admin can update the comment.

Errors

An 403 - AccessDenied error is returned if a user different from the comment creator or an admin changed the comment body.

A 422 - ValidationFailed error is returned if the body field has a value bigger than 512 bytes.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Space Id`	ID of the space in form of a string
`Environment Id`	ID of the environment in form of a string
`Entry Id`	ID of the entry in form of a string
`X-contentful-version`	The version of the asset to archive, used for optimistic concurrency control.
`Response Type`	The response format expected from the API (e.g. application/json).

Options (1)

Option Name	Description
`Body`	The request body to include in the signed request, if any.

Content Type Snapshot

GET Get a snapshot of a content type

/spaces/{space_id}/environments/master/content_types/{content_type_id}/snapshots/{snapshot_id}

Retrieve a specific snapshot of a content type, capturing its state at a point in time.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Space Id`	ID of the Space in form of a string
`Content Type Id`	ID of the entry in form of a string
`Snapshot Id`	ID of the snapshot in form of a string
`Response Type`	The response format expected from the API (e.g. application/json).

Content Type Snapshots collection

GET Get all snapshots of a content type

/spaces/{space_id}/environments/master/content_types/{content_type_id}/snapshots

List all snapshots taken of a particular content type.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Space Id`	ID of the Space in form of a string
`Content Type Id`	ID of the content type in form of a string
`Response Type`	The response format expected from the API (e.g. application/json).

Content model

GET Get the content model of a space

/spaces/{space_id}/environments/{environment_id}/content_types

Retrieve the full content model (all content types) for a space environment.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Space Id`	ID of the space in form of a string
`Environment Id`	ID of the environment in form of a string
`Response Type`	The response format expected from the API (e.g. application/json).

Content type activation (2)

PUT Activate a content type

/spaces/{space_id}/environments/{environment_id}/content_types/{content_type_id}/published

Publish (activate) a content type so it becomes available for use in the environment.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Space Id`	ID of the space in form of a string
`Environment Id`	ID of the environment in form of a string
`Content Type Id`	ID of the content type in form of a string
`X-contentful-version`	The version of the asset to archive, used for optimistic concurrency control.
`Response Type`	The response format expected from the API (e.g. application/json).

DELETE Deactivate a content type

/spaces/{space_id}/environments/{environment_id}/content_types/{content_type_id}/published

Unpublish (deactivate) a content type to make it unavailable in the environment.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Space Id`	ID of the space in form of a string
`Environment Id`	ID of the environment in form of a string
`Content Type Id`	ID of the content type in form of a string
`Response Type`	The response format expected from the API (e.g. application/json).

Content type collection

POST Create a content type with POST

/spaces/{space_id}/environments/{environment_id}/content_types

Whilst it's possible to create content types with `POST`, it's strongly discouraged.

When you use this endpoint, the API will automatically generate an ID for the created content type and return it with the response.

Using the method outlined below allows you to control the ID of the created content type. This is important for content type IDs as they are often used as parameters in code.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Space Id`	ID of the Space in form of a string
`Environment Id`	ID of the environment in form of a string
`Response Type`	The response format expected from the API (e.g. application/json).

Options (1)

Option Name	Description
`Name`	Name for the new app action.

Content type (4)

PUT Create a content type with PUT

/spaces/{space_id}/environments/{environment_id}/content_types/{content_type_id}

Create or update a content type by its ID using a PUT request, providing the full content type definition in the request body.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Space Id`	ID of the Space in form of a string
`Environment Id`	ID of the environment in form of a string
`Content Type Id`	ID of the Content Type in form of a string
`Response Type`	The response format expected from the API (e.g. application/json).

Options (1)

Option Name	Description
`Name`	Name for the new app action.

DELETE Delete a content type

/spaces/{space_id}/environments/{environment_id}/content_types/{content_type_id}

_Before you can delete a content type you need to deactivate it_.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Space Id`	ID of the Space in form of a string
`Environment Id`	ID of the environment in form of a string
`Content Type Id`	ID of the Content Type in form of a string
`Response Type`	The response format expected from the API (e.g. application/json).

GET Get a single content type

/spaces/{space_id}/environments/{environment_id}/content_types/{content_type_id}

Retrieve a single content type by its ID from a space environment.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Space Id`	ID of the space in form of a string
`Environment Id`	ID of the environment in form of a string
`Content Type Id`	ID of the content type in form of a string
`Response Type`	The response format expected from the API (e.g. application/json).

GET Query entries

/spaces/{space_id}/environments/{environment_id}/entries

This example finds all entries of content type 'Product'.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Content Type`	Specify the content type ID to filter entries belonging to that content type.
`Space Id`	Alphanumeric id of the space to retrieve.
`Environment Id`	ID of the environment in form of a string
`Response Type`	The response format expected from the API (e.g. application/json).

Create a scheduled action

POST Create a scheduled action

/spaces/{space_id}/scheduled_actions

Use this endpoint to create a new scheduled action. When using this endpoint, an ID will be automatically generated for the created scheduled action and returned in the response.

There's a limit of 200 scheduled actions in pending status per environment. An attempt to create more than 200 pending scheduled actions will result in an error.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Space Id`	ID of the space in form of a string
`Response Type`	The response format expected from the API (e.g. application/json).

Options (1)

Option Name	Description
`Action`	Provide the action type to schedule, e.g., 'publish' or 'unpublish'.

Create an environment template

POST Create an environment template

/organizations/{organization_id}/environment_templates

Create a new environment template in the organization to define a reusable environment configuration.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Organization Id`	The ID of the organization. Alphanumerical.
`Response Type`	The response format expected from the API (e.g. application/json).

Options (4)

Option Name	Description
`Name`	Name for the new app action.
`Description`	Description for the new app action.
`Versionname`	Assign a name to the template version.
`Versiondescription`	Provide a description for the template version.

Create the field type in a content type

POST Create the field type in a content type

/spaces/yadj1kx9rmg0/environments/master/content_types

Add a new field type to a content type in the master environment of the specified space.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Response Type`	The response format expected from the API (e.g. application/json).

Create the field values in entries

POST Create the field values in entries

/spaces/yadj1kx9rmg0(/environments/master)/entries

Create a new entry with field values in the master environment of the specified space.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Response Type`	The response format expected from the API (e.g. application/json).

Delete an environment template

DELETE Delete an environment template

/organizations/{organization_id}/environment_templates/{template_id}

Permanently delete an environment template from the organization. Use when you no longer need a reusable environment template.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Organization Id`	The ID of the organization. Alphanumerical.
`Template Id`	The ID of the template. Alphanumerical.
`Response Type`	The response format expected from the API (e.g. application/json).

Deleting an upload

DELETE Delete an upload

/spaces/{space_id}/uploads/{upload_id}

Permanently delete an uploaded file from the space. Provide the ID of the upload to remove it.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Space Id`	Identifier of the space containing the environment.
`Upload Id`	The unique identifier of the upload to delete.
`Response Type`	The response format expected from the API (e.g. application/json).

Delivery API key (3)

DELETE Delete a single Delivery API key

/spaces/{space_id}/api_keys/{api_key_id}

This endpoint allows you to delete a Delivery API key and its corresponding Preview API key.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Space Id`	ID of the space in a form of a string
`Api Key Id`	ID of the Delivery API key in a form of a string
`Response Type`	The response format expected from the API (e.g. application/json).

GET Get a single Delivery API key

/spaces/{space_id}/api_keys/{api_key_id}

This endpoint returns details about an existing Delivery API key.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Space Id`	ID of the space in a form of a string
`Api Key Id`	ID of the Delivery API key in a form of a string
`Response Type`	The response format expected from the API (e.g. application/json).

PUT Update a single Delivery API key

/spaces/{space_id}/api_keys/{api_key_id}

This endpoint allows you to update a Delivery API key and its corresponding Preview API key.

Note: When updating an existing API key, you need to specify the last version you have of the API key with X-Contentful-Version.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Space Id`	ID of the space in a form of a string
`Api Key Id`	ID of the Delivery API key in a form of a string
`X-contentful-version`	The version of the asset to archive, used for optimistic concurrency control.
`Response Type`	The response format expected from the API (e.g. application/json).

Options (1)

Option Name	Description
`Name`	Name for the new app action.

Delivery API keys collection (2)

POST Create a Delivery API key

/spaces/{space_id}/api_keys

This endpoint allows you to create a Delivery API key and its corresponding Preview API key.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Space Id`	ID of the space in form of a string
`Response Type`	The response format expected from the API (e.g. application/json).

Options (1)

Option Name	Description
`Name`	Name for the new app action.

GET Get all Delivery API keys

/spaces/{space_id}/api_keys

Retrieve a list of all Delivery API keys for the space.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Space Id`	ID of the space in form of a string
`Response Type`	The response format expected from the API (e.g. application/json).

Editor interface collection

GET Get all editor interfaces of a space

/spaces/{space_id}/environments/{environment_id}/editor_interfaces

Retrieve all editor interfaces available in the specified environment.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Space Id`	ID of the Space in form of a string
`Environment Id`	ID of the environment in form of a string
`Response Type`	The response format expected from the API (e.g. application/json).

Editor interface (2)

GET Get the editor interface

/spaces/{space_id}/environments/{environment_id}/content_types/{content_type_id}/editor_interface

Get the editor interface configuration for a specific content type.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Space Id`	ID of the space in form of a string
`Environment Id`	ID of the environment in form of a string
`Content Type Id`	ID of the content type in form of a string
`Response Type`	The response format expected from the API (e.g. application/json).

PUT Update the editor interface

/spaces/{space_id}/environments/{environment_id}/content_types/{content_type_id}/editor_interface

You can use this endpoint to update an existing editor interface. You will need to specify its last version with X-Contentful-Version.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Space Id`	ID of the space in form of a string
`Environment Id`	ID of the environment in form of a string
`Content Type Id`	ID of the content type in form of a string
`Response Type`	The response format expected from the API (e.g. application/json).

Entries collection

POST Create an entry

/spaces/{space_id}/environments/{environment_id}/entries

Before you can create an entry you need to create and activate a content type as outlined above.

When creating a new entry, you need to pass the ID of the desired content type as the X-Contentful-Content-Type header and pass the field data as a JSON payload.

When using this endpoint, an ID will be automatically generated for the created entry and returned in the response.

If default values are set for some field of the content type, they will be applied at entry creation,
if the corresponding field isn't provided in the request body. Default values don't affect entry updates.

Note:
New entries are created as drafts. To make new content entries available via the CDA, create and publish them.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Space Id`	ID of the space in form of a string
`Environment Id`	ID of the environment in form of a string
`X-contentful-content-type`	The content type identifier for the new entry, sent as a header.
`Response Type`	The response format expected from the API (e.g. application/json).

Entry Snapshot

GET Get a snapshot of an entry

/spaces/{space_id}/environments/master/entries/{entry_id}/snapshots/{snapshot_id}

Retrieve a specific snapshot of an entry by its ID.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Space Id`	ID of the Space in form of a string
`Entry Id`	ID of the entry in form of a string
`Snapshot Id`	ID of the snapshot in form of a string
`Response Type`	The response format expected from the API (e.g. application/json).

Entry Snapshots collection

GET Get all snapshots of an entry

/spaces/{space_id}/environments/master/entries/{entry_id}/snapshots

Get all snapshots of a specific entry.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Space Id`	ID of the Space in form of a string
`Entry Id`	ID of the entry in form of a string
`Response Type`	The response format expected from the API (e.g. application/json).

Entry Tasks collection (2)

POST Create a task

/spaces/{space_id}/environments/{environment_id}/entries/{entry_id}/tasks

Use this endpoint to create a new task. When using this endpoint, an ID will be
automatically generated for the created task and returned in the response.

There's a limit of 100 tasks per entry. An attempt to create more than 100 tasks
will result in an error.

Permissions

Any user with read access to an entry can create tasks in the entry. Space
admins can create tasks on any entry.

The API does not check if the task assignee has read access to the
entry where the task exists. If task assignees do not have read access to the
entry they won't be able to resolve them.

Notifications

When a task is created an email is sent to the task assignee to let them know
that a task has been assigned to them. If the task is assigned to a team, every user
in that team receives an email.

If a due date is specified for a task, a reminder mail will be sent out two
days before this date.

Errors

A 400 - BadRequest error is returned if there's an attempt to create more than 100

tasks in one entry.

A 422 - ValidationFailed error is returned if:
The body field has a value bigger than 512 bytes
The status field has a value different to active or resolved

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Space Id`	ID of the space in form of a string
`Environment Id`	ID of the environment in form of a string
`Entry Id`	ID of the entry in form of a string
`Response Type`	The response format expected from the API (e.g. application/json).

Options (2)

Option Name	Description
`Body`	The request body to include in the signed request, if any.
`Status`	The initial status of the task (e.g., 'active' or 'completed').

GET Get all tasks of an entry

/spaces/{space_id}/environments/{environment_id}/entries/{entry_id}/tasks

Use this endpoint to get all the tasks of an entry. This API does offer
pagination, calls to it will return a paginated list with tasks for that entry.

Permissions

Any user with read access to an entry can read all the tasks in the entry. Space
admins can read all the tasks in any entry.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Space Id`	ID of the space in form of a string
`Environment Id`	ID of the environment in form of a string
`Entry Id`	ID of the entry in form of a string
`Response Type`	The response format expected from the API (e.g. application/json).

Entry archiving (2)

PUT Archive an entry

/spaces/{space_id}/environments/{environment_id}/entries/{entry_id}/archived

Archive an entry to hide it from normal queries.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Space Id`	ID of the space in form of a string
`Environment Id`	ID of the environment in form of a string
`Entry Id`	ID of the entry in form of a string
`X-contentful-version`	The version of the asset to archive, used for optimistic concurrency control.
`Response Type`	The response format expected from the API (e.g. application/json).

DELETE Unarchive an entry

/spaces/{space_id}/environments/{environment_id}/entries/{entry_id}/archived

Unarchive a previously archived entry to make it visible again.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Space Id`	ID of the space in form of a string
`Environment Id`	ID of the environment in form of a string
`Entry Id`	ID of the entry in form of a string
`X-contentful-version`	The version of the asset to archive, used for optimistic concurrency control.
`Response Type`	The response format expected from the API (e.g. application/json).

Entry comments collection (2)

POST Create a comment

/spaces/{space_id}/environments/{environment_id}/entries/{entry_id}/comments

Use this endpoint to create a new comment. When using this endpoint, an ID will be
automatically generated for the created comment and returned in the response.
If you want to create a reply to a specific comment, you need to set the header X-Contentful-Parent-Id with the comment ID you want to reply to.

To reference a specific field and locale with your comment, you can set the header X-Contentful-Parent-Entity-Reference. Only values specifying a path to a field and locale of the entry are considered valid, therefore the value must match the pattern fields.<field_id>.<locale_code>.

There's a limit of 100 comments per entry. An attempt to create more than 100 comments
will result in an error.

Permissions

Any user with read access to an entry can create comments in the entry. Space
admins can create comments on any entry.

Errors

A 400 - BadRequest error is returned if there's an attempt to create more than 100

comments in one entry.

A 422 - ValidationFailed error is returned if the body field has a value bigger than 512 bytes.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Space Id`	ID of the space in form of a string
`Environment Id`	ID of the environment in form of a string
`Entry Id`	ID of the entry in form of a string
`X-contentful-parent-id`	The ID of the parent comment or entity to nest this comment under.
`X-contentful-parent-entity-reference`	The entity reference type of the parent (e.g., 'Comment' or 'Entry').
`Response Type`	The response format expected from the API (e.g. application/json).

Options (1)

Option Name	Description
`Body`	The request body to include in the signed request, if any.

GET Get all comments of an entry

/spaces/{space_id}/environments/{environment_id}/entries/{entry_id}/comments

Use this endpoint to get all the comments of an entry. This API does not offer
pagination, calls to it will return all the existing comments.

Permissions

Any user with read access to an entry can read all the comments in the entry. Space
admins can read all the comments in any entry.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Space Id`	ID of the space in form of a string
`Environment Id`	ID of the environment in form of a string
`Entry Id`	ID of the entry in form of a string
`Response Type`	The response format expected from the API (e.g. application/json).

Entry publishing (2)

PUT Publish an entry

/spaces/{space_id}/environments/{environment_id}/entries/{entry_id}/published

Publish an entry to make it available in the delivery environment.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Space Id`	ID of the space in form of a string
`Environment Id`	ID of the environment in form of a string
`Entry Id`	ID of the entry in form of a string
`X-contentful-version`	The version of the asset to archive, used for optimistic concurrency control.
`Response Type`	The response format expected from the API (e.g. application/json).

DELETE Unpublish an entry

/spaces/{space_id}/environments/{environment_id}/entries/{entry_id}/published

Unpublish a previously published entry to remove it from the delivery environment.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Space Id`	ID of the space in form of a string
`Environment Id`	ID of the environment in form of a string
`Entry Id`	ID of the entry in form of a string
`X-contentful-version`	The version of the asset to archive, used for optimistic concurrency control.
`Response Type`	The response format expected from the API (e.g. application/json).

Entry references

GET Get entry references

/spaces/{space_id}/environments/{environment_id}/entries/{entry_id}/references

Retrieve all references (links) from the entry to other entries. Optionally set the include parameter to specify the number of nested reference levels to resolve.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Include`	The number of levels of nested references to include in the response.
`Space Id`	ID of the space in form of a string
`Environment Id`	ID of the environment in form of a string
`Entry Id`	ID of the entry in form of a string
`Response Type`	The response format expected from the API (e.g. application/json).

Entry (4)

PUT Create an entry

/spaces/{space_id}/environments/{environment_id}/entries/{entry_id}

Use this endpoint to create a new entry with a specified ID. When creating a new entry, you need to pass the ID of the entry's desired content type as the X-Contentful-Content-Type header.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Space Id`	ID of the space in form of a string
`Environment Id`	ID of the environment in form of a string
`Entry Id`	ID of the entry in form of a string
`X-contentful-content-type`	The content type identifier for the entry, sent as a header.
`Response Type`	The response format expected from the API (e.g. application/json).

DELETE Delete an entry

/spaces/{space_id}/environments/{environment_id}/entries/{entry_id}

Permanently delete an entry from the environment.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Space Id`	ID of the space in form of a string
`Environment Id`	ID of the environment in form of a string
`Entry Id`	ID of the entry in form of a string
`X-contentful-version`	The version of the asset to archive, used for optimistic concurrency control.
`Response Type`	The response format expected from the API (e.g. application/json).

GET Get a single entry

/spaces/{space_id}/environments/{environment_id}/entries/{entry_id}

Retrieve a specific entry by its ID.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Space Id`	Alphanumeric id of the space to retrieve.
`Environment Id`	ID of the environment in form of a string
`Entry Id`	Alphanumeric id of the entry to retrieve
`Response Type`	The response format expected from the API (e.g. application/json).

PATCH Patch an entry

/spaces/{space_id}/environments/{environment_id}/entries/{entry_id}

Use this endpoint to update a specific entry via its ID using JSON Patch format. When patching an entry, you need to specify the current version of the entry you are updating with X-Contentful-Version.

Note: JSON Patch cannot perform operations on non-existing fields. If the field is defined on the Content Type but has not been set on the Entry yet, the API will return a validation error when you try to perform an operation on this field.
The accepted workaround is to pass the entire sub-object to the top-most existing field, including locale and initial value.

JavaScript

// may result in the validation error if `description` field is undefined:
[{"op": "add", "path": "/fields/description/en-US", "value": "initial value"}]

// if `description` field is not defined on Entry, but defined in the Content Type, make sure to provide the locale in the payload:
[{"op": "add", "path": "/fields/description", "value": {"en-US": "initial value"}}]

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Space Id`	ID of the space in form of a string
`Environment Id`	ID of the environment in form of a string
`Entry Id`	ID of the entry in form of a string
`X-contentful-version`	The version of the asset to archive, used for optimistic concurrency control.
`Response Type`	The response format expected from the API (e.g. application/json).

Options (3)

Option Name	Description
`Op`	The JSON Patch operation to perform (e.g., 'add', 'remove', 'replace').
`Path`	The JSON pointer path indicating the field to modify.
`Value`	The new value to apply for the given operation and path.

Environment alias collection

GET Get all environment aliases of a space

/spaces/{space_id}/environment_aliases

Get all environment aliases defined in the space.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Space Id`	ID of the space in form of a string
`Response Type`	The response format expected from the API (e.g. application/json).

Environment alias (3)

PUT Create/Update an environment alias

/spaces/{space_id}/environment_aliases/{environment_alias_id}

Use this endpoint to create a new environment alias or change the environment which the environment alias references.

Note that when updating an environment alias, the following headers need to be specified:

X-Contentful-Version, you need to specify the last version of the environment alias you are updating with

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Space Id`	ID of the space in the form of a string
`Environment Alias Id`	ID of the environment alias in form of a string
`X-contentful-version`	The version of the asset to archive, used for optimistic concurrency control.
`Response Type`	The response format expected from the API (e.g. application/json).

DELETE Delete an environment alias

/spaces/{space_id}/environment_aliases/{environment_alias_id}

Note: You can never delete the master environment alias.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Space Id`	ID of the space in the form of a string
`Environment Alias Id`	ID of the environment alias in form of a string
`Response Type`	The response format expected from the API (e.g. application/json).

GET Get a single environment alias

/spaces/{space_id}/environment_aliases/{environment_alias_id}

Retrieve a specific environment alias by its ID.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Space Id`	ID of the space in the form of a string
`Environment Alias Id`	ID of the environment alias in form of a string
`Response Type`	The response format expected from the API (e.g. application/json).

Environment collection (2)

POST Create an environment

/spaces/{space_id}/environments

Create an environment with an auto-generated sys.id.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Space Id`	ID of the space in form of a string
`Response Type`	The response format expected from the API (e.g. application/json).

Options (1)

Option Name	Description
`Name`	Name for the new app action.

GET Get all environments of a space

/spaces/{space_id}/environments

Retrieve a list of all environments associated with a specific space.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Space Id`	ID of the space in form of a string
`Response Type`	The response format expected from the API (e.g. application/json).

Environment templates

GET Get all environment templates

/organizations/{organization_id}/environment_templates

Retrieve a list of all environment templates available in an organization.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Organization Id`	The ID of the organization. Alphanumerical.
`Response Type`	The response format expected from the API (e.g. application/json).

Environment (3)

PUT Create an environment with ID

/spaces/{space_id}/environments/{environment_id}

Create a new environment with a specified ID within a space.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Space Id`	ID of the space in the form of a string
`Environment Id`	ID of the environment in form of a string
`Response Type`	The response format expected from the API (e.g. application/json).

Options (1)

Option Name	Description
`Name`	Name for the new app action.

DELETE Delete an environment

/spaces/{space_id}/environments/{environment_id}

Permanently delete an environment from a space.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Space Id`	ID of the space in the form of a string
`Environment Id`	ID of the environment in form of a string
`Response Type`	The response format expected from the API (e.g. application/json).

GET Get a single environment

/spaces/{space_id}/environments/{environment_id}

Retrieve details of a single environment by its ID within a space.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Space Id`	ID of the space in the form of a string
`Environment Id`	ID of the environment in form of a string
`Response Type`	The response format expected from the API (e.g. application/json).

Extension (3)

PUT Create/update an extension

/spaces/{space_id}/environments/{environment_id}/extensions/{extension_id}

Create a new extension or update an existing one within a space environment.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Space Id`	ID of the space in form of a string
`Environment Id`	ID of the environment in form of a string
`Extension Id`	ID of the extension in form of a string
`Response Type`	The response format expected from the API (e.g. application/json).

DELETE Delete an extension

/spaces/{space_id}/environments/{environment_id}/extensions/{extension_id}

Permanently delete an extension from a space environment.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Space Id`	ID of the space in form of a string
`Environment Id`	ID of the environment in form of a string
`Extension Id`	ID of the extension in form of a string
`X-contentful-version`	The version of the asset to archive, used for optimistic concurrency control.
`Response Type`	The response format expected from the API (e.g. application/json).

GET Get a single extension

/spaces/{space_id}/environments/{environment_id}/extensions/{extension_id}

Retrieve details of a single extension by its ID within a space environment.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Space Id`	ID of the space in form of a string
`Environment Id`	ID of the environment in form of a string
`Extension Id`	ID of the extension in form of a string
`Content-type`	Content type header for the request.
`Response Type`	The response format expected from the API (e.g. application/json).

Extensions collection (2)

POST Create an extension

/spaces/{space_id}/environments/{environment_id}/extensions

Create a new extension within a space environment.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Space Id`	ID of the space in form of a string
`Environment Id`	ID of the environment in form of a string
`Response Type`	The response format expected from the API (e.g. application/json).

GET Get all extensions of a space

/spaces/{space_id}/environments/{environment_id}/extensions

Retrieve a list of all extensions in a space environment.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Space Id`	ID of the space in form of a string
`Environment Id`	ID of the environment in form of a string
`Content-type`	Content type header for the request.
`Response Type`	The response format expected from the API (e.g. application/json).

Get a Scheduled Action

GET Get a scheduled action

/spaces/{space_id}/scheduled_actions/{scheduled_action_id}

Use this method to fetch a single Scheduled Action.

Permissions

Any user with read access to the supported entities can fetch a given Scheduled Action.

Errors

404 Error is returned in case:
The sys.id is not found
Current user doesn't have access to space
User doesn't have permissions to read the entity (Release, Entry or Asset) in the Scheduled Action

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Environment.sys.id`	Specify the environment system ID to identify which environment the scheduled action belongs to.
`Space Id`	ID of the space in form of a string
`Scheduled Action Id`	ID of the scheduled action in form of a string
`Response Type`	The response format expected from the API (e.g. application/json).

Get all app action categories

GET Get app action categories

/organizations/{orgId}/app_actions_categories

Retrieve a list of all app action categories for an organization.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Orgid`	The unique identifier of the organization whose app action categories you want to retrieve.
`Content-type`	Content type header for the request.
`Response Type`	The response format expected from the API (e.g. application/json).

Get all space enablements for an organization

GET Get all enablements for an organization

/organizations/0D9ZC8rLWiw6x5qizZGiRs/space_enablements

This endpoint allows you to get all the enablements in your spaces across your organization.

Note: If you request an enablements document for a space that does not have one already, a default with all items set to false will be created.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Content-type`	Content type header for the request.
`Response Type`	The response format expected from the API (e.g. application/json).

Group (3)

DELETE Delete a single group

/scim/v2/organizations/:org_id/Groups/{groupId}

Use this endpoint to remove a team from your organization. Removing a team from your organization will in addition remove its team memberships. Any team space memberships associated with the team will also be removed.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Groupid`	ID of the Contentful team
`Content-type`	Content type header for the request.
`Response Type`	The response format expected from the API (e.g. application/json).

GET Get a single group

/scim/v2/organizations/:org_id/Groups/{groupId}

Retrieve details of a single group by its ID within an organization.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Groupid`	ID of the Contentful team
`Content-type`	Content type header for the request.
`Response Type`	The response format expected from the API (e.g. application/json).

PATCH Update a single group

/scim/v2/organizations/:org_id/Groups/{groupId}

Use this endpoint to add, remove or replace team members.

Update request should contain the attribute Operations with a list of items of the following format:

Property | Required | Type | Description
----------|-----------|-------|------------
op | yes | String | One of add, remove or replace
path | yes | String | The affected attribute. Currently, the only accepted value is members
value | yes if adding or replacing members | Array | Currently, the only accepted value is a list of user references

User references have the following structure:

Property | Required | Type | Description
---------|----------|------|------------
display| true | String | An identifier for the team member. It's normally the full name
value | true | String | The user ID

For example, to add a new user to a group we would send the following request payload:

JavaScript

{
  "schemas": [
    "urn:ietf:params:scim:api:messages:2.0:PatchOp"
  ],
  "Operations": [
    {
      "op": "add",
      "path": "members",
      "value": [
        {
          "display": "Kasia Kowalska",
          "value": "1xGZIRXr2WPnsLkKfREo0z"
        }
      ]
    }
  ]
}

It is also possible to run multiple different operations.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Groupid`	ID of the Contentful team
`Response Type`	The response format expected from the API (e.g. application/json).

Options (1)

Option Name	Description
`Schemas`	A list of schema URIs that define the structure of the group update request.

Groups collection (2)

POST Create a group

/scim/v2/organizations/{org_id}/Groups

Create a new group within an organization.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Org Id`	The unique identifier of the organization where the group will be created.
`Response Type`	The response format expected from the API (e.g. application/json).

Options (2)

Option Name	Description
`Schemas`	A list of schema URIs that define the structure of the group creation request.
`Displayname`	A human-readable name for the group.

GET Get all groups in the organization

/scim/v2/organizations/{org_id}/Groups

It is possible to filter by the displayName eq filter, passing a valid group name as the value. See the Filtering section in the SCIM 2.0 specification for details.

GET /Groups?filter=displayName eq "My Group"

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Org Id`	The unique identifier of the organization whose groups you want to list.
`Content-type`	Content type header for the request.
`Response Type`	The response format expected from the API (e.g. application/json).

Image

GET Retrieve an image

/{space_id}/{asset_id}/{unique_id}/{name}

Retrieve an image asset by its space, asset ID, unique identifier, and filename.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Space Id`	Alphanumeric id of the space to retrieve.
`Asset Id`	Alphanumeric id of the asset to which the image belongs.
`Unique Id`	Alphanumeric unique id identifying the image.
`Name`	The original file name of the image.
`Response Type`	The response format expected from the API (e.g. application/json).

Initial synchronization

GET Query entries

/spaces/{space_id}/sync

Perform an initial synchronization of entries from a space.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Initial`	Set to true to perform an initial sync that retrieves all entries.
`Type`	The type of content to sync, such as 'Entry' or 'Asset'.
`Limit`	The maximum number of records to return in the sync response.
`Space Id`	Alphanumeric id of the Space to retrieve.
`Response Type`	The response format expected from the API (e.g. application/json).

Install a template in the environment

POST Install a template in the environment

/spaces/{space_id}/environments/{environment_id}/template_installations/{template_id}/versions

Install a specific version of a template into a space environment.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Space Id`	The ID of the space. Alphanumerical.
`Environment Id`	The ID of the environment.
`Template Id`	The ID of the template. Alphanumerical.
`Response Type`	The response format expected from the API (e.g. application/json).

Locale collection (2)

POST Create a locale

/spaces/{space_id}/environments/{environment_id}/locales

Use this endpoint to create a new locale for the specified space. You cannot create two locales with the same locale code.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Space Id`	ID of the space in form of a string
`Environment Id`	ID of the environment in form of a string
`Response Type`	The response format expected from the API (e.g. application/json).

Options (4)

Option Name	Description
`Name`	Name for the new app action.
`Code`	The locale code (e.g., 'en-US') for the new locale.
`Fallbackcode`	The locale code of the fallback locale to use when translations are missing.
`Optional`	Set to true if the locale should be optional and not required for content.

GET Get all locales of a space

/spaces/{space_id}/environments/{environment_id}/locales

The locales endpoint returns a list of all created locales. One will have the flag default set to true and is the locale used in the CDA, and you specified no other locale in the request.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Space Id`	ID of the space in form of a string
`Environment Id`	ID of the environment in form of a string
`Response Type`	The response format expected from the API (e.g. application/json).

Locale (3)

DELETE Deleting a locale

/spaces/{space_id}/environments/{environment_id}/locales/{locale_id}

This endpoint deletes an existing locale. It's not possible to recover from this action, all content associated with this specific locale will be deleted and cannot be recreated by creating the same locale again.

Deleting a locale used as a fallback is not allowed. You first have to ensure that a locale is not used as a fallback before being able to delete it.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Space Id`	ID of the Space in form of a string
`Environment Id`	ID of the environment in form of a string
`Locale Id`	ID of the Locale in form of a string
`Content-type`	Content type header for the request.
`Response Type`	The response format expected from the API (e.g. application/json).

GET Get a locale

/spaces/{space_id}/environments/{environment_id}/locales/{locale_id}

This endpoint returns a single locale and its metadata.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Space Id`	ID of the Space in form of a string
`Environment Id`	ID of the environment in form of a string
`Locale Id`	ID of the Locale in form of a string
`Content-type`	Content type header for the request.
`Response Type`	The response format expected from the API (e.g. application/json).

PUT Update a locale

/spaces/{space_id}/environments/{environment_id}/locales/{locale_id}

Use this endpoint to update existing locales in the specified space.

Note: Changing the code of a locale changes the responses for upcoming requests, which might break your existing code. Changes to the code property of locales used as a fallback are not allowed. You have to first ensure that the locale is not used as a fallback by any other locale before changing its code.

A space's default locale is permanent. This means you cannot change a locale's default property.

Note: When updating a locale, you need to specify the last version of the locale you are updating with X-Contentful-Version.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Space Id`	ID of the Space in form of a string
`Environment Id`	ID of the environment in form of a string
`Locale Id`	ID of the Locale in form of a string
`X-contentful-version`	The version of the asset to archive, used for optimistic concurrency control.
`Response Type`	The response format expected from the API (e.g. application/json).

Options (4)

Option Name	Description
`Name`	Name for the new app action.
`Code`	The locale code (e.g., 'en-US') for the new locale.
`Fallbackcode`	The locale code of the fallback locale to use when translations are missing.
`Optional`	Set to true if the locale should be optional and not required for content.

Manage enablements for a given space (2)

GET Get the enablements for a space

/spaces/yadj1kx9rmg0/enablements

This endpoint returns the enablement status of all features in a space.

Note: If you request an enablements document for a space that does not have one already, a default with all items set to false will be created.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Content-type`	Content type header for the request.
`Response Type`	The response format expected from the API (e.g. application/json).

PUT Update the enablements for a space

/spaces/yadj1kx9rmg0/enablements

This endpoint allows you to enable or change features for a given space.

Note: You need to specify the last version of the space enablement document you are updating with X-Contentful-Version.
If no document exists yet you can specify 1.

Note: spaceTemplates and crossSpaceLinks must either both be set to true or both be set to false.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`X-contentful-version`	The version of the asset to archive, used for optimistic concurrency control.
`Response Type`	The response format expected from the API (e.g. application/json).

Organization usage

GET Get organization usage

/organizations/{organization_id}/organization_periodic_usages

Retrieve periodic usage data for a specific organization, such as metrics over a date range.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Order`	Specify the sort order for the results, for example by date or metric name.
`Metric[in]`	Filter usage metrics by one or more metric names, provided as a comma-separated list.
`Daterange.startat`	The start of the date range for which to retrieve usage data, in ISO 8601 format.
`Daterange.endat`	The end of the date range for which to retrieve usage data, in ISO 8601 format.
`Organization Id`	Id of organization
`Response Type`	The response format expected from the API (e.g. application/json).

Organizations collection

GET Get all organizations an account has access to

/organizations

Retrieve a list of all organizations that the authenticated account has access to.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Response Type`	The response format expected from the API (e.g. application/json).

Preview API key

GET Get a single Preview API key

/spaces/{space_id}/preview_api_keys/:preview_api_key_id

This endpoint returns details about an existing Preview API key.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Space Id`	ID of the space in a form of a string
`Response Type`	The response format expected from the API (e.g. application/json).

Preview API keys collection

GET Get all Preview API keys

/spaces/{space_id}/preview_api_keys

Retrieve all Preview API keys for a given space, used for accessing unpublished content.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Space Id`	ID of the space in form of a string
`Response Type`	The response format expected from the API (e.g. application/json).

Publish bulk action

POST Publish bulk action

/spaces/{space_id}/environments/{environment_id}/bulk_actions/publish

Use this method to publish the content linked in the payload.

Permissions

User can publish only existing content on which they have publish permissions.

Errors

400 Error is returned in case:
One or more items do not exist or are inaccessible
Provided version is incorrect

404 Error is returned in case:
The space is not found

422 Error is returned in case:
Validation failed
Entity collection exceeds limit
Duplicated items were found in the payload
Version is not specified

429 Error is returned in case:
The rate limit is exceeded due to number of active bulk actions

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Space Id`	ID of the space as a string
`Environment Id`	ID of the environment as a string, falls back to master if not specified.
`Response Type`	The response format expected from the API (e.g. application/json).

Published Entries collection

GET Get all published entries of a space

/spaces/{space_id}/environments/{environment_id}/public/entries

Retrieve all published entries from a specific environment within a space.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Space Id`	Identifier of the space containing the environment.
`Environment Id`	Identifier of the environment where the app is installed.
`Response Type`	The response format expected from the API (e.g. application/json).

Published assets collection

GET Get all published assets of a space

/spaces/{space_id}/environments/{environment_id}/public/assets

Retrieves the published versions of all assets in a space.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Space Id`	ID of the Space in form of a string
`Environment Id`	ID of the environment in form of a string
`Response Type`	The response format expected from the API (e.g. application/json).

Published release (2)

PUT Publish release

/spaces/{space_id}/environments/{environment_id}/releases/{release_id}/published

Use this method to create a release action that publishes all entities that belong to release by provided ID.

Permissions

Any user with publish access to an entry can publish a release.

Errors

404 Error is returned in case:
The sys.id is not found
current user has no access to releases
the version header is not provided.

429 Error is returned in case:
exceeding the limit publish limit
exceeding the limit if in action is already created or in proress
fails with validation errors

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Space Id`	ID of the space in form of a string
`Environment Id`	ID of the environment in form of a string
`Release Id`	ID of the release in form of a string
`Response Type`	The response format expected from the API (e.g. application/json).

DELETE Unpublish release

/spaces/{space_id}/environments/{environment_id}/releases/{release_id}/published

Use this method to create release action that unpublishes all entities that belong to release by provided ID.

Permissions

Any user with publish access to an entry can unpublish a release.

Errors

404 Error is returned in case:
The sys.id is not found
current user has no access to releases
the version header is not provided.

429 Error is returned in case:
exceeding the limit publish limit
exceeding the limit if in action is already created or in proress
fails with validation errors

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Space Id`	ID of the space in form of a string
`Environment Id`	ID of the environment in form of a string
`Release Id`	ID of the release in form of a string
`Response Type`	The response format expected from the API (e.g. application/json).

Release action

GET Get single release actions

/spaces/{space_id}/environments/{environment_id}/releases/{release_id}/actions/{release_action_id}

Use this method to get single release action that belongs to specific release.

Permissions

Any user with read access to an entry can query release actions.

Errors

404 Error is returned in case:
release not found
release action not found

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Space Id`	ID of the space in form of a string
`Environment Id`	ID of the environment in form of a string
`Release Id`	ID of the release in form of a string
`Release Action Id`	ID of the release action in form of a string
`Response Type`	The response format expected from the API (e.g. application/json).

Release actions

GET Query release actions

/spaces/{space_id}/environments/{environment_id}/release_actions

Use this method to query release actions that belongs to one or more releases.

Filters

There are following filters available on this endpoint:

Filter | Description
----------------------------|-----------------------------------------------
limit | Limit the number of release actions in the response
order | Returns results ordered by the value specified. Supports sys.updatedAt, sys.createdAt, -sys.updatedAt, sys.createdAt
action | Returns results that match the action value. Supported values are validate, publish and unpublish
sys.id[in] | Comma-separated list of _release action_ IDs. Fetches only the release actions specified
sys.release.sys.id[in] | Comma-separated list of _release_ IDs. Filter all release actions by the release ID
sys.status[in] | Comma-separated list of status. Filter all release actions including the status (succeeded, inProgress or created)
sys.status[nin] | Comma-separated list of status. Filter all release actions excluding the status (succeeded, inProgress or created)
uniqueBy | Returns unique release actions by the field specified. Only supports sys.release.sys.id

Permissions

Any user with read access to an entry/release can query release actions.

Errors

400 (BadRequest) Error is returned when:
sys.status[in] and sys.status[nin] are present at the same time in the request

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Space Id`	ID of the space in form of a string
`Environment Id`	ID of the environment in form of a string
`Response Type`	The response format expected from the API (e.g. application/json).

Release (3)

GET Get single release

/spaces/{space_id}/environments/{environment_id}/releases/:release_id

Use this method to fetch a single release.

Permissions

Any user with read access to an entry can get a release.

Errors

404 Error is returned in case:
The sys.id is not found
Current user doesn't have access to space

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Space Id`	ID of the space in form of a string
`Environment Id`	ID of the environment in form of a string
`Response Type`	The response format expected from the API (e.g. application/json).

DELETE Remove release

/spaces/{space_id}/environments/{environment_id}/releases/:release_id

Use this method to delete a release by provided ID.

Permissions

Only a user that created release or admin can delete a release.

Errors

404 Error is returned in case:
The sys.id is not found

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Space Id`	ID of the space in form of a string
`Environment Id`	ID of the environment in form of a string
`Response Type`	The response format expected from the API (e.g. application/json).

PUT Update release

/spaces/{space_id}/environments/{environment_id}/releases/:release_id

Use this method to update the release by provided ID.

Permissions

Any user with write access to an entry can update a release.

Errors

400 Error is returned in case:
the version header is not provided.

404 Error is returned in case:
The sys.id is not found
Current user doesn't have access to space
Current user doesn't have access to provided entity
Entity does not exist

422 Error is returned in case:
provided entity ids are not unique
provided entity id is undefined
provided entityType is not Entry or Asset
exceed limit of entities in the release

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Space Id`	ID of the space in form of a string
`Environment Id`	ID of the environment in form of a string
`Response Type`	The response format expected from the API (e.g. application/json).

Options (1)

Option Name	Description
`Title`	The new title for the release.

Releases (2)

POST Create release

/spaces/{space_id}/environments/{environment_id}/releases

Use this endpoint to create a new release. When using this endpoint, an ID will be automatically generated for the created release and returned in the response.

Permissions

Any user can create new release.

Errors

400 Error is returned in case:
property "linkType" is missing
property "linkType" is not "Entry" or "Asset"
enviroment is not found

404 Error is returned in case:
current user doesn't have access to space
current user doesn't have access to provided entry
entity does not exist

422 Error is returned in case:
provided entity ids are not unique
provided entity id is undefined
provided entityType is not Entry or Asset
exceed limit of entities in the release

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Space Id`	ID of the space in form of a string
`Environment Id`	ID of the environment in form of a string
`Response Type`	The response format expected from the API (e.g. application/json).

Options (1)

Option Name	Description
`Title`	A title for the new release.

GET Query releases

/spaces/{space_id}/environments/{environment_id}/releases

Use this endpoint to fetch a multiple releases.

Releases collection

The releases collection endpoint implements cursor-based pagination.
The pages object contains the next key which contains the relative URL to the next batch of items.
The URL contains the same set of filters and limit as initially requested.
This key is presented only if there are available elements to be fetched that weren't returned from the current request because of the requested limit.
The default page size is 100 and the maximum allowed limit is 1000.

Filters

These are the following filters (query params) available for this endpoint:

Filter | Description
----------------------|-----------------------------------------------
sys.id[in] | Filter releases to those matching the comma-separated list of ids (e.g. id1,id2)
sys.id[nin] | Filter releases excluding those matching the comma-separated list of ids (e.g. id1,id2)
sys.createdBy.sys.id[in] | Filter releases by the creator ID to those matching the comma-separated list of ids (e.g. id1,id2)
sys.status[in] | Filter releases to those matching the comma-separated list of available statuses (e.g. active,archived)
sys.status[nin] | Filter releases excluding those matching the comma-separated list of available statuses (e.g. active,archived)
entities.sys.id[in] | Filter releases to those containing a comma-separated list of entity ids (e.g. id1,id2). Requires entities.sys.linkType
entities.sys.linkType | Filter releases by provided entity types, required for the "entities.sys.id[in]" filter. Can be one of Asset or Entry
entities[exists] | Filter (boolean) indicating whether to return empty releases or non-empty releases. E.g. using true will return releases that have at least 1 Entry/Asset within.
title[match] | Filter releases using full text search on the title field. Learn more about full text search in the Delivery API documentation
pageNext | If present, will return the next page of releases. This value needs to be provided from a previous release query result.
order | Orders the query results. The available options include sys.updatedAt, -sys.updatedAt, -title, title, sys.createdAt and -sys.createdAt
limit | Limit the number of releases returned in the response (max. is 1000)

Permissions

Any user with read access to an entry can query releases.

Errors

400 Error is returned in case:
Enviroment is not found
Property LinkType is missing when using "entities.sys.id[in]" filter
Property "linkType" is not "Entry" or "Asset"

404 Error is returned in case:
Including an entry that user has no permissions to
Current user doesn't have access to space

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Space Id`	ID of the space in form of a string
`Environment Id`	ID of the environment in form of a string
`Content-type`	Content type header for the request.
`Response Type`	The response format expected from the API (e.g. application/json).

Retrieving an upload

GET Retrieve an upload

/spaces/{space_id}/uploads/{upload_id}

Retrieve details about a specific upload in a space, such as its file information.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Space Id`	Alphanumeric id of the space to retrieve.
`Upload Id`	Alphanumeric id of the upload to retrieve.
`Response Type`	The response format expected from the API (e.g. application/json).

Return a collection of all installations of an environment template

GET Return a collection of all installations of an environment template

/organizations/{organization_id}/environment_templates/{template_id}/template_installations

Retrieve a list of all installations of a given environment template across the organization.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Organization Id`	The ID of the organization. Alphanumerical.
`Template Id`	The ID of the template. Alphanumerical.
`Response Type`	The response format expected from the API (e.g. application/json).

Return a collection with all the installation objects for a given template

GET Return a collection with all the installation objects for a given template

/spaces/{space_id}/environments/{environment_id}/template_installations/{template_id}

Retrieve all installation objects for a specific template within a space environment.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Space Id`	The ID of the space. Alphanumerical.
`Environment Id`	The ID of the environment.
`Template Id`	The ID of the template. Alphanumerical.
`Response Type`	The response format expected from the API (e.g. application/json).

Return a version of an environment template

GET Return a version of an environment template

/organizations/{organization_id}/environment_templates/{template_id}/versions/{version_number}

Retrieve a specific version of an environment template, identified by its version number.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Organization Id`	The ID of the organization. Alphanumerical.
`Template Id`	The ID of the template. Alphanumerical.
`Version Number`	The version number of the template.
`Response Type`	The response format expected from the API (e.g. application/json).

Return all versions of an environment template

GET Return all versions of an environment template

/organizations/{organization_id}/environment_templates/{template_id}/versions

Retrieve all versions of an environment template for the given template.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Organization Id`	The ID of the organization. Alphanumerical.
`Template Id`	The ID of the template. Alphanumerical.
`Response Type`	The response format expected from the API (e.g. application/json).

Return one environment template

GET Return one environment template

/organizations/{organization_id}/environment_templates/{template_id}

Retrieve a single environment template by its ID.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Organization Id`	The ID of the organization. Alphanumerical.
`Template Id`	The ID of the template. Alphanumerical.
`Response Type`	The response format expected from the API (e.g. application/json).

Role (3)

DELETE Delete a single role

/spaces/{space_id}/roles/{role_id}

Use this endpoint to delete an existing role. You can only delete roles if there is no user in the space with only that role assigned, i.e. a user must have at least one role.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Space Id`	ID of the space in form of a string
`Role Id`	ID of the role in a form of a string
`Response Type`	The response format expected from the API (e.g. application/json).

GET Get a single role

/spaces/{space_id}/roles/{role_id}

Use this endpoint to read an existing single role.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Space Id`	ID of the space in form of a string
`Role Id`	ID of the role in a form of a string
`Response Type`	The response format expected from the API (e.g. application/json).

PUT Update a single role

/spaces/{space_id}/roles/{role_id}

Use this endpoint to update an existing role. You cannot use the endpoint to create a new role with a specific id.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Space Id`	ID of the space in form of a string
`Role Id`	ID of the role in a form of a string
`Response Type`	The response format expected from the API (e.g. application/json).

Options (2)

Option Name	Description
`Name`	Name for the new app action.
`Description`	Description for the new app action.

Roles collection (2)

POST Create a role

/spaces/{space_id}/roles

Use this endpoint to create a custom role. The role name must be unique within the space.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Space Id`	ID of the Space in form of a string
`Response Type`	The response format expected from the API (e.g. application/json).

Options (2)

Option Name	Description
`Name`	Name for the new app action.
`Description`	Description for the new app action.

GET Get all roles

/spaces/{space_id}/roles

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

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Space Id`	ID of the Space in form of a string
`Response Type`	The response format expected from the API (e.g. application/json).

Scheduled actions collection

GET Get all scheduled actions of an entry

/spaces/{space_id}/scheduled_actions

Use this endpoint to get all the scheduled actions of an entry.

Collection filters

Scheduled actions collection supports fillowing filters:

Params | Required | Description
----------------------------------------------------|----------|---------------------------------------
?environment.sys.id="" | true | Filter by the external environment ID.
?entity.sys.id=1 | false | Filter by the list of entity ids
?sys.status[in]= | false | Filter by the list of the scheduled actions' statuses
?sys.status= | false | Filter by single scheduled actions' status
?scheduledFor.datetime="ISO-time" | false | Filter by exact match of the scheduledFor.datetime property
?scheduledFor.datetime[lt\|lte\|gt\|gte]="ISO-time" | false | Filter by comparison the scheduledFor.datetime property

Collection ordering

Scheduled actions collection supports fillowing ordering options:

Params | Description
------------------------------|-------------------------------
?order=-scheduledFor.datetime | Descending order for scheduled actions, ascending if the parameter is absent provided.

Collection pagination

The scheduled actions collection endpoint implements cursor-based pagination.
The pages object contains the next key which contains the relative URL to the next batch of items.
The URL contains the same set of filters and limit as initially requested.
This key is presented only if there are available elements to be fetched that weren't returned from the current request because of the requested limit.
The pages object also contains the prev key for every request after the initial request.
It contains the relative URL to the batch of items requested in the previous request.
The default page size if 100 and the maximum allowed limit is 1000.

Permissions

Any user can read all the scheduled actions in the entry.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Entity.sys.id`	The ID of the entry whose scheduled actions you want to retrieve.
`Environment.sys.id`	Specify the environment system ID to identify which environment the scheduled action belongs to.
`Space Id`	ID of the space in form of a string
`Response Type`	The response format expected from the API (e.g. application/json).

Space membership (3)

DELETE Delete a single space membership

/spaces/{space_id}/space_memberships/{space_membership_id}

This endpoint allows you to delete a space membership. It only changes if a user can access a space, and not the user record.

Note: It's possible to remove every administrator from a space which could mean there is no one left to manage the users. You can fix this by inviting a new user through the web app organization settings.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Space Id`	ID of the space in a form of a string
`Space Membership Id`	ID of the space membership in a form of a string
`Response Type`	The response format expected from the API (e.g. application/json).

GET Get a single space membership

/spaces/{space_id}/space_memberships/{space_membership_id}

This endpoint returns details about an existing space membership.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Space Id`	ID of the space in a form of a string
`Space Membership Id`	ID of the space membership in a form of a string
`Response Type`	The response format expected from the API (e.g. application/json).

PUT Update a single space membership

/spaces/{space_id}/space_memberships/{space_membership_id}

This endpoint allows you to change a space membership. Use this to assign additional roles or flag a user as 'admin'.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Space Id`	ID of the space in a form of a string
`Space Membership Id`	ID of the space membership in a form of a string
`Response Type`	The response format expected from the API (e.g. application/json).

Options (1)

Option Name	Description
`Admin`	Whether the member should have admin privileges in the space; set to true or false.

Space memberships collection (2)

POST Create a space membership

/spaces/{space_id}/space_memberships

Use this endpoint to create a space membership (or invite a user to a space). A user can and must be flagged as 'admin' or assigned to certain roles.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Space Id`	ID of the space in form of a string
`Response Type`	The response format expected from the API (e.g. application/json).

Options (2)

Option Name	Description
`Admin`	Whether the invited user should have admin privileges in the space; set to true or false.
`Email`	The email address of the user to invite as a space member.

GET Get all space memberships

/spaces/{space_id}/space_memberships

This endpoint returns a paginated list of all space memberships.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Space Id`	ID of the space in form of a string
`Response Type`	The response format expected from the API (e.g. application/json).

Space usage

GET Get space usage

/organizations/{organization_id}/space_periodic_usages

Retrieve periodic usage data for all spaces within an organization, filtered by metrics and date range.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Metric[in]`	Filter usage metrics by one or more metric names, provided as a comma-separated list.
`Daterange.startat`	The start of the date range for which to retrieve usage data, in ISO 8601 format.
`Daterange.endat`	The end of the date range for which to retrieve usage data, in ISO 8601 format.
`Order`	Specify the sort order for the results, for example by date or metric name.
`Organization Id`	Id of organization
`Response Type`	The response format expected from the API (e.g. application/json).

Space (3)

DELETE Delete a space

/spaces/{space_id}

You delete an existing space by issuing a DELETE request to /spaces/ID. Deleting a space will remove all its resources, including content types, entries and assets. This action can not be undone.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Space Id`	ID of the Space in form of a string
`Response Type`	The response format expected from the API (e.g. application/json).

GET Get a space

/spaces/{space_id}

Retrieve details of a specific space by its unique identifier.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Space Id`	Alphanumeric id of the space to retrieve.
`Response Type`	The response format expected from the API (e.g. application/json).

PUT Update a space name

/spaces/{space_id}

The X-Contentful-Organization header is optional if an account belongs to one organization. Attributes are sent in the body of the request as a JSON payload, and you need to set the X-Contentful-Version to the Contentul API version you are using.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Space Id`	ID of the Space in form of a string
`X-contentful-version`	The version of the asset to archive, used for optimistic concurrency control.
`Response Type`	The response format expected from the API (e.g. application/json).

Options (1)

Option Name	Description
`Name`	Name for the new app action.

Spaces collection (2)

POST Create a space

/spaces

Create a new space, specifying attributes in the request body.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`X-contentful-organization`	Your organization id.
`Response Type`	The response format expected from the API (e.g. application/json).

Options (2)

Option Name	Description
`Name`	Name for the new app action.
`Defaultlocale`	Specify the default locale for the space, such as 'en-US'.

GET Get all spaces an account has access to

/spaces

List all spaces that the authenticated account has access to.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Response Type`	The response format expected from the API (e.g. application/json).

Tag collection

GET Get all tags

/spaces/{space_id}/environments/{environment_id}/tags

Returns all the tags that exist in a given environment.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Space Id`	ID of the space in form of a string
`Environment Id`	ID of the environment in form of a string
`Response Type`	The response format expected from the API (e.g. application/json).

Tag (3)

PUT Create a tag

/spaces/{space_id}/environments/{environment_id}/tags/{tag_id}

Creates a new tag and returns it.

Note:

Both name and ID must be unique to each environment. Tag names can be modified after creation, but the tag ID cannot.

The tag visibility can be set in the header with X-Contentful-Tag-Visibility. The visibility value set in the header overrides that in the payload.

The tag visibility is set to private if there's no visibility specified in the payload or the header.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Space Id`	ID of the space in the form of a string
`Environment Id`	ID of the environment in form of a string
`Tag Id`	ID of the tag in form of a string
`Response Type`	The response format expected from the API (e.g. application/json).

Options (1)

Option Name	Description
`Name`	Name for the new app action.

DELETE Delete a tag

/spaces/{space_id}/environments/{environment_id}/tags/{tag_id}

Deletes a tag from the entries and/or assets that reference it.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Space Id`	ID of the space in the form of a string
`Environment Id`	ID of the environment in form of a string
`Tag Id`	ID of the tag in form of a string
`X-contentful-version`	The version of the asset to archive, used for optimistic concurrency control.
`Response Type`	The response format expected from the API (e.g. application/json).

GET Get a single tag

/spaces/{space_id}/environments/{environment_id}/tags/{tag_id}

Returns a single tag based on the given identifier.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Space Id`	ID of the space in the form of a string
`Environment Id`	ID of the environment in form of a string
`Tag Id`	ID of the tag in form of a string
`Response Type`	The response format expected from the API (e.g. application/json).

Task (3)

DELETE Delete a task

/spaces/{space_id}/environments/{environment_id}/entries/{entry_id}/tasks/{task_id}

Use this method to delete a task.

Permissions

Task creators can delete their own tasks. Admins can delete any task on any
entry.

Notifications

No notification is sent when a task is deleted.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Space Id`	ID of the space in form of a string
`Environment Id`	ID of the environment in form of a string
`Entry Id`	ID of the entry in form of a string
`Task Id`	ID of the task
`X-contentful-version`	The version of the asset to archive, used for optimistic concurrency control.
`Response Type`	The response format expected from the API (e.g. application/json).

GET Get a single task

/spaces/{space_id}/environments/{environment_id}/entries/{entry_id}/tasks/{task_id}

Use this endpoint to fetch a task with a specified ID.

Permissions

Any user with read access to an entry can read a task in the entry. Space admins
can read any task in any entry.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Space Id`	ID of the space in form of a string
`Environment Id`	ID of the environment in form of a string
`Entry Id`	ID of the entry in form of a string
`Task Id`	ID of the task
`Response Type`	The response format expected from the API (e.g. application/json).

PUT Update a task

/spaces/{space_id}/environments/{environment_id}/entries/{entry_id}/tasks/{task_id}

Use this method to modify the body of the task, re-assign it to another member
of the space or resolve it. Note that the body or the assignee of a task
can't be modified if the task has already been resolved. Unresolve it first to
be able to update these fields.

Permissions

Update permissions are a bit more complex so we are going to use a table to
present all the possible combinations of which field can be updated by whom.

Field \ Whom | Task assignee |Task creator |Space admin
-------------------|------------------|-------------|------------
assignedTo | no | yes | yes
body | no | yes | yes
status | yes | no | yes

Errors

A 400 - BadRequest error is returned if a task's body or assignee are updated after

the task has been resolved.

An 403 - AccessDenied error is returned in the following cases:
A user different from the task assignee or an admin marked a task as resolved.
A user different from the task creator or an admin changed the task assignee.
A user different from the task creator or an admin changed the task body.

A 422 - ValidationFailed error is returned if:
The body field has a value bigger than 512 bytes
The status field has a value different to active or resolved

Notifications

Depending on which field is updated and by whom the recipient of the notification
will vary.

Updates to body

Who \ recipient | task assignee | task creator | space admins
---------------------------------|------------------|--------------|------------
task creator | yes | no | no
space admins | yes | yes | no

Updates to assignedTo

Who \ recipient | old task assignee | new task assignee | task creator | space admins
---------------------------------|--------------------|--------------------|--------------|---------------
task creator | yes | yes | no | no
space admins | yes | yes | yes | no

Updates to status

Who \ recipient | task assignee | task creator | space admins
---------------------------------|----------------|--------------|---------------
task assignee | no | yes | no
space admins | yes | yes | no

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Space Id`	ID of the space in form of a string
`Environment Id`	ID of the environment in form of a string
`Entry Id`	ID of the entry in form of a string
`Task Id`	ID of the task
`X-contentful-version`	The version of the asset to archive, used for optimistic concurrency control.
`Response Type`	The response format expected from the API (e.g. application/json).

Options (2)

Option Name	Description
`Body`	The request body to include in the signed request, if any.
`Status`	The initial status of the task (e.g., 'active' or 'completed').

Teams collection

GET Get all teams for a space

/spaces/{space_id}/teams

This endpoint returns a paginated list of all teams with access to a space.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Space Id`	ID of the space in form of a string
`Response Type`	The response format expected from the API (e.g. application/json).

Token revoking

PUT Revoke an access token

/users/me/access_tokens/{token_id}/revoked

This endpoint allows you to revoke a CMA token. It will set revokedAt to the timestamp of when the request was received.

Note: This action can not be undone.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Token Id`	ID of the personal access token in a form of a string
`Content-type`	Content type header for the request.
`Response Type`	The response format expected from the API (e.g. application/json).

UI Config (2)

GET Get the UI Config

/spaces/{space_id}/environments/{environment_id}/ui_config

This endpoint returns the available UI Config in the current environment.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Space Id`	ID of the Space in form of a string
`Environment Id`	ID of the environment in form of a string
`Response Type`	The response format expected from the API (e.g. application/json).

PUT Update the UI Config

/spaces/{space_id}/environments/{environment_id}/ui_config

You can use this endpoint to update the UI Config in your environment. These settings are visible to everyone in the environment.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Space Id`	ID of the Space in form of a string
`Environment Id`	ID of the environment in form of a string
`Response Type`	The response format expected from the API (e.g. application/json).

Unpublish bulk action

POST Unpublish bulk action

/spaces/{space_id}/environments/{environment_id}/bulk_actions/unpublish

Use this method to unpublish the content linked in the payload.

Permissions

User can only unpublish existing content on which they have unpublish permissions.

Errors

400 Error is returned in case:
Provided entity does not exists

404 Error is returned in case:
The space is not found

422 Error is returned in case:
Validation failed
Entity collection exceeds limit
Duplicate entities in the payload

429 Error is returned in case:
The rate limit is exceeded due to the number of active bulk actions

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Space Id`	ID of the space as a string
`Environment Id`	ID of the environment as a string, falls back to master if not specified.
`Response Type`	The response format expected from the API (e.g. application/json).

Update a scheduled action

PUT Update a scheduled action

/spaces/{space_id}/scheduled_actions/{scheduled_action_id}

Use this method to update a scheduled action's time (at scheduledFor.datetime) or timezone (at scheduledFor.timezone).
Changes to fields outside of scheduledFor are currently not supported and will result in an HTTP 400 Bad Request.

Permissions

Any user with the ability to perform the specified scheduled action to the referenced content.

Errors

400 Error is returned in case:
The version header is not provided
Property outside of scheduledFor.datetime and scheduledFor.timezone is changed
Scheduled action is not in status scheduled
An action is already scheduled for the same date and time
entity.sys.id is invalid
Enviroment is not found
Exceeds pending actions limit
The payload.withReferences is included for an entity without annotations

409 Error is returned in case:
Version number is not a number
The version in the X-Contentful-Version header doesn't match the current scheduled action version

422 Invalid request payload input return in following cases:
The body contains an invalid payload
The scheduledFor.datetime is missing
The scheduledFor.datetime is in the past or is not a valid ISO 8601 time
The scheduledFor.datetime is greater than 5 years (60 months) ahead of the current time
The scheduledFor.timezone is not a valid IANA timezone identifier
The payload.withReferences is provided but it's not in a valid format. Only for publish action

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Space Id`	ID of the space in form of a string
`Scheduled Action Id`	ID of the scheduled action in form of a string
`X-contentful-version`	The version of the asset to archive, used for optimistic concurrency control.
`Response Type`	The response format expected from the API (e.g. application/json).

Options (1)

Option Name	Description
`Action`	Provide the action type to schedule, e.g., 'publish' or 'unpublish'.

Update an environment template

PUT Update an environment template

/organizations/{organization_id}/environment_templates/{template_id}

Update an existing environment template in a specified organization.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Organization Id`	The ID of the organization. Alphanumerical.
`Template Id`	The ID of the organization. Alphanumerical. For more information about this parameter, see https://www.contentful.com/developers/docs/references/content-management-api/#/introduction/updating-and-version-locking.
`X-contentful-version`	The version of the asset to archive, used for optimistic concurrency control.
`Response Type`	The response format expected from the API (e.g. application/json).

Options (4)

Option Name	Description
`Name`	Name for the new app action.
`Description`	Description for the new app action.
`Versionname`	Assign a name to the template version.
`Versiondescription`	Provide a description for the template version.

Update the field type in a content type

PUT Update the field type in a content type

/spaces/yadj1kx9rmg0/environments/master/content_types

Allowed resources

The ResourceLink field definition expects an allowedResources array as additional property, restricting which resources can be linked through the field.

Note:
Only resources belonging to spaces within the same organization are accepted.

Property |Description |Validation rule |
---------------------------------|---------------------|----------------------------------------|
allowedResources |Array containing one item per distinct source. |Must contain at least one item.
allowedResources[].type |The type of resource that the rule contains. |Must be Contentful:Entry.
allowedResources[].source |The location of the allowed resources. A crn to a contentful environment for type Contentful:Entry. |Must be unique across allowedResources and does not refer to the same space owning the content type.
allowedResources[].contentTypes|The only entry types supported by Contentful. |Must be an array of strings.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Response Type`	The response format expected from the API (e.g. application/json).

Update the field values in entries (2)

PUT Update the field values in entries

/spaces/yadj1kx9rmg0(/environments/master)/entries

Update the field values for one or more entries in a specific environment.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Response Type`	The response format expected from the API (e.g. application/json).

PATCH Update the field values in entries1

/spaces/yadj1kx9rmg0(/environments/master)/entries

Validations

For each field definition property, you can add or remove validations to the fields in the content type schema by specifying the validations property of a field.

Property |Description |Validation rule |
---------------------------------|---------------------|----------------------------------------|
sys.crn |The identifier of the resource. |Must correspond to a resource of type sys.type in the entry organization.
sys.type |The type of resource in the link. |Must be Contentful:Entry.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Response Type`	The response format expected from the API (e.g. application/json).

Upload a file

POST Creating an upload resource

/spaces/{space_id}/uploads

Upload a file to create an upload resource for a given space.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Space Id`	Alphanumeric id of the space to retrieve.
`Response Type`	The response format expected from the API (e.g. application/json).

Options (1)

Option Name	Description
`Options`	The upload options, typically a JSON object with details like file size and content type.

User UI Config (2)

GET Get the User UI Config

/spaces/{space_id}/environments/{environment_id}/ui_config/me

Retrieve the user interface configuration for the current user in a specific environment.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Space Id`	ID of the Space in form of a string
`Environment Id`	ID of the environment in form of a string
`Response Type`	The response format expected from the API (e.g. application/json).

PUT Update the User UI Config

/spaces/{space_id}/environments/{environment_id}/ui_config/me

You can use this endpoint to update your User UI Config.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Space Id`	ID of the Space in form of a string
`Environment Id`	ID of the environment in form of a string
`Response Type`	The response format expected from the API (e.g. application/json).

User (5)

DELETE Delete a single user

/scim/v2/organizations/:org_id/Users/{userId}

Use this endpoint to remove a user from your organization. Removing a user from your organization will also remove the user from all teams and spaces.

Note: The action does not delete the user's Contentful account, but only removes them from your organization.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Userid`	ID of the SCIM User
`Content-type`	Content type header for the request.
`Response Type`	The response format expected from the API (e.g. application/json).

GET Get a single user

/scim/v2/organizations/:org_id/Users/{userId}

Retrieve details of a single user by their identifier in the SCIM directory.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Userid`	ID of the SCIM User
`Content-type`	Content type header for the request.
`Response Type`	The response format expected from the API (e.g. application/json).

GET Get the authenticated user

/users/me

This endpoint returns details about your Contentful user account.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Content-type`	Content type header for the request.
`Response Type`	The response format expected from the API (e.g. application/json).

PATCH Update a single user with PATCH

/scim/v2/organizations/:org_id/Users/{userId}

Updates attributes of the user.

Note: This endpoint is currently provided for identity provider compatibility, since no User attributes are mutable.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Userid`	ID of the SCIM User
`Response Type`	The response format expected from the API (e.g. application/json).

Options (2)

Option Name	Description
`Schemas`	A list of schema URIs that define the structure of the group creation request.
`Operations`	Provide an array of SCIM PATCH operations specifying the changes to apply.

PUT Update a single user with PUT

/scim/v2/organizations/:org_id/Users/{userId}

Updates attributes of the user.

Note: This endpoint is currently provided for identity provider compatibility, since no User attributes are mutable.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Userid`	ID of the SCIM User
`Response Type`	The response format expected from the API (e.g. application/json).

Options (4)

Option Name	Description
`Schemas`	A list of schema URIs that define the structure of the group creation request.
`Id`	Specify the unique identifier of the user.
`Username`	Set the username for the user.
`Active`	Indicate whether the user account should be active (true) or inactive (false).

Users collection (2)

POST Create a user

/scim/v2/organizations/{org_id}/Users

Newly created users will appear in your organization as "Invited". If you use the User Management API, you'll see the new Organization Membership with the status property of "pending".

The new users should receive an invitation email to join your Organization. In SSO enabled organizations, users will not receive this email notification.

All users are created with the organization role of member. Role changes are currently only supported via the User Management API or in the Contentful web app.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Org Id`	The unique identifier of the organization whose groups you want to list.
`Response Type`	The response format expected from the API (e.g. application/json).

Options (2)

Option Name	Description
`Schemas`	A list of schema URIs that define the structure of the group creation request.
`Username`	Provide the username for the new user.

GET Get all users in the organization

/scim/v2/organizations/{org_id}/Users

It is possible to filter by the userName eq filter, passing a valid user email address as the value. See the Filtering section in the SCIM 2.0 specification for details.

GET /Users?filter=userName eq "user@example.com"

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Org Id`	The unique identifier of the organization whose groups you want to list.
`Content-type`	Content type header for the request.
`Response Type`	The response format expected from the API (e.g. application/json).

Validate a template version for installation

PUT Validate a template version for installation

/spaces/{space_id}/environments/{environment_id}/template_installations/{template_id}/versions/{version_number}/validated

Marks a specific template version as validated for installation, allowing it to be used in deployments.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Space Id`	The ID of the space. Alphanumerical.
`Environment Id`	The ID of the environment.
`Template Id`	The ID of the template. Alphanumerical.
`Version Number`	The version number of the template.
`Response Type`	The response format expected from the API (e.g. application/json).

Validate bulk action

POST Validate bulk action

/spaces/{space_id}/environments/{environment_id}/bulk_actions/validate

Use this method to validate entities before publishing.

Permissions

User can only validate existing entities with publish permissions.

Errors

400 Error is returned in case:
Provided entity does not exist

404 Error is returned in case:
The space is not found

422 Error is returned in case:
Validation failed
Entity collection exeeds limit
Duplicate entities in the payload

429 Error is returned in case:
The rate limit is exceeded due to the number of active bulk actions

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Space Id`	ID of the space as a string
`Environment Id`	ID of the environment as a string, falls back to master if not specified.
`Response Type`	The response format expected from the API (e.g. application/json).

Validate release

POST Create validation release action

/spaces/{space_id}/environments/{environment_id}/releases/:release_id/validate

Use this method to create a release action that validates a release identified by the provided ID asynchronously.

Permissions

Any user with publish access to an entry can validate a release.

Limitations

There is only 1 validation at a time allowed for a single release. Initiating additional validation for the release that already has in progress would result in error.

Errors

404 Error is returned in case:
The sys.id is not found
current user has no access to releases

429 Error is returned in case:
current user has no access to entries
validation action is not publish or unpublish
exceeding the publish limit
release validation is already in progress

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Space Id`	ID of the space in form of a string
`Environment Id`	ID of the environment in form of a string
`Response Type`	The response format expected from the API (e.g. application/json).

Options (1)

Option Name	Description
`Action`	Provide the action type to schedule, e.g., 'publish' or 'unpublish'.

Validate the latest template version for installation

PUT Validate the latest template version for installation

/spaces/{space_id}/environments/{environment_id}/template_installations/{template_id}/validated

Marks the latest template version as validated for installation, enabling its use in deployments.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Space Id`	The ID of the space. Alphanumerical.
`Environment Id`	The ID of the environment.
`Template Id`	The ID of the template. Alphanumerical.
`Response Type`	The response format expected from the API (e.g. application/json).

Webhook call details

GET Get the webhook call details

/spaces/{space_id}/webhooks/{webhook_id}/calls/{call_id}

Retrieves detailed information about a specific webhook call, including request and response data.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Space Id`	ID of the space in form of a string
`Webhook Id`	ID of the webhook in form of a string
`Call Id`	ID of the webhook call in form of a string
`Content-type`	Content type header for the request.
`Response Type`	The response format expected from the API (e.g. application/json).

Webhook call overview

GET Get an overview of recent calls

/spaces/{space_id}/webhooks/{webhook_id}/calls

Returns a summary of recent webhook calls, including status and timestamps, for monitoring purposes.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Space Id`	ID of the space in form of a string
`Webhook Id`	ID of the webhook in form of a string
`Response Type`	The response format expected from the API (e.g. application/json).

Webhook health

GET Get webhook health

/spaces/{space_id}/webhooks/{webhook_id}/health

Provides the health status of a webhook, indicating whether it is operational or experiencing issues.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Space Id`	ID of the Space as a string
`Webhook Id`	ID of the Webhook as a string
`Content-type`	Content type header for the request.
`Response Type`	The response format expected from the API (e.g. application/json).

Webhook (3)

PUT Create/update a webhook

/spaces/{space_id}/webhook_definitions/{webhook_definition_id}

Creates a new webhook definition or updates an existing one for the specified space and webhook identifier.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Space Id`	ID of the space in form of a string
`Webhook Definition Id`	ID of the webhook in form of a string
`Response Type`	The response format expected from the API (e.g. application/json).

Options (7)

Option Name	Description
`Name`	Name for the new app action.
`Url`	The URL that will receive the webhook payloads.
`Topics`	A list of event topics to subscribe to, such as 'Entry.publish' or 'Asset.save'.
`Httpbasicusername`	The username for HTTP Basic Authentication when calling the webhook URL.
`Httpbasicpassword`	The password for HTTP Basic Authentication when calling the webhook URL.
`Filters`	A list of filters that determine which events trigger the webhook.
`Active`	Indicate whether the user account should be active (true) or inactive (false).

DELETE Delete a webhook

/spaces/{space_id}/webhook_definitions/{webhook_definition_id}

Permanently removes a webhook definition from the specified space.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Space Id`	ID of the space in form of a string
`Webhook Definition Id`	ID of the webhook in form of a string
`Response Type`	The response format expected from the API (e.g. application/json).

GET Get a single Webhook

/spaces/{space_id}/webhook_definitions/{webhook_definition_id}

Fetches the details of a specific webhook definition by its identifier.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Space Id`	ID of the space in form of a string
`Webhook Definition Id`	ID of the webhook in form of a string
`Response Type`	The response format expected from the API (e.g. application/json).

Webhooks collection (2)

POST Create a webhook

/spaces/{space_id}/webhook_definitions

Creates a new webhook definition in the specified space with the provided configuration.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Space Id`	ID of the space in form of a string
`Response Type`	The response format expected from the API (e.g. application/json).

Options (7)

Option Name	Description
`Name`	Name for the new app action.
`Url`	The URL that will receive the webhook payloads.
`Topics`	A list of event topics to subscribe to, such as 'Entry.publish' or 'Asset.save'.
`Httpbasicusername`	The username for HTTP Basic Authentication when calling the webhook URL.
`Httpbasicpassword`	The password for HTTP Basic Authentication when calling the webhook URL.
`Filters`	A list of filters that determine which events trigger the webhook.
`Active`	Indicate whether the user account should be active (true) or inactive (false).

GET Get all webhooks of a space

/spaces/{space_id}/webhook_definitions

Lists all webhook definitions configured for the specified space.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Space Id`	ID of the space in form of a string
`Response Type`	The response format expected from the API (e.g. application/json).

Workflow comment

POST Create a workflow comment

/spaces/yadj1kx9rmg0/environments/staging/workflows/fh6dsmnLKsh468/versions/2/comments

Use this endpoint to create a workflow comment for a specific workflow version. Currently we only support one workflow comment per workflow version.

Permissions

Any user with read access to workflows in the given space-environment can call this endpoint.

Errors

A 400 - BadRequest error is returned if there's an attempt to create more than one

workflow comment for a given workflow version.

A 422 - ValidationFailed error is returned if:
The body field has a value bigger than 512 bytes

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Response Type`	The response format expected from the API (e.g. application/json).

Options (1)

Option Name	Description
`Body`	The request body to include in the signed request, if any.

Workflow comments collection

GET Get all comments of a workflow

/spaces/yadj1kx9rmg0/environments/staging/workflows/fh6dsmnLKsh468/comments

Use this endpoint to get all the comments of a workflow.

Permissions

Any user with read access to workflows in the given space-environment can call this endpoint.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Content-type`	Content type header for the request.
`Response Type`	The response format expected from the API (e.g. application/json).

Workflow completion

PUT Complete a workflow

/spaces/yadj1kx9rmg0/environments/staging/workflows/fh6dsmnLKsh468/completed

This action completes the workflow. After a workflow was completed, a new workflow can be created for the same entry.

Permissions

Completing a workflow is per default only allowed for organization or space admins. You can explicitly grant permission to other space users by using the permission type workflow_permission in the workflow step permissions.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`X-contentful-version`	The version of the asset to archive, used for optimistic concurrency control.
`Response Type`	The response format expected from the API (e.g. application/json).

Workflow definition (3)

DELETE Delete a workflow definition

/spaces/{space_id}/environments/{environment_id}/workflow_definitions/{workflow_definition_id}

Permissions

Only organization or space admins can delete a workflow definition.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Space Id`	ID of the space in form of a string
`Environment Id`	ID of the environment in form of a string
`Workflow Definition Id`	ID of the workflow definition in form of a string
`Response Type`	The response format expected from the API (e.g. application/json).

GET Get one workflow definition

/spaces/{space_id}/environments/{environment_id}/workflow_definitions/{workflow_definition_id}

Permissions

Any user can read a workflow definition.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Space Id`	ID of the space in form of a string
`Environment Id`	ID of the environment in form of a string
`Workflow Definition Id`	ID of the workflow definition in form of a string
`Response Type`	The response format expected from the API (e.g. application/json).

PUT Update a workflow definition

/spaces/{space_id}/environments/{environment_id}/workflow_definitions/{workflow_definition_id}

Permissions

Only organization or space admins can update a workflow definition.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Space Id`	ID of the space in form of a string
`Environment Id`	ID of the environment in form of a string
`Workflow Definition Id`	ID of the workflow definition in form of a string
`X-contentful-version`	The version of the release to unarchive, used for optimistic concurrency control.
`Response Type`	The response format expected from the API (e.g. application/json).

Options (4)

Option Name	Description
`Name`	Name for the new app action.
`Description`	Description for the new app action.
`Flowtype`	The type of workflow flow, such as 'basic' or 'custom', defining the workflow's structure.
`Startonentitycreation`	Whether the workflow should automatically start when a new entity is created.

Workflow definitions collection (2)

POST Create a workflow definition

/spaces/{space_id}/environments/{environment_id}/workflow_definitions

Use this endpoint to create a workflow definition.

Permissions

Only organization or space admins can create a workflow definition.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Space Id`	ID of the space in form of a string
`Environment Id`	ID of the environment in form of a string
`Response Type`	The response format expected from the API (e.g. application/json).

Options (4)

Option Name	Description
`Name`	Name for the new app action.
`Description`	Description for the new app action.
`Flowtype`	The type of workflow flow, such as 'basic' or 'custom', defining the workflow's structure.
`Startonentitycreation`	Whether the workflow should automatically start when a new entity is created.

GET Get all workflow definitions

/spaces/{space_id}/environments/{environment_id}/workflow_definitions

This endpoint returns a paginated list of workflow definitions for a given environment.

Permissions

Any user can read workflow definitions.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Space Id`	ID of the space in form of a string
`Environment Id`	ID of the environment in form of a string
`Response Type`	The response format expected from the API (e.g. application/json).

Workflow versioned comments collection

GET Get all comments of a specific workflow version

/spaces/yadj1kx9rmg0/environments/staging/workflows/fh6dsmnLKsh468/versions/2/comments

Use this endpoint to get all the comments of a workflow with a specific version.

Permissions

Any user with read access to workflows in the given space-environment can call this endpoint.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Content-type`	Content type header for the request.
`Response Type`	The response format expected from the API (e.g. application/json).

Workflow (2)

DELETE Delete a workflow

/spaces/yadj1kx9rmg0/environments/staging/workflows/fh6dsmnLKsh468

Permissions

Only organization or space admins can update a workflow definition.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`X-contentful-version`	The version of the asset to archive, used for optimistic concurrency control.
`Response Type`	The response format expected from the API (e.g. application/json).

PUT Update a workflow

/spaces/yadj1kx9rmg0/environments/staging/workflows/fh6dsmnLKsh468

Updating a workflow (to move to another step) is per default only allowed for organization or space admins. You can explicitly grant permission to other space users by using the permission type workflow_permission in the workflow step permissions.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`X-contentful-version`	The version of the asset to archive, used for optimistic concurrency control.
`Response Type`	The response format expected from the API (e.g. application/json).

Options (1)

Option Name	Description
`Stepid`	The identifier of the step within the workflow to update.

Workflows changelog

GET Query records from the workflows changelog

/spaces/{space_id}/environments/{environment_id}/workflows_changelog

This endpoint allows to query records in the workflows changelog with certain filters. The filters are via multiple query parameters which are described in the endpoint specifications.

The resulting list is sorted by the event date in a descending order, i.e. the first item is the most recent one.

Permissions

Every user can query a workflows changelog if they have read access to the specified entry.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Entity.sys.id`	The ID of the entry whose scheduled actions you want to retrieve.
`Workflow.sys.id`	The ID of the workflow to filter changelog records by.
`Entity.sys.linktype`	The link type of the entity to filter changelog records by.
`Space Id`	ID of the space in form of a string
`Environment Id`	ID of the environment in form of a string
`Content-type`	Content type header for the request.
`Response Type`	The response format expected from the API (e.g. application/json).

Workflows collection

POST Create a workflow

/spaces/yadj1kx9rmg0/environments/staging/workflows

Permissions

Every user can create a workflow if they have read access to the linked entry.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Response Type`	The response format expected from the API (e.g. application/json).

Options (1)

Option Name	Description
`Stepid`	The identifier of the step to include when creating the workflow.

Workflows query

GET Query workflows

/spaces/{space_id}/environments/{environment_id}/workflows:

This endpoint allows to query workflows with certain filters. The filters are defined as query parameters which are described in the endpoint specifications.

Permissions

Any user can query workflows.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Space Id`	ID of the space in form of a string
`Environment Id`	ID of the environment in form of a string
`Response Type`	The response format expected from the API (e.g. application/json).