Skip to content
Developers
Get an API token

List a plan shares

List share metadata newest first, including revoked and expired shares, never tokens.

List a plan shares

GET/plans/{id}/shares

List share metadata newest first, including revoked and expired shares, never tokens. Use this to manage links. A missing or other-tenant plan is 404; no state store is 409.

Send a Novi API token as a bearer token on every request. Authentication

Parameters

Path parameters

Query parameters

  • model_setstringOptional

    pattern ^[a-z0-9][a-z0-9-]{0,62}$

    The model set to answer from, an id from GET /model-sets. Absent: the set GET /model-sets names as default, the base dataset unless the server answers from a published set.

    • model_set=default reaches the base dataset; once the server retires it, a 400 naming the set answering instead.
    • An unknown id, or a set scoped to other tenants, is a 400 listing the ids the caller may use in details.allowed (published sets only once default is retired); a set that can't load, a 503 with the reason.
    • Plans and exports stay in their set: a call naming them (by path, plan, ids, source.plan, a scenario's plan.id, or a comparison's a.plan and b.plan, also under source.comparison) reaches it without model_set.
    • An explicit model_set wins; naming resources of two sets in one request is a 400.

Responses

200 OK

Share metadata.

  • sharesarray of objectsRequired

    Newest first, including revoked and expired shares.

    ShowHide 5 child fields in each item
    • idstringRequired

      Format uuid

      Share id.

    • visibilitystringRequired

      Intended audience.

      "link""tenant"
    • created_atstringRequired

      Format date-time

      Creation time.

    • expires_atstring or nullRequired

      Format date-time

      Expiry, null for no expiry.

    • revoked_atstring or nullRequired

      Format date-time

      Revocation time, null while unrevoked.

Errors

StatusWhen
404

No such well, grid, plan or route.

409

The request conflicts with the state of the plan or resource it names, and message says how: for example a plan still running or failed, a stale If-Match, an Idempotency-Key reused with another body, or a server without a state store.

Shared errors400401403500503What they mean