REST APIs (Cloud)

At Requirement Yogi, we’re committed to continuously enhancing our products to meet the evolving needs of our customers. However, we understand that there are instances where you may require additional functionalities beyond what our products currently offer. For example, you may need to generate intricate reports by consolidating data coming from multiple systems, automate tasks based on the properties of your requirements, etc. If that's the case, our REST APIs empower you to extend the capabilities of our products to better fulfill your needs.

Available APIs and regions

Each REST API is available in two data residency regions: Europe and USA.

Use the region where your Requirement Yogi data is hosted: USA if your Atlassian site is pinned to the US, otherwise Europe (the default). See Data residency for details.

REST API (Recommended)

Requirement Yogi for Confluence

Requirement Yogi for Jira

Authentication

Prerequisites

In order to access the REST APIs, you need to:

• Create a Requirement Yogi account.

• Link an Atlassian account to your Requirement Yogi account.

• Generate a personal access token.

Create an account

To create a Requirement Yogi account:

• Go to https://app.requirementyogi.com (resp. https://app.us.requirementyogi.com for US region).

• In the top navigation bar, click the sign in button.

• Click the Register button.

• Fill the registration form.

• Submit the form.

• Once registered, you will receive a verification email.

• Click the provided link to verify your email address.

Link an Atlassian account

To link an Atlassian account to your Requirement Yogi account:

• Go to https://app.requirementyogi.com (resp. https://app.us.requirementyogi.com for US region).

• Log in to your Requirement Yogi account.

• In the top navigation bar, click the profile button.

• Navigate to Settings.

• In the left sidebar, navigate to Linked accounts.

• Click the Link button.

• You will be redirected to the Atlassian authorization prompt.

• You will be asked to log in to your Atlassian account if you haven’t already.

• Choose the Atlassian site for which you want to use our REST APIs.

• Make sure you agree with the requested permissions.

• Make sure you’ve read our Privacy Policy and our Terms of Use.

• Click the Accept button.

• You can repeat the link process to authorize access to our REST APIs for multiple Atlassian sites.

• Please note that permissions are checked against the permissions of your linked Atlassian account.

• Make sure the linked Atlassian account has the appropriate permissions for your use cases.

Unlink the Atlassian account

To unlink the Atlassian account from your Requirement Yogi account:

• Go to https://app.requirementyogi.com (resp. https://app.us.requirementyogi.com for US region).

• Log in to your Requirement Yogi account.

• In the top navigation bar, click the profile button.

• Navigate to Settings.

• In the left sidebar, navigate to “Linked accounts”.

• Click the Unlink button.

• To completely unlink the Atlassian account, you also need to revoke the Requirement Yogi integration from your Atlassian account settings.

Revoke the Requirement Yogi integration

We retrieve the accessible Atlassian sites from the Atlassian REST API.

If you need to revoke the Requirement Yogi integration or reset the accessible Atlassian sites:

• Go to https://id.atlassian.com.

• Log in to your Atlassian account.

• In the top navigation bar, click the profile button.

• Navigate to Account settings.

• In the top navigation bar, navigate to Connected apps.

• Locate the Requirement Yogi integration app.

• Click the Remove access button.

Generate a personal access token

To generate a personal access token:

• Go to https://app.requirementyogi.com (resp. https://app.us.requirementyogi.com for US region).

• Log in to your Requirement Yogi account.

• In the top navigation bar, click the profile button.

• Navigate to Settings.

• In the left sidebar, navigate to Personal access tokens.

• Click the Generate new token button.

• Choose a descriptive to name to identify the personal access token.

• Choose the expiration of the personal access token.

• Click the Generate button.

• Make sure to copy the personal access token.

• For security reasons, it will never be shown again.

Make calls to the REST APIs

Use the base URL of your region (see Available APIs and regions) and authenticate with your personal access token.

How you pass the token and select your application depends on the API:

REST API

• Choose the endpoint you want to use.

• Add a Authorization header to your request containing “Bearer " followed by your personal access token.

• Set the applicationId query param when documented to define the application you are working on.

• You can fetch the application id from the REST API itself by using GET /organizations or you can get it from the support tab in the administration page of the Confluence and Jira apps.

• Send the request:

curl -L 'https://api.requirementyogi.com/api/requirements?applicationId=YOUR_APPLICATION_ID&limit=20' \
  -H 'Authorization: Bearer YOUR_TOKEN'

Confluence and Jira REST APIs

• Choose the endpoint you want to use.

• Add a X-Base-Url header to your request containing the base URL of your Atlassian site (e.g. https://example.atlassian.net/wiki for a Confluence instance, https://example.atlassian.net for a Jira instance).

• Add a X-Api-Key header to your request containing your personal access token.

• Send the request:

curl -L 'https://confluence.requirementyogi.com/rest/search?query=&limit=200&offset=0&spaceKey=SPACE' \
  -H 'X-Base-Url: https://example.atlassian.net/wiki' \
  -H 'X-Api-Key: YOUR_TOKEN'

Rate Limits

Rate limits on our REST APIs are 200 requests per minute (for most endpoints) and up to 2000 requests per minute (for a few rare, high-traffic endpoints).

If a rate limit is exceeded, we return a response with status “429 Too Many Requests”.

Additionally, in all REST API responses, we include headers so that API consumers can track their usage:

• X-Rate-Limit-Limit : the maximum number of requests allowed in a rate-limit window

• X-Rate-Limit-Remaining : the number of remaining requests in the current rate-limit window

• X-Rate-Limit-Reset : the number of seconds until the next rate-limit window

Deprecated endpoints

When we replace an endpoint, we first mark the old one as deprecated so you have time to migrate.

The deprecated endpoints are crossed out in the documentation, and their description gives the deprecation date, the removal date once one is set, and a link to the replacement endpoint.

Additionally, in all responses from a deprecated endpoint, we include headers so that API consumers can plan their migration:

• Deprecation : the date the endpoint was deprecated, or true if no date is given

• Sunset : the date the endpoint will be removed, only present once a removal date is set

• Link : the path of the replacement endpoint

From the removal date, the endpoint returns a response with status “410 Gone”. We give at least 1 month notice before removing an endpoint, and usually aim for up to 3-6 months to give you enough time to migrate.

Experimental endpoints

Some endpoints are marked as “Experimental 🧪”. This means they are available for early feedback but are not yet stable.

Experimental endpoints may evolve at any time:

• Their path, parameters, or response format may change.

• Their behavior may be adjusted based on feedback.

• They may be removed or replaced without prior notice.

We do not recommend relying on experimental endpoints in production integrations. Once an endpoint is stable, the experimental label is removed and the endpoint follows the standard versioning policy.