API Explorer

The API Explorer is built into the Live Fields script editor and gives you access to a complete reference for the Jira Cloud Platform API. This reference includes the full Atlassian documentation of their Cloud Platform API and includes details on the REST endpoint, Responses, and Code snippets for quickly copying and pasting into your scripts! Additionally, it includes testing features for you to test the responses for your Jira instance. Refer to the sections below for more information.

To access the API Explorer, click the link in the upper right corner of the script editor. Individual APIs are listed on the left; expand an API and select an endpoint to view it’s details on the right.

Features

In addition to the endpoint, Description, Parameters, and Responses sections, the API Explorer also includes:

• Search - Above the list of APIs is the Search field where you can filter the list by terms.

• Code snippet - Example code that can be copied and pasted into your script.

• Try It Out - For some endpoints, you can test them against your Jira instance by entering one of the parameters. Click Send Request to submit the request and view the response.