younifyd
Menu

Get Assets

Get the list of the assets of a given asset family

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

Use it in a workflow

  1. Add a step and choose the Akeneo connector.
  2. Pick the Get Assets action (under Asset).
  3. Fill in the fields below, then reference the result from later steps as {{getAssets.response.data}}.

Request

Path parameters

asset_family_codestringrequired

This path parameter is used to specify the unique identifier of the asset family you want to retrieve or manipulate. It is essential for identifying the specific asset family in the API requests. Ensure that the asset family code is correctly formatted and corresponds to an existing asset family in the system.

Query parameters

searchstring

Filter assets, for more details see the [Asset filters](https://api.akeneo.com/documentation/filter.html#filter-assets) 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 [Filter asset values by channel](https://api.akeneo.com/documentation/filter.html#asset-values-by-channel) section.

localesstring

Filter asset values to return localizable asset 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](https://api.akeneo.com/documentation/filter.html#asset-values-by-locale) section.

search_afterstring

Cursor when using the `search_after` pagination method type. It is essential for navigating through pages in cursor-based pagination, providing more efficient pagination for large datasets. Should never be set manually, see [Pagination](https://api.akeneo.com/documentation/pagination.html) section for more details.

Default "cursor to the first page"

with_asset_auto_tagsboolean

Return labels of asset tags generated by auto-tagging in the response. When set to `true`, the response will include human-readable labels for asset tags alongside their codes. If set to `false`, the response will only include tag codes, which can improve performance. See [the `linked_data` format](https://api.akeneo.com/concepts/asset-manager.html#the-linked_data-format) section for more details.

Default false

Response

Returns 200 with an object. Read it in later steps with {{getAssets.response.data.<field>}}.

Need more? See the Akeneo guide for connection setup and behaviour shared by every action.

Get Assets — Akeneo — Documentation