Docs
Search docs

List the current user's favorites

GET/api/user/favorites

listUserFavorites

Returns up to 50 of the authenticated user's favorites (repositories, teams, issues and tickets), newest first, each with the route parts needed to link it. Only favorites the caller can currently read are listed: a favorite whose repository went private, whose grant was revoked, or whose team the caller left is omitted (the favorite itself is kept, and reappears when access is restored).

Requires authentication using a bearer token or a session cookie — see tokens and scopes.

curl

curl -X GET 'https://neosource.dev/api/user/favorites' \
  -H 'Authorization: Bearer $NEOSOURCE_TOKEN'

fetch

fetch("https://neosource.dev/api/user/favorites", {
  method: "GET",
  headers: {
    Authorization: "Bearer $NEOSOURCE_TOKEN",
  },
});

Responses

200Favorites

application/json

FavoriteListResponse

object

`GET /api/user/favorites`: the caller's favorites, newest first.

itemsrequired

array

items

FavoriteResponse

object

One favorite the caller can currently read.

created_atrequired

integerint64

Unix milliseconds.

favorite_idrequired

string

issue
labelrequired

string

What the rail paints: the repo slug, the team name, or the issue title.

repo
targetrequired
FavoriteTargetRef
team

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
  • 401Authentication required
  • 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.

FavoriteIssueParts

object

A favorited issue or ticket. The flat ref fields are the `IssueLinkTargetLike` shape (`lib/issues/kind.ts`), so the SPA's `issueLinkTargetHref` / `issueLinkTargetRef` accept it unchanged: a ticket sets `team_key` + `team_owner`, a repo issue `primary_repo_id` + `repo_owner` + `repo_name`.

numberrequired

integerint32

primary_repo_id

string | null

`None` for a ticket.

repo_name

string | null

repo_owner

string | null

Repo issues only: the repo route for `owner/repo#N`.

statusrequired

IssueStatus

string

"backlog""todo""in_progress""in_review""done""cancelled""duplicate"

team_key

string | null

Tickets only: `KEY` in `KEY-N`.

team_owner

string | null

Tickets only: the team's workspace slug.

titlerequired

string

FavoriteRepoParts

object

A favorited repo's route: `/{owner}/{slug}`.

ownerrequired

string

slugrequired

string

FavoriteTargetRef

object

What a favorite points at, on the wire: `{kind, id}`. `id` is the target's typed id (a repo, team or issue id).

idrequired

string

kindrequired

FavoriteKind

string

The closed set of things a favorite can point at. The wire form of a favorite's target kind; [`FavoriteTarget`] carries the typed id.

"repo""team""issue"

FavoriteTeamParts

object

A favorited team's route: `/{owner}/teams/{key}`.

keyrequired

string

namerequired

string

ownerrequired

string

The team's workspace slug.