Contentful API Client schemas

Description

Repository containing Contentful APIs definition schemas for different clients:

• Postman
• openAPI (Not mantained)
• Insomnia (Not mantained)

The Contentful APIs schemas include:

• Content Delivery API (CDA) used to retrieve published content to display in your application.
• Content Management API (CMA) used to create or update your content.
• Content Preview API (CPA) used to retrieve content that is still unpublished
• SCIMP API used to programatically manage organization memberships and teams
• Images API used to retrieve and apply transformations to images

Postman installation

Import the API schema and Environment into your Postman client:

Postman API schema json

Postman API environment variables

Update your local environment with your corresponding Contentful credentials and Ids.

• space_id - Your space ID
• organization_id - Your orgnazitaion ID
• cda_access_token - Content Delivery API (CDA) access token
• cpa_access_token - Content Preview API (CDA)
• cma_access_token - Content management API (CDA)

Postman Usage

After import, all APIs are organized in folders with similar structure as Contentful documentation.

Contentful Apis documentation

The import includes basic API description based on Contentful documentation.

References and links

Personal access tokens

API’s detail documentation