API reference

Delivery targets

Every path is under https://impartire.com/api/v1. Generated from the API’s own contract, openapi.json (OpenAPI 3.1), which you can load into any OpenAPI tool. Errors are Problems — see Conventions.

GET/api/v1/delivery-targets

List the org's delivery targets

Where the org delivers to: an S3-compatible bucket outside the platform, or another org through a supply link (left out when the org does not have supply links). Never a target's transport configuration or credentials. For an OAuth token, its person needs the read-delivery permission (no platform-admin bypass); a key reads the whole org. 404 when the org does not have delivery, and for an OAuth token whose person may not read it.

Scopes: delivery:read

Parameters
  • limitquery · integer

    Page size, default 50. Values above 100 are treated as 100.

  • cursorquery · string

    next_cursor from the previous page.

Response 200DeliveryTargetList
  • dataarray of DeliveryTargetrequired

    Oldest first (by created_at, then id).

    • idstring (uuid)required
    • namestringrequired
    • kind"s3" | "org"required

      s3 — an S3-compatible bucket outside the platform; org — another org on the platform, through a supply link.

    • receiver_orgobject or nullrequired

      For org: the org it delivers to. Null for s3.

      • idstring (uuid)required
      • namestringrequired
    • transport_readybooleanrequired

      Whether a delivery can be made to it now (an s3 target whose transport is not attached yet cannot).

    • accepts_spec_profile_idsarray of string (uuid)required

      The specs it accepts (GET /api/v1/spec-profiles/{id}): for org, the receiver's published specs your org may still pin.

    • created_atstring (date-time)required
  • next_cursorstring or nullrequired

    Pass as cursor to get the next page; null means this is the last page.

Other responses
  • 401 unauthenticated — no key, or an unknown, revoked or expired one.
  • 403 insufficient-scope — the key lacks a required scope.
  • 404 not-found.
  • 422 validation — a bad limit or cursor.
  • 429 rate-limited — the key's request budget is spent; wait Retry-After seconds.
  • 500 internal.