younifyd
Menu

Get Family Variants

Get list of family variants

GET/api/rest/v1/families/{family_code}/variants

Use it in a workflow

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

Request

Path parameters

family_codestringrequired

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

Query parameters

pageinteger

Specify which page of results to retrieve when using pagination. It is useful for navigating through large datasets by breaking them into smaller, manageable pages. See [Pagination](https://api.akeneo.com/documentation/pagination.html) section for more details.

Default 1

limitinteger

Specify the maximum number of results to return per page. It is useful for controlling the amount of data returned in a single request, especially when dealing with large datasets. See [Pagination](https://api.akeneo.com/documentation/pagination.html) section for more details.

Default 10

with_countboolean

Return the count of items in the response. Be careful with that, on a big catalog, it can decrease performance in a significant way. It is useful for understanding the size of the dataset being returned, especially when dealing with large collections. Use it judiciously to avoid performance issues.

Default false

Response

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

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

Get Family Variants — Akeneo — Documentation