Get the list of the assets of a given asset family

GET

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

Asset

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.

Request Example

Shell

JavaScript

Java

Swift

curl --location --request GET '/api/rest/v1/asset-families//assets'

Response Example

200 - Example 1

{
  "_links": {
    "first": {
      "href": "string"
    },
    "next": {
      "href": "string"
    },
    "self": {
      "href": "string"
    }
  },
  "_embedded": {
    "_items": [
      {
        "_links": {
          "self": {
            "href": "string"
          }
        },
        "code": "sku_54628_picture1",
        "created": "2023-08-15T05:53:50.698Z",
        "updated": "2023-08-15T05:53:50.698Z",
        "values": {
          "end_of_use_date": [
            {
              "channel": null,
              "data": "02/03/2021",
              "locale": null
            }
          ],
          "main_colors": [
            {
              "channel": null,
              "data": [
                "red",
                "purple"
              ],
              "locale": null
            }
          ],
          "media_preview": [
            {
              "channel": null,
              "data": "sku_54628_picture1.jpg",
              "locale": null
            }
          ],
          "model_wears_size": [
            {
              "channel": null,
              "data": "s",
              "locale": null
            }
          ],
          "photographer": [
            {
              "channel": null,
              "data": "ben_levy",
              "locale": null
            }
          ]
        }
      }
    ]
  }
}

Request

Path Params

asset_family_code

string

required

Code of the asset family

Query Params

string

optional

Filter assets, for more details see the Asset filters section

channel

string

optional

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 Filter asset values by channel section

locales

string

optional

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 Filter asset values by locale section

search_after

string

optional

Cursor when using the search_after pagination method type. Should never be set manually, see Pagination section

Responses

🟢200Return the assets of the given asset family paginated

application/json

Body

_links

object

optional

first

object

optional

object

optional

self

object

optional

_embedded

object

optional

_items

array [object {5}]

optional

🟠401Authentication required

🟠406Not Acceptable

Modified at 2023-08-15 05:53:55

Update/create an asset family

Update/create several assets