# Akeneo PIM REST API API

> Akeneo PIM REST API API on Apizie: 144 endpoints (Get authentication token, Get list of all endpoints, Get list of PAM asset categories, Create a new PAM asset category, …) returned as clean JSON through one API key. 144 endpoints are live now. Call it over REST at https://apizie.tech/v1/business:akeneo/{endpoint} or from Claude, ChatGPT and Cursor through the Apizie MCP server. Free plan: 1,000 requests a month.

- Project key: `business:akeneo`
- Category: Business
- Status: live
- Source: https://akeneo.com
- Page: https://apizie.tech/api/business/akeneo
- OpenAPI: https://apizie.tech/api/business/akeneo/openapi.json



## Endpoints

### Get authentication token
`POST https://apizie.tech/v1/business:akeneo/post-token`

| Parameter | Type | Required | Description |
|---|---|---|---|
| body | object | no | JSON request body |

### Get list of all endpoints
`GET https://apizie.tech/v1/business:akeneo/get-endpoints`

### Get list of PAM asset categories
`GET https://apizie.tech/v1/business:akeneo/get-asset-categories`

| Parameter | Type | Required | Description |
|---|---|---|---|
| page | integer | no | Number of the page to retrieve when using the `page` pagination method type. Should never be set manually , see Pagination section |
| limit | integer | no | Number of results by page, see Pagination section |
| with_count | boolean | no | Return the count of items in the response. Be carefull with that, on a big catalog, it can decrease performance in a significative way |

### Create a new PAM asset category
`POST https://apizie.tech/v1/business:akeneo/post-asset-categories`

| Parameter | Type | Required | Description |
|---|---|---|---|
| body | object | no | JSON request body |

### Update/create several PAM asset categories
`POST https://apizie.tech/v1/business:akeneo/patch-asset-categories`

| Parameter | Type | Required | Description |
|---|---|---|---|
| body | object | no | JSON request body |

### Get a PAM asset category
`GET https://apizie.tech/v1/business:akeneo/get-asset-categories-code`

| Parameter | Type | Required | Description |
|---|---|---|---|
| code | string | yes | Code of the resource |

### Update/create a PAM asset category
`POST https://apizie.tech/v1/business:akeneo/patch-asset-categories-code`

| Parameter | Type | Required | Description |
|---|---|---|---|
| code | string | yes | Code of the resource |
| body | object | yes | JSON request body |

### Get list of asset families
`GET https://apizie.tech/v1/business:akeneo/get-asset-families`

| Parameter | Type | Required | Description |
|---|---|---|---|
| search_after | string | no | Cursor when using the `search_after` pagination method type. Should never be set manually , see Pagination section |

### Get the list of the assets of a given asset family
`GET https://apizie.tech/v1/business:akeneo/get-assets`

| Parameter | Type | Required | Description |
|---|---|---|---|
| search | string | no | Filter assets, for more details see the Asset filters section |
| channel | string | no | Filter asset values to return scopable asset attributes for the given channel as well as the non localizable/non scopable asset… |
| locales | string | no | Filter asset values to return localizable attributes for the given locales as well as the non localizable/non scopable asset attributes,… |
| asset_family_code | string | yes | Code of the asset family |
| search_after | string | no | Cursor when using the `search_after` pagination method type. Should never be set manually , see Pagination section |

### Update/create several assets
`POST https://apizie.tech/v1/business:akeneo/patch-assets`

| Parameter | Type | Required | Description |
|---|---|---|---|
| asset_family_code | string | yes | Code of the asset family |
| body | object | yes | JSON request body |

### Get an asset of a given asset family
`GET https://apizie.tech/v1/business:akeneo/get-assets-code`

| Parameter | Type | Required | Description |
|---|---|---|---|
| asset_family_code | string | yes | Code of the asset family |
| code | string | yes | Code of the resource |

### Update/create an asset
`POST https://apizie.tech/v1/business:akeneo/patch-asset-code`

| Parameter | Type | Required | Description |
|---|---|---|---|
| asset_family_code | string | yes | Code of the asset family |
| code | string | yes | Code of the resource |
| body | object | yes | JSON request body |

### Delete an asset
`POST https://apizie.tech/v1/business:akeneo/delete-assets-code`

| Parameter | Type | Required | Description |
|---|---|---|---|
| asset_family_code | string | yes | Code of the asset family |
| code | string | yes | Code of the resource |

### Get the list of attributes of a given asset family
`GET https://apizie.tech/v1/business:akeneo/get-asset-families-code-attributes`

| Parameter | Type | Required | Description |
|---|---|---|---|
| asset_family_code | string | yes | Code of the asset family |

### Get a list of attribute options of a given attribute for a given asset family
`GET https://apizie.tech/v1/business:akeneo/get-asset-family-attributes-attribute-code-options`

| Parameter | Type | Required | Description |
|---|---|---|---|
| asset_family_code | string | yes | Code of the asset family |
| attribute_code | string | yes | Code of the attribute |

