younifyd
Menu

Get All Reference Entity Records

Get all records across all reference entities

GET/api/rest/v1/reference-entities/records

Use it in a workflow

  1. Add a step and choose the Akeneo connector.
  2. Pick the Get All Reference Entity Records action (under Reference entity record).
  3. Fill in the fields below, then reference the result from later steps as {{getAllReferenceEntityRecords.response.data}}.

Request

Query parameters

reference_entitystring

Filter records by a specific reference entity code

searchstring

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

channelstring

Filter record values to return scopable record attributes for the given channel as well as the non localizable/non scopable record attributes, for more details see the [Filter record values by channel](https://api.akeneo.com/documentation/filter.html#record-values-by-channel) section.

localesstring

Filter record values to return localizable record attributes for the given locales as well as the non localizable/non scopable record attributes, for more details see the [Filter record values by locale](https://api.akeneo.com/documentation/filter.html#record-values-by-locale) section.

search_afterstring

Cursor when using the `search_after` pagination method type. It is essential for navigating through pages in cursor-based pagination, providing more efficient pagination for large datasets. Should never be set manually, see [Pagination](https://api.akeneo.com/documentation/pagination.html) section for more details.

Default "cursor to the first page"

Response

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

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