Skip to main content
GET
/
platform
/
entitylists
Error
A valid request URL is required to generate request examples
{
  "startIndex": 123,
  "pageSize": 123,
  "pageCount": 123,
  "totalCount": 123,
  "items": [
    {
      "tenantId": 123,
      "nameSpace": "<string>",
      "name": "<string>",
      "contextLevel": "<string>",
      "useSystemAssignedId": true,
      "idProperty": {
        "propertyName": "<string>",
        "dataType": "<string>"
      },
      "indexA": {
        "propertyName": "<string>",
        "dataType": "<string>"
      },
      "indexB": {
        "propertyName": "<string>",
        "dataType": "<string>"
      },
      "indexC": {
        "propertyName": "<string>",
        "dataType": "<string>"
      },
      "indexD": {
        "propertyName": "<string>",
        "dataType": "<string>"
      },
      "isVisibleInStorefront": true,
      "isLocaleSpecific": true,
      "isShopperSpecific": true,
      "isSandboxDataCloningSupported": true,
      "views": [
        {
          "name": "<string>",
          "usages": [
            "<string>"
          ],
          "metaData": {},
          "security": "<string>",
          "filter": "<string>",
          "defaultSort": "<string>",
          "fields": [
            {
              "name": "<string>",
              "type": "<string>",
              "target": "<string>"
            }
          ]
        }
      ],
      "usages": [
        "<string>"
      ],
      "metadata": {},
      "createDate": "2023-11-07T05:31:56Z",
      "updateDate": "2023-11-07T05:31:56Z"
    }
  ]
}

Authorizations

Authorization
string
header
required

JWT Authorization header using the Bearer scheme.

Query Parameters

pageSize
integer<int32>
default:10
startIndex
integer<int32>
default:0
filter
string
sortBy
string
responseFields
string

limits which fields are returned in the response body

Response

Success

startIndex
integer<int32>
pageSize
integer<int32>
pageCount
integer<int32>
totalCount
integer<int32>
items
object[] | null