Text search across all statuses; an exact key comes first

GET

/search

const url = 'http://localhost:8100/api/v1/search?q=example&status=all&limit=50';
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request GET \
  --url 'http://localhost:8100/api/v1/search?q=example&status=all&limit=50' \
  --header 'Authorization: Bearer <token>'

Authorizations

bearerAuth

Parameters

Query Parameters

required

string

<= 200 characters

project

string

status

string

default: all

limit

integer

default: 50 >= 1 <= 100

Responses

200

Matching issues

application/json

object

data

Array<object>

object

integer

key

string

number

integer

title

string

description

string

type

object

required

string

name

required

string

current

boolean

status

object

integer

name

string

category

string

Allowed values: todo in_progress done

priority

object

required

string

name

required

string

current

boolean

labels

Array<string>

assignee

object

integer

name

string

email

string format: email

reporter

object

integer

name

string

email

string format: email

project

object

integer

key

string

name

string

parent

object

key

string

title

string

subtasks

Array<object>

object

key

string

title

string

status

string

estimate_hours

number | null

spent_hours

number

due_date

string | null format: date

url

string format: uri

created_at

string format: date-time

updated_at

string format: date-time

closed_at

string | null format: date-time

comments

Only on GET /issues/{key}

Array<object>

object

integer

author

object

integer

name

string

body

Markdown

string

created_at

string format: date-time

updated_at

string format: date-time

attachments

Only on GET /issues/{key}

Array<object>

object

integer

name

string

size

integer

type

string

url

string format: uri

Example

{
  "data": [
    {
      "key": "WEB-12",
      "status": {
        "category": "todo"
      }
    }
  ]
}