Skip navigation

Use the APIs with our Postman collection

3 min read
Download PDF

Play around with the APIs using our Postman collection with the Postman client. The collection contains all APIs and their endpoints, just like in the API references.

Table of contents

    1. Import the Postman collection

    Use the following button to create a fork of our Postman collection. We recommend using the fork option so that you can easily stay up to date with future updates.

    A screenshot of the added Postman collection with its requests.

    The collection for Postman

    Along with the collection, you'll also get a new Postman environment called APIs.

    2. (Optional) Set up Postman environment variables

    Postman environments are sets of variables with specific values. You can use these variables everywhere in your requests in Postman.

    When you define a variable in an environment (instead of editing the collection), Postman will offer the variables via its auto-complete functionality every time you edit the example requests.

    For instance, the Postman environment APIs comes with a variable named project_id. This variable is also used in all requests in the collection. We recommend you change the variable's value to the ID of your own project.

    Environmental variables in the Postman collection.

    Predefined variables that come with the collection. Change their values to match your project.

    In the collection itself, there's also the managementApiKey variable set up as the authorization token for the Management API endpoints. Make sure to define the variable's value for your Postman environment.

    Avoid exposing your API keys

    By default, your collection and its variables are synchronized to your Postman account in the cloud.

    To avoid mistakenly sharing or exporting your collection along with your API keys, always store the API keys in environment variables.

    3. Send requests

    The collection's structure mimics what you see in the API references. There are requests in each folder.

    You can execute the requests by clicking Send. If you have an environment configured and selected in the top right corner, Postman will use the variable values of the environment.

    After clicking Send, you'll get an API response. That's it!

    API response from a Kontent API in Postman

    A JSON response to a sample API request

    What's next?