Get Family By Code

Get a family

GET/api/rest/v1/families/{code}

Use it in a workflow

Add a step and choose the Akeneo connector.
Pick the Get Family By Code action (under Family).
Fill in the fields below, then reference the result from later steps as {{getFamilyByCode.response.data}}.

Request

Path parameters

codestringrequired

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

Response

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

codestring

Family code

attribute_as_labelstring

Attribute code used as label

attribute_as_imagestring | null

Attribute code used as the main picture in the user interface

attributesarray<string>

Attribute codes that compose the family

attribute_requirementsobject

Attribute codes of the family that are required for the completeness calculation for each channel

labelsobject

Family labels for each locale

Default {}

parentstring | null

The parent family code. If the family has no parent, this field is `null`

json

{
  "code": "caps",
  "attribute_as_label": "short_description",
  "attribute_as_image": "picture",
  "attributes": [
    "sku",
    "name",
    "description",
    "price",
    "color",
    "picture"
  ],
  "attribute_requirements": {
    "ecommerce": [
      "sku",
      "name",
      "description",
      "price",
      "color"
    ],
    "tablet": [
      "sku",
      "name",
      "description",
      "price"
    ]
  },
  "labels": {
    "en_US": "Caps",
    "fr_FR": "Casquettes"
  },
  "parent": "accessories"
}

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

Was this page helpful?