younifyd
Menu

Get Categories

Get the list of categories

GET/api/rest/v1/categories

Use it in a workflow

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

Request

Query parameters

searchstring

The `search` query parameter allows you to filter categories based on specific criteria. For more details see the [Filters section](https://api.akeneo.com/documentation/filter.html#filter-categories).

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

with_positionboolean

Return information about the category's position within its category tree. When set to `true`, the response will include the position of the category in its level, which can be useful for understanding the hierarchy and order of categories. If set to `false`, the response will not include this information, which can improve performance.

Default false

with_enriched_attributesboolean

Return the attribute values of the category. When set to `true`, the response will include the values of all attributes associated with the category. This is useful for retrieving detailed information about the category's attributes, such as their values and configurations. If set to `false`, the response will not include attribute values, which can improve performance

Default false

Response

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

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

Get Categories — Akeneo — Documentation