Skip to content
Pile
Esc
↑↓navigate↵open⌘Jpreview

List issue similar

GET/workspaces/{organizationId}/issues/{id}/similar
Path parameters
organizationIdstringrequired
idstringrequired
Query parameters
limitinteger
min 1 · max 50
Responses
200

Issues whose title/description best match this issue (BM25 over the workspace search index), best first

similarobject[]required
Show properties
Array of object
issueIssuerequired
Show properties
idstringrequired
organizationIdstringrequired
externalRefstring | nullrequired
teamIdstringrequired
titlestringrequired
descriptionstring | nullrequired
statusstringrequired
Allowed:triagebacklogtodoin_progressdonecanceled
prioritystringrequired
Allowed:lowmediumhighurgent
resolutionstring | nullrequired
Allowed:duplicatenot_plannedintended_behaviornot_reproducibleobsoleteresolvednull
parentIdstring | nullrequired
subIssueSortOrdernumber | nullrequired
estimatenumber | nullrequired
isDraftbooleanrequired
snoozedUntilstring | nullrequired
assigneeIdstring | nullrequired
projectIdstring | nullrequired
cycleIdstring | nullrequired
labelIdsstring | nullrequired
numbernumber | nullrequired
identifierstring | nullrequired
repostring | nullrequired
branchstring | nullrequired
prUrlstring | nullrequired
prStatestring | nullrequired
prCheckStatestring | nullrequired
createdAtstringrequired
updatedAtstringrequired
scorenumberrequired
Try it
Server
Parameters
Request
curl -X GET '/workspaces/string/issues/string/similar'
Response
{
  "similar": [
    {
      "issue": {
        "id": "string",
        "organizationId": "string",
        "externalRef": "string",
        "teamId": "string",
        "title": "string",
        "description": "string",
        "status": "triage",
        "priority": "low",
        "resolution": "duplicate",
        "parentId": "string",
        "subIssueSortOrder": 0,
        "estimate": 0,
        "isDraft": true,
        "snoozedUntil": "string",
        "assigneeId": "string",
        "projectId": "string",
        "cycleId": "string",
        "labelIds": "string",
        "number": 0,
        "identifier": "string",
        "repo": "string",
        "branch": "string",
        "prUrl": "string",
        "prState": "string",
        "prCheckState": "string",
        "createdAt": "string",
        "updatedAt": "string"
      },
      "score": 0
    }
  ]
}