Impartire
Create an account

API reference

Asset types

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/asset-types

List the asset types the org can create assets of, with their field definitions and file slots

Each type's fields is the validation contract for fields on POST and PATCH /assets: a declared key must hold a value of its type.

Scopes: assets:read

Response 200AssetTypeList
  • dataarray of AssetTyperequired
    • idstring (uuid)required
    • namestringrequired
    • kind"asset"required
    • fieldsarray of AssetFieldrequired

      The type's live field definitions, in the app's form order. Deprecated fields, and for an OAuth token the fields its person may not read, are left out.

      • idstring (uuid)required
      • keystringrequired

        The key a value is stored under in an asset's fields.

      • namestringrequired

        The field's label, as the app shows it.

      • typestringrequired

        text | url (a string) · select (one option value) · multiselect (an array of option values) · date (YYYY-MM-DD) · datetime (epoch milliseconds) · number · reference (an id, or an array of ids when multiple). More may be added.

      • requiredbooleanrequired

        Required for the asset to be ready (a workflow gate may wait on it). Not enforced on a write: an asset may be created empty and filled in later.

      • multiplebooleanrequired

        For a reference field, whether the value is an array of ids.

      • optionsarray of object or nullrequired

        For select and multiselect, the accepted values (store value; label is for display). Null for every other type.

        • valuestringrequired
        • labelstringrequired
    • file_slotsarray of FileSlotrequired
      • idstring (uuid)required
      • namestring or nullrequired
      • media_typestringrequired

        video | image | audio | document | subtitle

      • accept_extensionsarray of string or nullrequired

        Accepted file extensions, or null for any of the media type.

      • multiplebooleanrequired

        Whether the slot holds several files.

  • next_cursorstring or nullrequired

    Always null: the list is returned whole.

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.
  • 429 rate-limited — the key's request budget is spent; wait Retry-After seconds.
  • 500 internal.