v1

latestSwagger 2.02026-07-13137761.0 MB

Asset

Get the list of the assets of a given asset family

This endpoint allows you to get a list of assets of a given asset family. Assets are paginated. This endpoint is case sensitive on the asset family code.

get/api/rest/v1/asset-families/{asset_family_code}/assets

Path parameters

asset_family_codestring required

Code of the asset family

Query parameters

searchstring

Filter assets, for more details see the <a href="/documentation/filter.html#filter-assets">Asset filters</a> section

channelstring

Filter asset values to return scopable asset attributes for the given channel as well as the non localizable/non scopable asset attributes, for more details see the <a href="/documentation/filter.html#asset-values-by-channel">Filter asset values by channel</a> section

localesstring

Filter asset values to return localizable attributes for the given locales as well as the non localizable/non scopable asset attributes, for more details see the <a href="/documentation/filter.html#asset-values-by-locale">Filter asset values by locale</a> section

search_afterstring

Cursor when using the search_after pagination method type. <strong>Should never be set manually</strong>, see <a href="/documentation/pagination.html">Pagination</a> section

Response

Return the assets of the given asset family paginated

Example response

{
  "_embedded": {
    "_items": [
      {
        "code": "sku_54628_picture1",
        "values": {
          "media_preview": [
            {
              "locale": null,
              "channel": null,
              "data": "sku_54628_picture1.jpg"
            }
          ],
          "model_wears_size": [
            {
              "locale": null,
              "channel": null,
              "data": "s"
            }
          ],
          "photographer": [
            {
              "locale": null,
              "channel": null,
              "data": "ben_levy"
            }
          ],
          "main_colors": [
            {
              "locale": null,
              "channel": null,
              "data": [
                "red",
                "purple"
              ]
            }
          ],
          "end_of_use_date": [
            {
              "locale": null,
              "channel": null,
              "data": "02/03/2021"
            }
          ]
        },
        "created": "2021-05-31T09:23:34+00:00",
        "updated": "2021-05-31T09:23:34+00:00"
      }
    ]
  }
}