Contentful
Content infrastructure for digital experiences at scale
| API | Protocol | Base URL | Docs | Reference | OpenAPI | SDKs |
|---|---|---|---|---|---|---|
| Content Delivery API | rest | https://cdn.contentful.com/ | link | — | — | — |
| Content Preview API | rest | https://preview.contentful.com/ | link | — | — | — |
| Content Management API | rest | https://api.contentful.com/ | link | — | — | — |
| GraphQL Content API | graphql | https://graphql.contentful.com/ | link | — | — | — |
| Images API | rest | https://images.ctfassets.net/ | link | — | — | — |
| User Management API | rest | https://api.contentful.com/ | link | — | — | — |
Actions (120)
Entries · 14
- Archive entryPOST /spaces/{space_id}/entries/{entry_id}/archive
Archive an entry.
documented - Create entryPOST /spaces/{space_id}/entries
Create a new entry in the space.
documented - Delete entryDELETE /spaces/{space_id}/entries/{entry_id}
Delete an entry.
documented - Get entryGET /spaces/{space_id}/entries/{entry_id}
Retrieve a single entry by ID (preview context).
documented - Get entryGET /spaces/{space_id}/entries/{entry_id}
Retrieve a single entry by its ID.
documented - List entriesGET /spaces/{space_id}/entries
Retrieve a collection of entries for a space (optionally filtered by query parameters).
documented - List entriesGET /spaces/{space_id}/entries
Retrieve a collection of entries for a space (preview context).
documented - List entries (space)GET /spaces/{space_id}/entries
List entries in a space (all entries, including drafts, depending on token).
documented - Publish entryPOST /spaces/{space_id}/entries/{entry_id}/publish
Publish an entry.
documented - Query entriesGET /spaces/{space_id}/entries
Search entries using query parameters (e.g., content_type, fields, metadata, include).
documented - Replace entryPUT /spaces/{space_id}/entries/{entry_id}
Replace an entry.
documented - Unarchive entryPOST /spaces/{space_id}/entries/{entry_id}/unarchive
Unarchive an entry.
documented - Unpublish entryPOST /spaces/{space_id}/entries/{entry_id}/unpublish
Unpublish an entry.
documented - Update entryPATCH /spaces/{space_id}/entries/{entry_id}
Update an entry.
documented
Assets · 13
- Archive assetPOST /spaces/{space_id}/assets/{asset_id}/archive
Archive an asset.
documented - Create assetPOST /spaces/{space_id}/assets
Create a new asset.
documented - Delete assetDELETE /spaces/{space_id}/assets/{asset_id}
Delete an asset.
documented - Get assetGET /spaces/{space_id}/assets/{asset_id}
Retrieve a single asset by its ID.
documented - Get assetGET /spaces/{space_id}/assets/{asset_id}
Retrieve a single asset (preview context).
documented - List assetsGET /spaces/{space_id}/assets
Retrieve a collection of assets for a space.
documented - List assetsGET /spaces/{space_id}/assets
Retrieve assets (preview context).
documented - List assets (space)GET /spaces/{space_id}/assets
List assets in a space.
documented - Publish assetPOST /spaces/{space_id}/assets/{asset_id}/publish
Publish an asset.
documented - Replace assetPUT /spaces/{space_id}/assets/{asset_id}
Replace an asset.
documented - Unarchive assetPOST /spaces/{space_id}/assets/{asset_id}/unarchive
Unarchive an asset.
documented - Unpublish assetPOST /spaces/{space_id}/assets/{asset_id}/unpublish
Unpublish an asset.
documented - Update assetPATCH /spaces/{space_id}/assets/{asset_id}
Update an asset.
documented
Users · 12
- Create SCIM userPOST /scim/v2/organizations/{org_id}/Users
Create a new SCIM user.
documented - Delete SCIM userDELETE /scim/v2/organizations/{org_id}/Users/{id}
Delete a SCIM user.
documented - Delete userDELETE /organizations/{organizationId}/users/{id}
Delete a user.
documented - Get SCIM userGET /scim/v2/organizations/{org_id}/Users/{id}
Retrieve a SCIM user by ID.
documented - Get userGET /organizations/{organizationId}/users/{id}
Retrieve a user.
documented - Invite userPOST /organizations/{organizationId}/users
Invite a new user to the organization.
documented - List SCIM usersGET /scim/v2/organizations/{org_id}/Users
List SCIM users in an organization.
documented - List usersGET /organizations/{organizationId}/users
List organization users.
documented - Replace SCIM userPUT /scim/v2/organizations/{org_id}/Users/{id}
Replace a SCIM user.
documented - Replace userPUT /organizations/{organizationId}/users/{id}
Replace a user.
documented - Update SCIM userPATCH /scim/v2/organizations/{org_id}/Users/{id}
Update a SCIM user.
documented - Update userPATCH /organizations/{organizationId}/users/{id}
Update a user.
documented
Content types · 10
- Create content typePOST /spaces/{space_id}/content_types
Create a new content type.
documented - Delete content typeDELETE /spaces/{space_id}/content_types/{content_type_id}
Delete a content type.
documented - Get content typeGET /spaces/{space_id}/content_types/{content_type_id}
Retrieve a single content type definition (preview context).
documented - Get content typeGET /spaces/{space_id}/content_types/{content_type_id}
Retrieve a single content type definition.
documented - List content typesGET /spaces/{space_id}/content_types
Return all content type definitions for a space.
documented - List content typesGET /spaces/{space_id}/content_types
Return all content type definitions for a space (preview context).
documented - Publish content typePOST /spaces/{space_id}/content_types/{content_type_id}/publish
Publish a content type.
documented - Replace content typePUT /spaces/{space_id}/content_types/{content_type_id}
Replace a content type.
documented - Unpublish content typePOST /spaces/{space_id}/content_types/{content_type_id}/unpublish
Unpublish a content type.
documented - Update content typePATCH /spaces/{space_id}/content_types/{content_type_id}
Update a content type.
documented
Tags · 8
- Create tagPOST /spaces/{space_id}/tags
Create a tag.
documented - Delete tagDELETE /spaces/{space_id}/tags/{tag_id}
Delete a tag.
documented - Get tagGET /spaces/{space_id}/tags/{tag_id}
Retrieve a tag (preview).
documented - Get tagGET /spaces/{space_id}/tags/{tag_id}
Retrieve a single tag by ID.
documented - List tagsGET /spaces/{space_id}/tags
Retrieve tags (preview).
documented - List tagsGET /spaces/{space_id}/tags
Retrieve all tags for the space.
documented - List tags (space)GET /spaces/{space_id}/tags
List tags in a space.
documented - Update tagPATCH /spaces/{space_id}/tags/{tag_id}
Update a tag.
documented
Locales · 7
- Create localePOST /spaces/{space_id}/locales
Create a locale in a space.
documented - Delete localeDELETE /spaces/{space_id}/locales/{locale_id}
Delete a locale.
documented - Get localeGET /spaces/{space_id}/locales/{locale_id}
Retrieve a locale by ID.
documented - List localesGET /spaces/{space_id}/locales
Retrieve locales (preview).
documented - List localesGET /spaces/{space_id}/locales
Retrieve all locales defined in the space.
documented - List locales (space)GET /spaces/{space_id}/locales
List locales in a space.
documented - Update localePUT /spaces/{space_id}/locales/{locale_id}
Update a locale.
documented
Spaces · 7
- Create spacePOST /spaces
Create a new space.
documented - Delete spaceDELETE /spaces/{space_id}
Delete a space.
documented - Get spaceGET /spaces/{space_id}
Retrieve details about a Contentful space.
documented - Get spaceGET /spaces/{space_id}
Retrieve details about a Contentful space (preview context).
documented - List spacesGET /spaces
Retrieve a list of spaces in the organization.
documented - Replace spacePUT /spaces/{space_id}
Replace a space resource.
documented - Update spacePATCH /spaces/{space_id}
Update a space resource.
documented
Groups · 6
- Create SCIM groupPOST /scim/v2/organizations/{org_id}/Groups
Create a SCIM group.
documented - Delete SCIM groupDELETE /scim/v2/organizations/{org_id}/Groups/{id}
Delete a SCIM group.
documented - Get SCIM groupGET /scim/v2/organizations/{org_id}/Groups/{id}
Retrieve a SCIM group by ID.
documented - List SCIM groupsGET /scim/v2/organizations/{org_id}/Groups
List SCIM groups in an organization.
documented - Replace SCIM groupPUT /scim/v2/organizations/{org_id}/Groups/{id}
Replace a SCIM group.
documented - Update SCIM groupPATCH /scim/v2/organizations/{org_id}/Groups/{id}
Update a SCIM group.
documented
Organization Memberships · 6
- Create organization membershipPOST /organizations/{organizationId}/organization_memberships
Invite or add a membership to an organization.
documented - Delete organization membershipDELETE /organizations/{organizationId}/organization_memberships/{id}
Remove an organization membership.
documented - Get organization membershipGET /organizations/{organizationId}/organization_memberships/{id}
Retrieve an organization membership.
documented - List organization membershipsGET /organizations/{organizationId}/organization_memberships
List memberships in an organization.
documented - Replace organization membershipPUT /organizations/{organizationId}/organization_memberships/{id}
Replace an organization membership.
documented - Update organization membershipPATCH /organizations/{organizationId}/organization_memberships/{id}
Update an organization membership.
documented
Asset keys · 5
- Create asset keyPOST /spaces/{space_id}/asset_keys
Create a new asset signing key for Embargoed Asset URLs.
documented - Create asset keyPOST /spaces/{space_id}/asset_keys
Create an asset signing key for preview-embargoed URLs.
documented - Get asset keyGET /spaces/{space_id}/asset_keys/{asset_key_id}
Retrieve a specific asset signing key.
documented - Get asset keyGET /spaces/{space_id}/asset_keys/{asset_key_id}
Retrieve an asset signing key (preview).
documented - List asset keysGET /spaces/{space_id}/asset_keys
Retrieve asset signing keys for Embargoed Asset URLs.
documented
Environments · 5
- Create environmentPOST /spaces/{space_id}/environments
Create a new environment in a space.
documented - Delete environmentDELETE /spaces/{space_id}/environments/{environment_id}
Delete an environment.
documented - Get environmentGET /spaces/{space_id}/environments/{environment_id}
Retrieve an environment.
documented - List environmentsGET /spaces/{space_id}/environments
List environments in a space.
documented - Update environmentPUT /spaces/{space_id}/environments/{environment_id}
Update an environment.
documented
GraphQL · 5
- Get GraphQL space (GET)GET /content/v1/spaces/{space}
Query the GraphQL schema for a space (via GET).
documented - Get GraphQL space (with environment)GET /content/v1/spaces/{space}/environments/{environment}
Query the GraphQL schema for a space/environment via GET.
documented - Open GraphiQL explorerGET /spaces/{space}/explore?access_token={token}
Open the GraphiQL explorer for the GraphQL API in a browser.
documented - Query GraphQL space (POST)POST /content/v1/spaces/{space}
Submit a GraphQL query to a space via POST.
documented - Query GraphQL space (POST) with environmentPOST /content/v1/spaces/{space}/environments/{environment}
Submit a GraphQL query to a space/environment via POST.
documented
Space memberships · 5
- Create space membershipPOST /organizations/{organizationId}/space_memberships
Add a user to a space within an organization.
documented - Delete space membershipDELETE /organizations/{organizationId}/space_memberships/{id}
Delete a space membership.
documented - Get space membershipGET /organizations/{organizationId}/space_memberships/{id}
Retrieve a space membership.
documented - List space membershipsGET /organizations/{organizationId}/space_memberships
List a organization's membership in spaces.
documented - Update space membershipPATCH /organizations/{organizationId}/space_memberships/{id}
Update a space membership.
documented
Teams · 5
- Create teamPOST /organizations/{organizationId}/teams
Create a new team.
documented - Delete teamDELETE /organizations/{organizationId}/teams/{id}
Delete a team.
documented - Get teamGET /organizations/{organizationId}/teams/{id}
Retrieve a team.
documented - List teamsGET /organizations/{organizationId}/teams
List teams in an organization.
documented - Update teamPATCH /organizations/{organizationId}/teams/{id}
Update a team.
documented
Webhooks · 5
- Create webhookPOST /spaces/{space_id}/webhooks
Create a webhook for a space.
documented - Delete webhookDELETE /spaces/{space_id}/webhooks/{webhook_id}
Delete a webhook.
documented - Get webhookGET /spaces/{space_id}/webhooks/{webhook_id}
Retrieve a webhook by ID.
documented - List webhooksGET /spaces/{space_id}/webhooks
List webhooks in a space.
documented - Update webhookPATCH /spaces/{space_id}/webhooks/{webhook_id}
Update a webhook.
documented