Akeneo PIM REST API
  1. Asset family
Akeneo PIM REST API
  • Authentication
    • Get authentication token
      POST
  • Overview
    • Get list of all endpoints
      GET
  • PAM asset category
    • Get list of PAM asset categories
      GET
    • Update/create several PAM asset categories
      PATCH
    • Create a new PAM asset category
      POST
    • Get a PAM asset category
      GET
    • Update/create a PAM asset category
      PATCH
  • Asset family
    • Get list of asset families
      GET
    • Get an asset family
      GET
    • Update/create an asset family
      PATCH
  • Asset
    • Get the list of the assets of a given asset family
      GET
    • Update/create several assets
      PATCH
    • Delete an asset
      DELETE
    • Get an asset of a given asset family
      GET
    • Update/create an asset
      PATCH
  • Asset attribute
    • Get the list of attributes of a given asset family
      GET
    • Get an attribute of a given asset family
      GET
    • Update/create an attribute of a given asset family
      PATCH
  • Asset attribute option
    • Get a list of attribute options of a given attribute for a given asset family
      GET
    • Get an attribute option for a given attribute of a given asset family
      GET
    • Update/create an asset attribute option for a given asset family
      PATCH
  • Asset media file
    • Create a new media file for an asset
      POST
    • Download the media file associated to an asset
      GET
  • PAM asset tag
    • Get list of PAM asset tags
    • Get a PAM asset tag
    • Update/create a PAM asset tag
  • PAM asset
    • Get list of PAM assets
    • Update/create several PAM assets
    • Create a new PAM asset
    • Get a PAM asset
    • Update/create a PAM asset
  • PAM asset reference file
    • Get a reference file
    • Upload a new reference file
    • Download a reference file
  • PAM asset variation file
    • Get a variation file
    • Upload a new variation file
    • Download a variation file
  • Association type
    • Get a list of association types
    • Update/create several association types
    • Create a new association type
    • Get an association type
    • Update/create an association type
  • Attribute group
    • Get list of attribute groups
    • Update/create several attribute groups
    • Create a new attribute group
    • Get an attribute group
    • Update/create an attribute group
  • Attribute
    • Get list of attributes
    • Update/create several attributes
    • Create a new attribute
    • Get an attribute
    • Update/create an attribute
  • Attribute option
    • Get list of attribute options
    • Update/create several attribute options
    • Create a new attribute option
    • Get an attribute option
    • Update/create an attribute option
  • Category
    • Get list of categories
    • Update/create several categories
    • Create a new category
    • Get a category
    • Update/create a category
    • Download a category media file [COMING SOON]
  • Channel
    • Get a list of channels
    • Update/create several channels
    • Create a new channel
    • Get a channel
    • Update/create a channel
  • Currency
    • Get a list of currencies
    • Get a currency
  • Family
    • Get list of families
    • Update/create several families
    • Create a new family
    • Get a family
    • Update/create a family
    • Create a new family variant
  • Family variant
    • Get list of family variants
    • Update/create several family variants
    • Get a family variant
    • Update/create a family variant
  • Locale
    • Get a list of locales
    • Get a locale
  • Measure family
    • Get list of measure familiy
    • Get a measure family
  • Measurement family
    • Get list of measurement families
    • Update/create several measurement families
  • Product media file
    • Get a list of product media files
    • Create a new product media file
    • Get a product media file
    • Download a product media file
  • Product model
    • Get list of product models
    • Update/create several product models
    • Create a new product model
    • Delete a product model
    • Get a product model
    • Update/create a product model
    • Get a draft
    • Submit a draft for approval
  • Product
    • Get list of products
    • Update/create several products
    • Create a new product
    • Delete a product
    • Get a product
    • Update/create a product
    • Get a draft
    • Submit a draft for approval
  • Published product
    • Get list of published products
    • Get a published product
  • Reference entity
    • Get list of reference entities
    • Get a reference entity
    • Update/create a reference entity
  • Reference entity media file
    • Create a new media file for a reference entity or a record
    • Download the media file associated to a reference entity or a record
  • Reference entity attribute
    • Get the list of attributes of a given reference entity
    • Get an attribute of a given reference entity
    • Update/create an attribute of a given reference entity
  • Reference entity attribute option
    • Get a list of attribute options of a given attribute for a given reference entity
    • Get an attribute option for a given attribute of a given reference entity
    • Update/create a reference entity attribute option
  • Reference entity record
    • Get the list of the records of a reference entity
    • Update/create several reference entity records
    • Get a record of a given reference entity
    • Update/create a record of a given reference entity
  • System
    • Get system information
    • Get system information
  • Catalogs
    • Get the list of owned catalogs
    • Create a new catalog
    • Delete a catalog
    • Get a catalog
    • Update a catalog
  • Catalog products
    • Get the list of product uuids
    • Get the list of products related to a catalog
    • Get a product related to a catalog
  • Product [identifier]
    • Get list of products
    • Update/create several products
    • Create a new product
    • Delete a product
    • Get a product
    • Update/create a product
    • Get a draft
    • Submit a draft for approval
  • Product [uuid]
    • Get list of products
    • Update/create several products
    • Create a new product
    • Delete a product
    • Get a product
    • Update/create a product
    • Get a draft
    • Submit a draft for approval
  1. Asset family

Get list of asset families

GET
/api/rest/v1/asset-families
Asset family
This endpoint allows you to get a list of asset families. Asset families are paginated.
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request GET '/api/rest/v1/asset-families'
Response Response Example
200 - Example 1
{
    "_links": {
        "first": {
            "href": "string"
        },
        "next": {
            "href": "string"
        },
        "self": {
            "href": "string"
        }
    },
    "_embedded": {
        "items": [
            {
                "_links": {
                    "self": {
                        "href": "string"
                    }
                },
                "attribute_as_main_media": "main_image",
                "code": "model_pictures",
                "labels": {
                    "en_US": "Model pictures",
                    "fr_FR": "Photographies en pied"
                },
                "naming_convention": {
                    "abort_asset_creation_on_error": true,
                    "pattern": "/(?P<product_ref>.*)-.*/",
                    "source": {
                        "channel": null,
                        "locale": null,
                        "property": "code"
                    }
                },
                "product_link_rules": [
                    {
                        "assign_assets_to": [
                            {
                                "attribute": "model_pictures",
                                "mode": "replace"
                            }
                        ],
                        "product_selections": [
                            {
                                "field": "sku",
                                "operator": "EQUALS",
                                "value": "{{product_ref}}"
                            }
                        ]
                    }
                ],
                "transformations": [
                    {
                        "filename_suffix": "_thumbnailBW",
                        "label": "Thumbnail plus black and white transformation",
                        "operations": [
                            {
                                "parameters": {
                                    "height": 150,
                                    "width": 150
                                },
                                "type": "thumbnail"
                            },
                            {
                                "parameters": {
                                    "colorspace": "grey"
                                },
                                "type": "colorspace"
                            }
                        ],
                        "source": {
                            "attribute": "main_image",
                            "channel": null,
                            "locale": null
                        },
                        "target": {
                            "attribute": "thumbnail",
                            "channel": null,
                            "locale": null
                        }
                    }
                ]
            }
        ]
    }
}

Request

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

Responses

🟢200Return asset families paginated
application/json
Body
_links
object 
optional
first
object 
optional
next
object 
optional
self
object 
optional
_embedded
object 
optional
items
array [object {7}] 
optional
🟠401Authentication required
🟠406Not Acceptable
Previous
Update/create a PAM asset category
Next
Get an asset family
Built with