Skip to content


Contentful in Hire2Retire uses API Key.

In various platforms, including Contentful, an API key functions as an exclusive code or token granted to developers seeking interaction with the platform's API. This key plays a pivotal role in verifying and permitting the developer's entry to the platform's resources and data. Developers are required to include this designated API key within their API requests as a means of verifying their identity and securing access to the diverse functionalities furnished by the platform's API.

Please refer to the document API key for rest APIs to know more about API key in Contentful.

We at RoboMQ pay utmost attention to keep your account secure. See our Security and Privacy Policies to learn more about how RoboMQ handles your account access.

Object Permission
User Can Provision and Deprovision Users

Generate API key in Contentful

Learn how to generate API key on Contentful.

Get API key

Visit Contentful website, in your account and click on organization settings & subscription, then click on Access Tools and select user provisioning, click on Generate personal access token.

Contentful API Key

Figure 1. API key for Contentful

Get Instance Url

The Instance URL is the entry point to all API calls.

Contentful Instance Url

Figure 2. Instance URL for Contentful

Get Organization ID

The Organization ID is the unique identifier for a virtual server or account. To use the STA APIs, you need to provide your tenant code with each request, which ensures that each virtual server can access only their data. You can find your organization ID in the Endpoint URL

Contentful Organization ID

Figure 3. Organization ID for Contentful

To link your Contentful account using API key, you have to specify your Instance URL , API key and Organization ID.

Contentful API key

Figure 4. Authentication Form for Contentful API key in RoboMQ Hire2Retire