younifyd
Menu

Get Reference Entity By Code

Get a reference entity

GET/api/rest/v1/reference-entities/{code}

Use it in a workflow

  1. Add a step and choose the Akeneo connector.
  2. Pick the Get Reference Entity By Code action (under Reference entity).
  3. Fill in the fields below, then reference the result from later steps as {{getReferenceEntityByCode.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 {{getReferenceEntityByCode.response.data.<field>}}.

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