### Get an attribute option for a given attribute of a given asset family
`GET https://apizie.tech/v1/business:akeneo/get-asset-attributes-attribute-code-options-code`

| Parameter | Type | Required | Description |
|---|---|---|---|
| asset_family_code | string | yes | Code of the asset family |
| attribute_code | string | yes | Code of the attribute |
| code | string | yes | Code of the resource |

### Update/create an asset attribute option for a given asset family
`POST https://apizie.tech/v1/business:akeneo/patch-asset-attributes-attribute-code-options-code`

| Parameter | Type | Required | Description |
|---|---|---|---|
| asset_family_code | string | yes | Code of the asset family |
| attribute_code | string | yes | Code of the attribute |
| code | string | yes | Code of the resource |
| body | object | yes | JSON request body |

### Get an attribute of a given asset family
`GET https://apizie.tech/v1/business:akeneo/get-asset-family-attributes-code`

| Parameter | Type | Required | Description |
|---|---|---|---|
| asset_family_code | string | yes | Code of the asset family |
| code | string | yes | Code of the resource |

### Update/create an attribute of a given asset family
`POST https://apizie.tech/v1/business:akeneo/patch-asset-family-attributes-code`

| Parameter | Type | Required | Description |
|---|---|---|---|
| asset_family_code | string | yes | Code of the asset family |
| code | string | yes | Code of the resource |
| body | object | yes | JSON request body |

### Get an asset family
`GET https://apizie.tech/v1/business:akeneo/get-asset-family-code`

| Parameter | Type | Required | Description |
|---|---|---|---|
| code | string | yes | Code of the resource |

### Update/create an asset family
`POST https://apizie.tech/v1/business:akeneo/patch-asset-family-code`

| Parameter | Type | Required | Description |
|---|---|---|---|
| code | string | yes | Code of the resource |
| body | object | yes | JSON request body |

### Create a new media file for an asset
`POST https://apizie.tech/v1/business:akeneo/post-asset-media-files`

| Parameter | Type | Required | Description |
|---|---|---|---|
| body | object | no | JSON request body |

### Download the media file associated to an asset
`GET https://apizie.tech/v1/business:akeneo/get-asset-media-files-code`

| Parameter | Type | Required | Description |
|---|---|---|---|
| code | string | yes | Code of the resource |

### Get list of PAM asset tags
`GET https://apizie.tech/v1/business:akeneo/get-asset-tags`

| Parameter | Type | Required | Description |
|---|---|---|---|
| page | integer | no | Number of the page to retrieve when using the `page` pagination method type. Should never be set manually , see Pagination section |
| limit | integer | no | Number of results by page, see Pagination section |
| with_count | boolean | no | Return the count of items in the response. Be carefull with that, on a big catalog, it can decrease performance in a significative way |

### Get a PAM asset tag
`GET https://apizie.tech/v1/business:akeneo/get-asset-tags-code`

| Parameter | Type | Required | Description |
|---|---|---|---|
| code | string | yes | Code of the resource |

### Update/create a PAM asset tag
`POST https://apizie.tech/v1/business:akeneo/patch-asset-tags-code`

| Parameter | Type | Required | Description |
|---|---|---|---|
| code | string | yes | Code of the resource |
| body | object | yes | JSON request body |

### Get list of PAM assets
`GET https://apizie.tech/v1/business:akeneo/get-pam-assets`

| Parameter | Type | Required | Description |
|---|---|---|---|
| pagination_type | string | no | Pagination method type, see Pagination section |
| page | integer | no | Number of the page to retrieve when using the `page` pagination method type. Should never be set manually , see Pagination section |
| search_after | string | no | Cursor when using the `search_after` pagination method type. Should never be set manually , see Pagination section |
| limit | integer | no | Number of results by page, see Pagination section |
| with_count | boolean | no | Return the count of items in the response. Be carefull with that, on a big catalog, it can decrease performance in a significative way |

### Create a new PAM asset
`POST https://apizie.tech/v1/business:akeneo/post-pam-assets`

| Parameter | Type | Required | Description |
|---|---|---|---|
| body | object | no | JSON request body |

### Update/create several PAM assets
`POST https://apizie.tech/v1/business:akeneo/patch-pam-assets`

| Parameter | Type | Required | Description |
|---|---|---|---|
| body | object | no | JSON request body |

### Get a reference file
`GET https://apizie.tech/v1/business:akeneo/get-reference-files-locale-code`

| Parameter | Type | Required | Description |
|---|---|---|---|
| asset_code | string | yes | Code of the asset |
| locale_code | string | yes | Code of the locale if the asset is localizable or equal to `no-locale` if the asset is not localizable |

### Upload a new reference file
`POST https://apizie.tech/v1/business:akeneo/post-reference-files-locale-code`

