Get the list of the records of a reference entity

GET

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

Reference entity record

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

Request Example

Shell

JavaScript

Java

Swift

curl --location --request GET '/api/rest/v1/reference-entities//records'

Response Example

200 - Example 1

{
  "_links": {
    "first": {
      "href": "string"
    },
    "next": {
      "href": "string"
    },
    "self": {
      "href": "string"
    }
  },
  "_embedded": {
    "items": [
      {
        "_links": {
          "self": {
            "href": "string"
          }
        },
        "code": "kartell",
        "created": "2023-08-15T05:53:50.719Z",
        "updated": "2023-08-15T05:53:50.719Z",
        "values": {
          "collection_overview": [
            {
              "channel": null,
              "data": "5/1/d/8/51d81dc778ba1501a8f998f3ab5797569f3b9e25_img.png",
              "locale": null
            }
          ],
          "country": [
            {
              "channel": null,
              "data": "italy",
              "locale": null
            }
          ],
          "creation_year": [
            {
              "channel": null,
              "data": "1949",
              "locale": null
            }
          ],
          "description": [
            {
              "channel": null,
              "data": "Kartell, the Italian furniture company that sells modern and remarkable pieces of furnitures.",
              "locale": "en_US"
            },
            {
              "channel": null,
              "data": "Kartell, l'éditeur de meuble italien spécialisé dans la signature de belle pièces au design contemporain.",
              "locale": "fr_FR"
            }
          ],
          "image": [
            {
              "channel": null,
              "data": "0/c/b/0/0cb0c0e115dedba676f8d1ad8343ec207ab54c7b_image.jpg",
              "locale": null
            }
          ],
          "label": [
            {
              "channel": null,
              "data": "Kartell",
              "locale": "en_US"
            }
          ]
        }
      }
    ]
  }
}

Request

Path Params

reference_entity_code

string

required

Code of the reference entity

Query Params

string

optional

Filter records of the reference entity, for more details see the Filters section

channel

string

optional

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 Filter attribute values by channel section

locales

string

optional

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 Filter attribute values by locale section

search_after

string

optional

Cursor when using the search_after pagination method type. Should never be set manually, see Pagination section

Responses

🟢200Return the records of the given reference entity paginated

application/json

Body

_links

object

optional

first

object

optional

object

optional

self

object

optional

_embedded

object

optional

items

array [object {5}]

optional

🟠401Authentication required

🟠406Not Acceptable

Modified at 2023-08-15 05:53:55

Update/create a reference entity attribute option

Update/create several reference entity records