Akeneo PIM REST API
  1. Attribute
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 an attribute option for a given attribute of a given asset family
    • Update/create an asset attribute option for a given asset family
  • Asset media file
    • Create a new media file for an asset
    • Download the media file associated to an asset
  • 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
      GET
    • Update/create several attributes
      PATCH
    • Create a new attribute
      POST
    • Get an attribute
      GET
    • Update/create an attribute
      PATCH
  • 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. Attribute

Get an attribute

GET
/api/rest/v1/attributes/{code}
This endpoint allows you to get the information about a given attribute.
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request GET '/api/rest/v1/attributes/'
Response Response Example
200 - Example 1
{
    "allowed_extensions": [],
    "available_locales": [],
    "code": "release_date",
    "date_max": "2023-08-15T05:53:50.706Z",
    "date_min": "2023-08-15T05:53:50.706Z",
    "decimals_allowed": null,
    "default_metric_unit": null,
    "default_value": null,
    "group": "marketing",
    "group_labels": {
        "en_US": "Marketing",
        "fr_FR": "Marketing"
    },
    "labels": {
        "en_US": "Sale date",
        "fr_FR": "Date des soldes"
    },
    "localizable": false,
    "max_characters": null,
    "max_file_size": null,
    "metric_family": null,
    "minimum_input_length": null,
    "negative_allowed": null,
    "number_max": null,
    "number_min": null,
    "reference_data_name": null,
    "scopable": false,
    "sort_order": 1,
    "type": "pim_catalog_date",
    "unique": false,
    "useable_as_grid_filter": true,
    "validation_regexp": null,
    "validation_rule": null,
    "wysiwyg_enabled": null
}

Request

Path Params
code
string 
required
Code of the resource
Query Params
with_table_select_options
string 
optional
Return the options of 'select' column types (of a table attribute) in the response. (Only available since the 7.0 version)

Responses

🟢200OK
application/json
Body
allowed_extensions
array[string]
optional
Extensions allowed when the attribute type is pim_catalog_file or pim_catalog_image
available_locales
array[string]
optional
To make the attribute locale specfic, specify here for which locales it is specific
code
string 
required
Attribute code
date_max
string <date-time>
optional
Maximum date allowed when the attribute type is pim_catalog_date
date_min
string <date-time>
optional
Minimum date allowed when the attribute type is pim_catalog_date
decimals_allowed
boolean 
optional
Whether decimals are allowed when the attribute type is pim_catalog_metric, pim_catalog_price or pim_catalog_number
default_metric_unit
string 
optional
Default metric unit when the attribute type is pim_catalog_metric
default_value
boolean 
optional
Default value for a Yes/No attribute, applied when creating a new product or product model (only available since the 5.0)
group
string 
required
Attribute group
group_labels
object 
optional
Group labels for each locale
Default:
{}
localeCode
string 
optional
Group label for the locale localeCode
labels
object 
optional
Attribute labels for each locale
Default:
{}
localeCode
string 
optional
Attribute label for the locale localeCode
localizable
boolean 
optional
Whether the attribute is localizable, i.e. can have one value by locale
Default:
false
max_characters
integer 
optional
Number maximum of characters allowed for the value of the attribute when the attribute type is pim_catalog_text, pim_catalog_textarea or pim_catalog_identifier
max_file_size
string 
optional
Max file size in MB when the attribute type is pim_catalog_file or pim_catalog_image
metric_family
string 
optional
Metric family when the attribute type is pim_catalog_metric
negative_allowed
boolean 
optional
Whether negative values are allowed when the attribute type is pim_catalog_metric or pim_catalog_number
number_max
string 
optional
Maximum integer value allowed when the attribute type is pim_catalog_metric, pim_catalog_price or pim_catalog_number
number_min
string 
optional
Minimum integer value allowed when the attribute type is pim_catalog_metric, pim_catalog_price or pim_catalog_number
reference_data_name
string 
optional
Reference entity code when the attribute type is akeneo_reference_entity or akeneo_reference_entity_collection OR Asset family code when the attribute type is pim_catalog_asset_collection
scopable
boolean 
optional
Whether the attribute is scopable, i.e. can have one value by channel
Default:
false
sort_order
integer 
optional
Order of the attribute in its group
Default:
0
table_configuration
array [object {5}] 
optional
Configuration of the Table attribute (columns)
code
string 
required
Column code
data_type
enum<string> 
required
Column data type
Allowed values:
selecttextnumberboolean
is_required_for_completeness
boolean 
optional
Defines if the column should be entirely filled for the attribute to be considered complete
Default:
false
labels
object 
optional
Column labels for each locale
Default:
{}
validations
object 
optional
User defined validation constraints on the cell content
Default:
{}
type
enum<string> 
required
Attribute type. See type section for more details.
Allowed values:
pim_catalog_identifierpim_catalog_metricpim_catalog_numberpim_catalog_reference_data_multi_selectpim_catalog_reference_data_simple_selectpim_catalog_simpleselectpim_catalog_multiselectpim_catalog_datepim_catalog_textareapim_catalog_textpim_catalog_filepim_catalog_imagepim_catalog_price_collectionpim_catalog_booleanakeneo_reference_entityakeneo_reference_entity_collectionpim_catalog_asset_collection
unique
boolean 
optional
Whether two values for the attribute cannot be the same
useable_as_grid_filter
boolean 
optional
Whether the attribute can be used as a filter for the product grid in the PIM user interface
validation_regexp
string 
optional
Regexp expression used to validate any attribute value when the attribute type is pim_catalog_text or pim_catalog_identifier
validation_rule
string 
optional
Validation rule type used to validate any attribute value when the attribute type is pim_catalog_text or pim_catalog_identifier
wysiwyg_enabled
boolean 
optional
Whether the WYSIWYG interface is shown when the attribute type is pim_catalog_textarea
🟠401Authentication required
🟠403Access forbidden
🟠404Resource not found
🟠406Not Acceptable
Modified at 2023-08-15 05:53:55
Previous
Create a new attribute
Next
Update/create an attribute
Built with