| Parameter | Type | Required | Description |
|---|---|---|---|
| asset_code | string | yes | Code of the asset |
| locale_code | string | yes | Code of the locale if the asset is localizable or equal to `no-locale` if the asset is not localizable |
| body | object | no | JSON request body |

### Download a reference file
`GET https://apizie.tech/v1/business:akeneo/get-reference-files-channel-code-locale-code-download`

| Parameter | Type | Required | Description |
|---|---|---|---|
| asset_code | string | yes | Code of the asset |
| locale_code | string | yes | Code of the locale if the asset is localizable or equal to `no-locale` if the asset is not localizable |

### Get a variation file
`GET https://apizie.tech/v1/business:akeneo/get-variation-files-channel-code-locale-code`

| Parameter | Type | Required | Description |
|---|---|---|---|
| asset_code | string | yes | Code of the asset |
| channel_code | string | yes | Code of the channel |
| locale_code | string | yes | Code of the locale if the asset is localizable or equal to `no-locale` if the asset is not localizable |

### Upload a new variation file
`POST https://apizie.tech/v1/business:akeneo/post-variation-files-channel-code-locale-code`

| Parameter | Type | Required | Description |
|---|---|---|---|
| asset_code | string | yes | Code of the asset |
| channel_code | string | yes | Code of the channel |
| locale_code | string | yes | Code of the locale if the asset is localizable or equal to `no-locale` if the asset is not localizable |
| body | object | no | JSON request body |

### Download a variation file
`GET https://apizie.tech/v1/business:akeneo/get-variation-files-channel-code-locale-code-download`

| Parameter | Type | Required | Description |
|---|---|---|---|
| asset_code | string | yes | Code of the asset |
| channel_code | string | yes | Code of the channel |
| locale_code | string | yes | Code of the locale if the asset is localizable or equal to `no-locale` if the asset is not localizable |

### Get a PAM asset
`GET https://apizie.tech/v1/business:akeneo/get-pam-assets-code`

| Parameter | Type | Required | Description |
|---|---|---|---|
| code | string | yes | Code of the resource |

### Update/create a PAM asset
`POST https://apizie.tech/v1/business:akeneo/patch-pam-assets-code`

| Parameter | Type | Required | Description |
|---|---|---|---|
| code | string | yes | Code of the resource |
| body | object | yes | JSON request body |

### Get a list of association types
`GET https://apizie.tech/v1/business:akeneo/association-types-get-list`

| Parameter | Type | Required | Description |
|---|---|---|---|
| page | integer | no | Number of the page to retrieve when using the `page` pagination method type. Should never be set manually , see Pagination section |
| limit | integer | no | Number of results by page, see Pagination section |
| with_count | boolean | no | Return the count of items in the response. Be carefull with that, on a big catalog, it can decrease performance in a significative way |

### Create a new association type
`POST https://apizie.tech/v1/business:akeneo/association-types-post`

| Parameter | Type | Required | Description |
|---|---|---|---|
| body | object | no | JSON request body |

### Update/create several association types
`POST https://apizie.tech/v1/business:akeneo/several-association-types-patch`

| Parameter | Type | Required | Description |
|---|---|---|---|
| body | object | no | JSON request body |

### Get an association type
`GET https://apizie.tech/v1/business:akeneo/association-types-get`

| Parameter | Type | Required | Description |
|---|---|---|---|
| code | string | yes | Code of the resource |

### Update/create an association type
`POST https://apizie.tech/v1/business:akeneo/association-types-patch`

| Parameter | Type | Required | Description |
|---|---|---|---|
| code | string | yes | Code of the resource |
| body | object | yes | JSON request body |

### Get list of attribute groups
`GET https://apizie.tech/v1/business:akeneo/attribute-groups-get-list`

| Parameter | Type | Required | Description |
|---|---|---|---|
| search | string | no | Filter attribute groups, for more details see the Filters section. |
| page | integer | no | Number of the page to retrieve when using the `page` pagination method type. Should never be set manually , see Pagination section |
| limit | integer | no | Number of results by page, see Pagination section |
| with_count | boolean | no | Return the count of items in the response. Be carefull with that, on a big catalog, it can decrease performance in a significative way |

### Create a new attribute group
`POST https://apizie.tech/v1/business:akeneo/attribute-groups-post`

| Parameter | Type | Required | Description |
|---|---|---|---|
| body | object | no | JSON request body |

### Update/create several attribute groups
`POST https://apizie.tech/v1/business:akeneo/several-attribute-groups-patch`

| Parameter | Type | Required | Description |
|---|---|---|---|
| body | object | no | JSON request body |

### Get an attribute group
`GET https://apizie.tech/v1/business:akeneo/attribute-groups-get`

| Parameter | Type | Required | Description |
|---|---|---|---|
| code | string | yes | Code of the resource |

### Update/create an attribute group
`POST https://apizie.tech/v1/business:akeneo/attribute-groups-patch`

| Parameter | Type | Required | Description |
|---|---|---|---|
| code | string | yes | Code of the resource |
| body | object | yes | JSON request body |

### Get list of attributes
`GET https://apizie.tech/v1/business:akeneo/get-attributes`

| Parameter | Type | Required | Description |
|---|---|---|---|
| search | string | no | Filter attributes, for more details see the Filters section. |
| page | integer | no | Number of the page to retrieve when using the `page` pagination method type. Should never be set manually , see Pagination section |
| limit | integer | no | Number of results by page, see Pagination section |
| with_count | boolean | no | Return the count of items in the response. Be carefull with that, on a big catalog, it can decrease performance in a significative way |
| with_table_select_options | boolean | no | Return the options of 'select' column types (of a table attribute) in the response. (Only available since the 7.0 version) |

### Create a new attribute
`POST https://apizie.tech/v1/business:akeneo/post-attributes`

| Parameter | Type | Required | Description |
|---|---|---|---|
| body | object | no | JSON request body |

### Update/create several attributes
`POST https://apizie.tech/v1/business:akeneo/patch-attributes`

| Parameter | Type | Required | Description |
|---|---|---|---|
| body | object | no | JSON request body |

### Get list of attribute options
`GET https://apizie.tech/v1/business:akeneo/get-attributes-attribute-code-options`

| Parameter | Type | Required | Description |
|---|---|---|---|
| attribute_code | string | yes | Code of the attribute |
| page | integer | no | Number of the page to retrieve when using the `page` pagination method type. Should never be set manually , see Pagination section |
| limit | integer | no | Number of results by page, see Pagination section |
| with_count | boolean | no | Return the count of items in the response. Be carefull with that, on a big catalog, it can decrease performance in a significative way |

### Create a new attribute option
`POST https://apizie.tech/v1/business:akeneo/post-attributes-attribute-code-options`

| Parameter | Type | Required | Description |
|---|---|---|---|
| attribute_code | string | yes | Code of the attribute |
| body | object | no | JSON request body |

### Update/create several attribute options
`POST https://apizie.tech/v1/business:akeneo/patch-attributes-attribute-code-options`

| Parameter | Type | Required | Description |
|---|---|---|---|
| attribute_code | string | yes | Code of the attribute |
| body | object | no | JSON request body |

### Get an attribute option
`GET https://apizie.tech/v1/business:akeneo/get-attributes-attribute-code-options-code`

| Parameter | Type | Required | Description |
|---|---|---|---|
| attribute_code | string | yes | Code of the attribute |
| code | string | yes | Code of the resource |

### Update/create an attribute option
`POST https://apizie.tech/v1/business:akeneo/patch-attributes-attribute-code-options-code`

| Parameter | Type | Required | Description |
|---|---|---|---|
| attribute_code | string | yes | Code of the attribute |
| code | string | yes | Code of the resource |
| body | object | yes | JSON request body |

### Get an attribute
`GET https://apizie.tech/v1/business:akeneo/get-attributes-code`

| Parameter | Type | Required | Description |
|---|---|---|---|
| code | string | yes | Code of the resource |
| with_table_select_options | boolean | no | Return the options of 'select' column types (of a table attribute) in the response. (Only available since the 7.0 version) |

### Update/create an attribute
`POST https://apizie.tech/v1/business:akeneo/patch-attributes-code`

| Parameter | Type | Required | Description |
|---|---|---|---|
| code | string | yes | Code of the resource |
| body | object | yes | JSON request body |

### Get the list of owned catalogs
`GET https://apizie.tech/v1/business:akeneo/get-app-catalogs`

| Parameter | Type | Required | Description |
|---|---|---|---|
| page | integer | no | Number of the page to retrieve when using the `page` pagination method type. Should never be set manually , see Pagination section |
| limit | integer | no | Number of results by page, see Pagination section |

### Create a new catalog
`POST https://apizie.tech/v1/business:akeneo/post-app-catalog`

| Parameter | Type | Required | Description |
|---|---|---|---|
| body | object | no | JSON request body |

### Get a catalog
`GET https://apizie.tech/v1/business:akeneo/get-app-catalog`

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | string | yes | Catalog ID |

### Update a catalog
`POST https://apizie.tech/v1/business:akeneo/patch-app-catalog`

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | string | yes | Catalog ID |
| body | object | no | JSON request body |

### Delete a catalog
`POST https://apizie.tech/v1/business:akeneo/delete-app-catalog`

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | string | yes | Catalog ID |

### Get the list of mapped products related to a catalog
`GET https://apizie.tech/v1/business:akeneo/get-app-catalog-mapped-products`

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | string | yes | Catalog ID |
| search_after | string | no | Cursor when using the `search_after` pagination method type. Should never be set manually , see Pagination section |
| limit | integer | no | Number of results by page, see Pagination section |
| updated_before | string | no | Filter products that have been updated BEFORE the provided date (Only available on Catalogs endpoints) |
| updated_after | string | no | Filter products that have been updated AFTER the provided date (Only available on Catalogs endpoints) |

### Get the product mapping schema related to a catalog
`GET https://apizie.tech/v1/business:akeneo/get-app-catalogs-mapping-schema-product`

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | string | yes | Catalog ID |

### Create or update the product mapping schema related to a catalog
`POST https://apizie.tech/v1/business:akeneo/put-app-catalogs-mapping-schema-product`

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | string | yes | Catalog ID |
| body | object | no | JSON request body |

### Delete the product mapping schema related to a catalog
`POST https://apizie.tech/v1/business:akeneo/delete-app-catalogs-mapping-schema-product`

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | string | yes | Catalog ID |

### Get the list of product uuids
`GET https://apizie.tech/v1/business:akeneo/get-app-catalog-product-uuids`

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | string | yes | Id of the catalog |
| search_after | string | no | Cursor when using the `search_after` pagination method type. Should never be set manually , see Pagination section |
| limit | integer | no | Number of results by page, see Pagination section |
| updated_before | string | no | Filter products that have been updated BEFORE the provided date (Only available on Catalogs endpoints) |
| updated_after | string | no | Filter products that have been updated AFTER the provided date (Only available on Catalogs endpoints) |

### Get the list of products related to a catalog
`GET https://apizie.tech/v1/business:akeneo/get-app-catalog-products`

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | string | yes | Catalog ID |
| search_after | string | no | Cursor when using the `search_after` pagination method type. Should never be set manually , see Pagination section |
| limit | integer | no | Number of results by page, see Pagination section |
| updated_before | string | no | Filter products that have been updated BEFORE the provided date (Only available on Catalogs endpoints) |
| updated_after | string | no | Filter products that have been updated AFTER the provided date (Only available on Catalogs endpoints) |

### Get a product related to a catalog
`GET https://apizie.tech/v1/business:akeneo/get-app-catalog-products-uuid`

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | string | yes | Catalog ID |
| uuid | string | yes | Product UUID |

### Get list of categories
`GET https://apizie.tech/v1/business:akeneo/get-categories`

| Parameter | Type | Required | Description |
|---|---|---|---|
| search | string | no | Filter categories, for more details see the Filters section. |
| page | integer | no | Number of the page to retrieve when using the `page` pagination method type. Should never be set manually , see Pagination section |
| limit | integer | no | Number of results by page, see Pagination section |
| with_count | boolean | no | Return the count of items in the response. Be carefull with that, on a big catalog, it can decrease performance in a significative way |
| with_position | boolean | no | Return information about category position into its category tree (only available since the 7.0 version) |
| with_enriched_attributes | boolean | no | Return attribute values of the category (only available on SaaS platforms) |

### Create a new category
`POST https://apizie.tech/v1/business:akeneo/post-categories`

| Parameter | Type | Required | Description |
|---|---|---|---|
| body | object | no | JSON request body |

### Update/create several categories
`POST https://apizie.tech/v1/business:akeneo/patch-categories`

| Parameter | Type | Required | Description |
|---|---|---|---|
| body | object | no | JSON request body |

### Get a category
`GET https://apizie.tech/v1/business:akeneo/get-categories-code`

| Parameter | Type | Required | Description |
|---|---|---|---|
| code | string | yes | Code of the resource |
| with_position | boolean | no | Return information about category position into its category tree (only available since the 7.0 version) |
| with_enriched_attributes | boolean | no | Return attribute values of the category (only available on SaaS platforms) |

### Update/create a category
`POST https://apizie.tech/v1/business:akeneo/patch-categories-code`

| Parameter | Type | Required | Description |
|---|---|---|---|
| code | string | yes | Code of the resource |
| body | object | yes | JSON request body |

### Download a category media file
`GET https://apizie.tech/v1/business:akeneo/get-category-media-files-code-download`

| Parameter | Type | Required | Description |
|---|---|---|---|
| code | string | yes | Code of the resource |

### Get a list of channels
`GET https://apizie.tech/v1/business:akeneo/get-channels`

| Parameter | Type | Required | Description |
|---|---|---|---|
| page | integer | no | Number of the page to retrieve when using the `page` pagination method type. Should never be set manually , see Pagination section |
| limit | integer | no | Number of results by page, see Pagination section |
| with_count | boolean | no | Return the count of items in the response. Be carefull with that, on a big catalog, it can decrease performance in a significative way |

### Create a new channel
`POST https://apizie.tech/v1/business:akeneo/channels-post`

| Parameter | Type | Required | Description |
|---|---|---|---|
| body | object | no | JSON request body |

### Update/create several channels
`POST https://apizie.tech/v1/business:akeneo/several-channels-patch`

| Parameter | Type | Required | Description |
|---|---|---|---|
| body | object | no | JSON request body |

### Get a channel
`GET https://apizie.tech/v1/business:akeneo/get-channels-code`

| Parameter | Type | Required | Description |
|---|---|---|---|
| code | string | yes | Code of the resource |

### Update/create a channel
`POST https://apizie.tech/v1/business:akeneo/channels-patch`

| Parameter | Type | Required | Description |
|---|---|---|---|
| code | string | yes | Code of the resource |
| body | object | yes | JSON request body |

### Get a list of currencies
`GET https://apizie.tech/v1/business:akeneo/currencies-get-list`

| Parameter | Type | Required | Description |
|---|---|---|---|
| page | integer | no | Number of the page to retrieve when using the `page` pagination method type. Should never be set manually , see Pagination section |
| limit | integer | no | Number of results by page, see Pagination section |
| with_count | boolean | no | Return the count of items in the response. Be carefull with that, on a big catalog, it can decrease performance in a significative way |

### Get a currency
`GET https://apizie.tech/v1/business:akeneo/currencies-get`

| Parameter | Type | Required | Description |
|---|---|---|---|
| code | string | yes | Code of the resource |

### Get list of families
`GET https://apizie.tech/v1/business:akeneo/get-families`

| Parameter | Type | Required | Description |
|---|---|---|---|
| search | string | no | Filter families, for more details see the Filters section. |
| page | integer | no | Number of the page to retrieve when using the `page` pagination method type. Should never be set manually , see Pagination section |
| limit | integer | no | Number of results by page, see Pagination section |
| with_count | boolean | no | Return the count of items in the response. Be carefull with that, on a big catalog, it can decrease performance in a significative way |

### Create a new family
`POST https://apizie.tech/v1/business:akeneo/post-families`

| Parameter | Type | Required | Description |
|---|---|---|---|
| body | object | no | JSON request body |

### Update/create several families
`POST https://apizie.tech/v1/business:akeneo/patch-families`

| Parameter | Type | Required | Description |
|---|---|---|---|
| body | object | no | JSON request body |

### Get a family
`GET https://apizie.tech/v1/business:akeneo/get-families-code`

| Parameter | Type | Required | Description |
|---|---|---|---|
| code | string | yes | Code of the resource |

### Update/create a family
`POST https://apizie.tech/v1/business:akeneo/patch-families-code`

| Parameter | Type | Required | Description |
|---|---|---|---|
| code | string | yes | Code of the resource |
| body | object | yes | JSON request body |

### Get list of family variants
`GET https://apizie.tech/v1/business:akeneo/get-families-family-code-variants`

| Parameter | Type | Required | Description |
|---|---|---|---|
| family_code | string | yes | Code of the family |
| page | integer | no | Number of the page to retrieve when using the `page` pagination method type. Should never be set manually , see Pagination section |
| limit | integer | no | Number of results by page, see Pagination section |
| with_count | boolean | no | Return the count of items in the response. Be carefull with that, on a big catalog, it can decrease performance in a significative way |

### Create a new family variant
`POST https://apizie.tech/v1/business:akeneo/post-families-family-code-variants`

| Parameter | Type | Required | Description |
|---|---|---|---|
| family_code | string | yes | Code of the family |
| body | object | no | JSON request body |

### Update/create several family variants
`POST https://apizie.tech/v1/business:akeneo/patch-families-family-code-variants`

| Parameter | Type | Required | Description |
|---|---|---|---|
| family_code | string | yes | Code of the family |
| body | object | no | JSON request body |

### Get a family variant
`GET https://apizie.tech/v1/business:akeneo/get-families-family-code-variants-code`

| Parameter | Type | Required | Description |
|---|---|---|---|
| family_code | string | yes | Code of the family |
| code | string | yes | Code of the resource |

### Update/create a family variant
`POST https://apizie.tech/v1/business:akeneo/patch-families-family-code-variants-code`

| Parameter | Type | Required | Description |
|---|---|---|---|
| family_code | string | yes | Code of the family |
| code | string | yes | Code of the resource |
| body | object | yes | JSON request body |

### Get a list of locales
`GET https://apizie.tech/v1/business:akeneo/get-locales`

| Parameter | Type | Required | Description |
|---|---|---|---|
| search | string | no | Filter locales, for more details see the Filters section |
| page | integer | no | Number of the page to retrieve when using the `page` pagination method type. Should never be set manually , see Pagination section |
| limit | integer | no | Number of results by page, see Pagination section |
| with_count | boolean | no | Return the count of items in the response. Be carefull with that, on a big catalog, it can decrease performance in a significative way |

### Get a locale
`GET https://apizie.tech/v1/business:akeneo/get-locales-code`

| Parameter | Type | Required | Description |
|---|---|---|---|
| code | string | yes | Code of the resource |

### Get list of measure familiy
`GET https://apizie.tech/v1/business:akeneo/measure-families-get-list`

### Get a measure family
`GET https://apizie.tech/v1/business:akeneo/measure-families-get`

