Uploaded image for project: 'Jira Platform Cloud'
  1. Jira Platform Cloud
  2. JRACLOUD-70163

The /rest/api/3/search endpoint example is missing the search parameter

XMLWordPrintable

      The example for the endpoint /rest/api/3/search in the Jira Cloud REST API documentation is incomplete:

      Indeed, the provided example is the below one:

      curl --request GET \
  --url 'https://your-domain.atlassian.net/rest/api/3/search' \
  --user 'email@example.com:<api_token>' \
  --header 'Accept: application/json'

      However, the above example is missing to show the actual JQL query (url encoded) to be added after the jql parameter.

      The example should be corrected and the JQL parameter should be added to the url. Something like (project = Test Project"):

      curl --request GET \
  --url 'https://your-domain.atlassian.net/rest/api/3/search?jql=project%20%3D%20"Test%20Project"' \
  --user 'email@example.com:<api_token>' \
  --header 'Accept: application/json'

            [JRACLOUD-70163] The /rest/api/3/search endpoint example is missing the search parameter

            Dario B added a comment -

            This issue has been fixed

            Dario B added a comment - This issue has been fixed

              alui Andrew
              dbonotto Dario B
              Affected customers:
              0 This affects my team
              Watchers:
              3 Start watching this issue

                Created:
                Updated:
                Resolved: