Docs
Search docs

List PRs linked to an issue

GET/api/issues/{issue_id}/pull-requests

listIssuePullRequests

Authentication is not described for this operation in the spec — that does not mean it is public. Check tokens and scopes.

curl

curl -X GET 'https://neosource.dev/api/issues/ISSUE_ID/pull-requests'

fetch

fetch("https://neosource.dev/api/issues/ISSUE_ID/pull-requests", {
  method: "GET",
});

Path parameters

issue_idrequired

string

Responses

200Linked PRs

application/json

IssuePrLinkListResponse

object

linksrequired

array

items

IssuePrLinkResponse

object

created_atrequired

integerint64

created_byrequired

string

issue_idrequired

string

link_kindrequired
IssuePrLinkKind
originrequired
IssuePrLinkOrigin
pr_idrequired

string

pr_number

integer | nullint32

PR coordinates resolved at read time (route-layer enrichment on the issue-side listing) so the SPA can render `owner/repo#N` links. `None` on the PR-side listing or if the PR row went away.

pr_status
one of
pr_title

string | null

repo_name

string | null

repo_owner

string | null

403Forbidden — one of: forbidden, needs_scope

application/json

one of
  • ErrorForbidden

  • NeedsScopeError

    object

    `403` body returned when a classic OAuth token is asked for something its granted scopes do not cover — an explicit private listing without `repo`, or the one-click GitHub mirror without `admin:public_key`. `scope` names the missing grant so the client can say exactly what the token lacks. There is no elevation route to widen it any more (a re-link goes through the GitHub App, whose tokens carry no scopes), so the client's answer is to say so, never to start a handshake.

    errorrequired

    string

    Always `needs_scope` — this body exists to carry the extra fields that kind needs.

    "needs_scope"

    scoperequired

    string

    The provider scope to request via elevation (e.g. `"repo"`).

Standard errors

Bodies documented once for the whole API — see standard errors.

  • 400Bad Request — one of: invalid_input
  • 404Not Found — one of: not_found
  • 429Rate limited — retry after the `Retry-After` header
  • 500Internal server error
  • 503Service temporarily unavailable / at capacity — retry after the `Retry-After` header
  • 504Gateway timeout — the request exceeded the server's handling budget

Schemas

Referenced above. Listed here rather than expanded inline, so the same definition is not repeated at every level.

IssuePrLinkKind

string

How a PR relates to an issue. `Fixes` links auto-transition the issue's status; `References` links are advisory backlinks only.

"fixes""references"

IssuePrLinkOrigin

string

Where an issue ↔ PR link came from — the `issue_pr_link_origin` Pg enum. `Derived` links are re-derived from the PR (description magic words and source branch name) on every create and description edit, which deletes and re-kinds them freely. `Manual` links were added from the issue side and are never touched by that pass; only an explicit unlink removes one.

"derived""manual"

PullRequestStatus

string

Lifecycle status of a pull request.

"open""merged""closed"