Flower REST API

Integrate Flower with Your Own Tools

About

The Flower REST API lets you interact with Flower programmatically, for example to build integrations. The reference at the end of this page documents the REST resources, the HTTP response codes, and example requests and responses.

Version and Status

Authentication and Authorization

The Flower REST API is protected in the same way as the Jira REST API. You use the same credentials as for a Jira Basic auth connection, and access follows the permissions of the Jira user. See Basic auth for REST APIs  for details.

Get an API Token (Jira Cloud)

Basic auth in Jira Cloud needs an API token instead of your password. This is more secure, because:

• You do not save your primary account password outside of where you sign in.
• You can revoke individual API tokens at any time.
• API tokens also work if your Atlassian organization has two-factor authentication or SAML enabled.

To create a token:

1. Open Atlassian account API tokens  and select Create API token.
2. Enter a name that describes what the token is for, and choose an expiration date between 1 and 365 days.
3. Copy the token and store it safely. You cannot display it again.

When a token expires, create a new one and update your integration. See Manage API tokens for your Atlassian account .

In Jira Data Center, use your username and password or a personal access token  as a bearer token.

Test Your Credentials

The following call checks your credentials with a simple Jira request. It returns your own Jira user. Use the same credentials for the Flower resources in the reference below.

# Replace the email, the API token, and the domain with your own values
curl --request GET \
  --user '[email protected]:freds_api_token' \
  --header 'Accept: application/json' \
  'https://your-domain.atlassian.net/rest/api/3/myself'

Read Flower Data with the Jira REST API

Models, process instances, and tasks are Jira work items. You can therefore also read them with Jira’s own search API and the Flower JQL fields, for example all open process instances:

# Searches all open process instances (Jira Cloud). Data Center uses /rest/api/2/search.
curl --request POST \
  --user '[email protected]:freds_api_token' \
  --header 'Content-Type: application/json' \
  --header 'Accept: application/json' \
  --data '{"jql": "flowerType = \"Process Instance\" AND resolution is EMPTY", "fields": ["summary", "status"], "maxResults": 50}' \
  'https://your-domain.atlassian.net/rest/api/3/search/jql'

See Search Flower Data with JQL for all Flower search fields.

Reference

What’s Next?

• Search Flower Data with JQL: Find models, process instances, and tasks.
• Sync Magic: Call external services from a process with throw events.
• Setup Flower: Configure space and work types.