| Parameter | Type | Required | Description |
|---|---|---|---|
| code | string | yes | Code of the resource |

### Get list of measurement families
`GET https://apizie.tech/v1/business:akeneo/measurement-families-get-list`

### Update/create several measurement families
`POST https://apizie.tech/v1/business:akeneo/patch-measurement-families`

| Parameter | Type | Required | Description |
|---|---|---|---|
| body | object | no | JSON request body |

### Get a list of product media files
`GET https://apizie.tech/v1/business:akeneo/get-media-files`

| Parameter | Type | Required | Description |
|---|---|---|---|
| page | integer | no | Number of the page to retrieve when using the `page` pagination method type. Should never be set manually , see Pagination section |
| limit | integer | no | Number of results by page, see Pagination section |
| with_count | boolean | no | Return the count of items in the response. Be carefull with that, on a big catalog, it can decrease performance in a significative way |

### Create a new product media file
`POST https://apizie.tech/v1/business:akeneo/post-media-files`

| Parameter | Type | Required | Description |
|---|---|---|---|
| body | object | no | JSON request body |

### Get a product media file
`GET https://apizie.tech/v1/business:akeneo/get-media-files-code`

| Parameter | Type | Required | Description |
|---|---|---|---|
| code | string | yes | Code of the resource |

### Download a product media file
`GET https://apizie.tech/v1/business:akeneo/get-media-files-code-download`

| Parameter | Type | Required | Description |
|---|---|---|---|
| code | string | yes | Code of the resource |

### Get list of product models
`GET https://apizie.tech/v1/business:akeneo/get-product-models`

| Parameter | Type | Required | Description |
|---|---|---|---|
| search | string | no | Filter product models, for more details see the Filters section |
| scope | string | no | Filter product values to return scopable attributes for the given channel as well as the non localizable/non scopable attributes, for more… |
| locales | string | no | Filter product values to return localizable attributes for the given locales as well as the non localizable/non scopable attributes, for… |
| attributes | string | no | Filter product values to only return those concerning the given attributes, for more details see the Filter on product values section and… |
| pagination_type | string | no | Pagination method type, see Pagination section |
| page | integer | no | Number of the page to retrieve when using the `page` pagination method type. Should never be set manually , see Pagination section |
| search_after | string | no | Cursor when using the `search_after` pagination method type. Should never be set manually , see Pagination section |
| limit | integer | no | Number of results by page, see Pagination section |
| with_count | boolean | no | Return the count of items in the response. Be carefull with that, on a big catalog, it can decrease performance in a significative way |
| with_quality_scores | boolean | no | Return product model quality scores in the response. (Only available since the 6.0 version) |

### Create a new product model
`POST https://apizie.tech/v1/business:akeneo/post-product-models`

| Parameter | Type | Required | Description |
|---|---|---|---|
| body | object | no | JSON request body |

### Update/create several product models
`POST https://apizie.tech/v1/business:akeneo/patch-product-models`

| Parameter | Type | Required | Description |
|---|---|---|---|
| body | object | no | JSON request body |

### Get a product model
`GET https://apizie.tech/v1/business:akeneo/get-product-models-code`

| Parameter | Type | Required | Description |
|---|---|---|---|
| code | string | yes | Code of the resource |
| with_quality_scores | boolean | no | Return product model quality scores in the response. (Only available since the 6.0 version) |

### Update/create a product model
`POST https://apizie.tech/v1/business:akeneo/patch-product-models-code`

| Parameter | Type | Required | Description |
|---|---|---|---|
| code | string | yes | Code of the resource |
| body | object | yes | JSON request body |

### Delete a product model
`POST https://apizie.tech/v1/business:akeneo/delete-product-models-code`

| Parameter | Type | Required | Description |
|---|---|---|---|
| code | string | yes | Code of the resource |

### Get a draft
`GET https://apizie.tech/v1/business:akeneo/get-product-model-draft-code`

| Parameter | Type | Required | Description |
|---|---|---|---|
| code | string | yes | Code of the resource |

### Submit a draft for approval
`POST https://apizie.tech/v1/business:akeneo/post-product-model-proposal`

| Parameter | Type | Required | Description |
|---|---|---|---|
| code | string | yes | Code of the resource |

### Get list of products
`GET https://apizie.tech/v1/business:akeneo/get-products`

| Parameter | Type | Required | Description |
|---|---|---|---|
| search | string | no | Filter products, for more details see the Filters section |
| scope | string | no | Filter product values to return scopable attributes for the given channel as well as the non localizable/non scopable attributes, for more… |
| locales | string | no | Filter product values to return localizable attributes for the given locales as well as the non localizable/non scopable attributes, for… |
| attributes | string | no | Filter product values to only return those concerning the given attributes, for more details see the Filter on product values section |
| pagination_type | string | no | Pagination method type, see Pagination section |
| page | integer | no | Number of the page to retrieve when using the `page` pagination method type. Should never be set manually , see Pagination section |
| search_after | string | no | Cursor when using the `search_after` pagination method type. Should never be set manually , see Pagination section |
| limit | integer | no | Number of results by page, see Pagination section |
| with_count | boolean | no | Return the count of items in the response. Be carefull with that, on a big catalog, it can decrease performance in a significative way |
| with_attribute_options | boolean | no | Return labels of attribute options in the response. (Only available since the 5.0 version) |
| with_quality_scores | boolean | no | Return product quality scores in the response. (Only available since the 5.0 version) |
| with_completenesses | boolean | no | Return product completenesses in the response. (Only available since the 6.0 version) |

