neosourceDocs
Search docs

What completing this cycle would do with the work still open in it

GET/api/cycles/{cycle_id}/carryover

cycleCarryover

Names the move BEFORE it happens, so a client can say it in the confirmation rather than guessing: how many unfinished issues the cycle holds, and which cycle they would move to (`to_cycle: null` = they become uncycled, because the team has no later cycle). A forecast, not a reservation — the completion receipt reports what was actually moved.

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

curl

curl -X GET 'https://neosource.dev/api/cycles/CYCLE_ID/carryover' \
  -H 'Authorization: Bearer $NEOSOURCE_TOKEN'

fetch

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

Path parameters

cycle_idrequired

string

Responses

200Carryover plan

application/json

CycleCarryoverResponse

object

What completing a cycle does with the work still open in it. The SAME shape answers `GET /api/cycles/{id}/carryover` (before the write, so the confirmation can name the move) and rides `CompleteCycleResponse` (after it, as the receipt). One shape, because the forecast and the receipt are the same two facts, and because a user who reads "3 tickets move to Cycle 26" is owed a report in the same terms. `to_cycle: null` is not "unknown" — it is the team's backlog. A cycle with no successor still ends, and its remainder becomes uncycled rather than staying pinned to a window that is over.

countrequired

integerint64

Unfinished issues: the forecast on the plan, the actual on the receipt.

to_cycle
one of

  • null

  • CycleRef

    object

    Just enough of a cycle to name it in a sentence about another cycle.

    cycle_idrequired

    string

    namerequired

    string

403Forbidden — one of: forbidden, needs_scope

application/json

one of
  • ErrorForbidden

  • NeedsScopeError

    object

    `403` body returned when listing private repos but the linked identity lacks the required provider scope. The SPA turns this into an incremental-authorization prompt (Tier 2) that calls the `/elevate` OAuth endpoint with this `scope`.

    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
  • 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