REST APIs (Cloud)

Early access:
Our REST APIs are set to change in the coming months, and we probably won't be maintaining the legacy endpoints for very long.

So, if you use our REST APIs, be ready to update your integrations!

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.

Explore our REST APIs

Each product has its own REST API:

Requirement Yogi for Confluence:
- Base URL: https://confluence.requirementyogi.com
- Documentation: https://confluence.requirementyogi.com/swagger-ui/index.html
- OpenAPI specifications: https://confluence.requirementyogi.com/v3/api-docs
Requirement Yogi for Jira:
- Base URL: https://jira.requirementyogi.com
- Documentation: https://jira.requirementyogi.com/swagger-ui/index.html
- OpenAPI specifications: https://jira.requirementyogi.com/v3/api-docs

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.
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.
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.
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.
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

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:

BASH

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'