Overview

Our all-new API brings more power to your workflow. Easily create your own custom integrations using low-code tools like Zapier, or create custom scripts to share data between Tara and your favorite tools.

The Tara API is a RESTful interface, which gives you access to certain data in the system. Currently, you can use the API access to:

  • Retrieve and update a Requirement

  • Retrieve, update and create a Task

Only workspace admins can generate a key that can then be shared with their team.

Create an Access Key

Admins can generate an API key to unlock custom workflows on Tara. Here’s how:

  • Navigate to the integrations page here. Alternatively, find the integrations hub in the middle of the global navigation bar.

  • Scroll down to the API Authentication section.

  • Click on Create API key. A key will be generated immediately.

  • Share your key with your team. Note that keys expire in 60 minutes, so you will need to generate a new key after it expires.

Actions

Tara provides a public REST API that lets users retrieve and update Tara’s domain objects. Some common workflows we’re seeing teams create include sending customer feedback from Productboard into requirements, and auto logging issues from sentry. The possibilities are endless!

Currently, these are the available operations.

Requirements

Retrieve a Requirement, for example, with id = ymLxhcDpqkPrpjktIJGM

curl \

-H "Content-Type: application/json" \
-H "Authorization: Bearer <ACCESS_KEY> " \
-X GET \
https://api.tara.ai/api/requirement\?id=ymLxhcDpqkPrpjktIJGM

Update the Requirement, for example, with id = ymLxhcDpqkPrpjktIJGM, with the given data payload

curl \
-H "Content-Type: application/json" \
-H "Authorization: Bearer <ACCESS_KEY> " \
-X PUT \
-d '{"id":"ymLxhcDpqkPrpjktIJGM","title":"Task Activity History for Requirement 2","description":"Requirement Description 2"}' \
https://api.app.tara.ai/api/requirement

Tasks

Retrieve a Task, for example, with id = 1010

curl \
-H "Content-Type: application/json" \
-H "Authorization: Bearer <ACCESS_KEY> " \
-X GET \
https://api.tara.ai/api/task\?id=1010

Create a Task with this data payload

curl \
-H "Content-Type: application/json" \
-H "Authorization: Bearer <ACCESS_KEY> " \
-X POST \
-d '{"title":"Add Task 4","description":"Task Description 4","assignee":"Tim","collaborators":["Jack","Jill","Mary"],"effortLevel":10,"status":1,"url":"https://foo.bar"}' \
https://api.tara.ai/api/task

Update a Task with id = 1010, with the given data payload

curl \
-H "Content-Type: application/json" \
-H "Authorization: Bearer <ACCESS_KEY> " \
-X PUT \
-d '{"id":"1010","title":"Add Task 3","description":"Task Description 2","assignee":"Tim","collaborators":["Jack","Jill","Mary"],"effortLevel":10,"status":1,"url":"https://foo.bar"}' \
https://api.tara.ai/api/task

What's next?

Did this answer your question?