v1

latestSwagger 2.02026-07-13137761.0 MB

Reference entity record

Get the list of the records of a reference entity

This endpoint allows you to get a list of records of a given reference entity. Records are paginated and can be filtered.

get/api/rest/v1/reference-entities/{reference_entity_code}/records

Path parameters

reference_entity_codestring required

Code of the reference entity

Query parameters

searchstring

Filter records of the reference entity, for more details see the <a href="/documentation/filter.html#filter-reference-entity-records">Filters</a> section

channelstring

Filter attribute values to return scopable attributes for the given channel as well as the non localizable/non scopable attributes, for more details see the <a href="/documentation/filter.html#record-values-by-channel">Filter attribute values by channel</a> section

localesstring

Filter attribute values to return localizable attributes for the given locales as well as the non localizable/non scopable attributes, for more details see the <a href="/documentation/filter.html#record-values-by-locale">Filter attribute values by locale</a> section

search_afterstring

Cursor when using the search_after pagination method type. <strong>Should never be set manually</strong>, see <a href="/documentation/pagination.html">Pagination</a> section

Response

Return the records of the given reference entity paginated

Example response

{
  "_embedded": {
    "items": [
      {
        "code": "kartell",
        "values": {
          "label": [
            {
              "locale": "en_US",
              "channel": null,
              "data": "Kartell"
            }
          ],
          "image": [
            {
              "locale": null,
              "channel": null,
              "data": "0/c/b/0/0cb0c0e115dedba676f8d1ad8343ec207ab54c7b_image.jpg"
            }
          ],
          "description": [
            {
              "locale": "en_US",
              "channel": null,
              "data": "Kartell, the Italian furniture company that sells modern and remarkable pieces of furnitures."
            },
            {
              "locale": "fr_FR",
              "channel": null,
              "data": "Kartell, l'éditeur de meuble italien spécialisé dans la signature de belle pièces au design contemporain."
            }
          ],
          "country": [
            {
              "locale": null,
              "channel": null,
              "data": "italy"
            }
          ],
          "collection_overview": [
            {
              "locale": null,
              "channel": null,
              "data": "5/1/d/8/51d81dc778ba1501a8f998f3ab5797569f3b9e25_img.png"
            }
          ],
          "creation_year": [
            {
              "locale": null,
              "channel": null,
              "data": "1949"
            }
          ]
        },
        "created": "2021-01-01T01:23:34+00:00",
        "updated": "2021-02-03T23:45:60+00:00"
      }
    ]
  }
}