### Create a new product
`POST https://apizie.tech/v1/business:akeneo/post-products`

| Parameter | Type | Required | Description |
|---|---|---|---|
| body | object | no | JSON request body |

### Update/create several products
`POST https://apizie.tech/v1/business:akeneo/patch-products`

| Parameter | Type | Required | Description |
|---|---|---|---|
| body | object | no | JSON request body |

### Get list of products
`GET https://apizie.tech/v1/business:akeneo/get-products-uuid`

| Parameter | Type | Required | Description |
|---|---|---|---|
| search | string | no | Filter products, for more details see the Filters section |
| scope | string | no | Filter product values to return scopable attributes for the given channel as well as the non localizable/non scopable attributes, for more… |
| locales | string | no | Filter product values to return localizable attributes for the given locales as well as the non localizable/non scopable attributes, for… |
| attributes | string | no | Filter product values to only return those concerning the given attributes, for more details see the Filter on product values section |
| pagination_type | string | no | Pagination method type, see Pagination section |
| page | integer | no | Number of the page to retrieve when using the `page` pagination method type. Should never be set manually , see Pagination section |
| search_after | string | no | Cursor when using the `search_after` pagination method type. Should never be set manually , see Pagination section |
| limit | integer | no | Number of results by page, see Pagination section |
| with_count | boolean | no | Return the count of items in the response. Be carefull with that, on a big catalog, it can decrease performance in a significative way |
| with_attribute_options | boolean | no | Return labels of attribute options in the response. (Only available since the 5.0 version) |
| with_quality_scores | boolean | no | Return product quality scores in the response. (Only available since the 5.0 version) |
| with_completenesses | boolean | no | Return product completenesses in the response. (Only available since the 6.0 version) |

### Create a new product
`POST https://apizie.tech/v1/business:akeneo/post-products-uuid`

| Parameter | Type | Required | Description |
|---|---|---|---|
| body | object | no | JSON request body |

### Update/create several products
`POST https://apizie.tech/v1/business:akeneo/patch-products-uuid`

| Parameter | Type | Required | Description |
|---|---|---|---|
| body | object | no | JSON request body |

### Get a product
`GET https://apizie.tech/v1/business:akeneo/get-products-uuid-uuid`

| Parameter | Type | Required | Description |
|---|---|---|---|
| uuid | string | yes | Uuid of the resource |
| with_attribute_options | boolean | no | Return labels of attribute options in the response. (Only available since the 5.0 version) |
| with_quality_scores | boolean | no | Return product quality scores in the response. (Only available since the 5.0 version) |
| with_completenesses | boolean | no | Return product completenesses in the response. (Only available since the 6.0 version) |

### Update/create a product
`POST https://apizie.tech/v1/business:akeneo/patch-products-uuid-uuid`

| Parameter | Type | Required | Description |
|---|---|---|---|
| uuid | string | yes | Uuid of the resource |
| body | object | yes | JSON request body |

### Delete a product
`POST https://apizie.tech/v1/business:akeneo/delete-products-uuid-uuid`

| Parameter | Type | Required | Description |
|---|---|---|---|
| uuid | string | yes | Uuid of the resource |

### Get a draft
`GET https://apizie.tech/v1/business:akeneo/get-draft-uuid-uuid`

| Parameter | Type | Required | Description |
|---|---|---|---|
| uuid | string | yes | Uuid of the resource |

…and 24 more. See the OpenAPI spec.

## Example
```
curl "https://apizie.tech/v1/business:akeneo/post-token" \
  -H "x-api-key: $APIZIE_KEY"
```

## FAQ

### How do I call the Akeneo PIM REST API API?
Create a free Apizie key, then send POST https://apizie.tech/v1/business:akeneo/post-token with the header x-api-key. Every endpoint returns { project, data, timestamp }.

### Is the Akeneo PIM REST API API free on Apizie?
Yes. The Free plan includes 1,000 requests a month at 100 requests a minute, no credit card.

### Can AI agents use the Akeneo PIM REST API API?
Yes. Add the Apizie MCP server (https://apizie.tech/mcp) to Claude, ChatGPT, Cursor or VS Code, then ask in plain language. The agent calls run_scraper with project key business:akeneo.

### What is the status of the Akeneo PIM REST API API?
Live: works with just an Apizie key