younifyd
Menu

Get Attributes

Get list of attributes

GET/api/rest/v1/attributes

Use it in a workflow

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

Request

Query parameters

searchstring

Filter attributes, for more details see the [Filters](https://api.akeneo.com/documentation/filter.html#filter-attributes) section.

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_table_select_optionsboolean

Return the options of 'select' column types (of a table attribute) in the response. When set to `true`, the response will include all available options for select-type columns in table attributes. This is useful for retrieving all available options for select-type columns in table attributes, which is essential for form rendering and data validation. If set to `false`, the response will not include select options, which can improve performance.

Default false

Response

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

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