AppListMetaobjectFields

GET

/apps/custom-data/metaobjects/{type}/fields

curl --request GET \
  --url https://your-store.myciqra.com/apps/custom-data/metaobjects/example/fields \
  --header 'Authorization: Bearer <token>'

Required scope: read_metaobjects — an installation token without it receives 403.

Authorizations

• bearerAuth
  read_metaobjects

Parameters

Path Parameters

type

required

string

Responses

200

OK

Media typeapplication/json

Array<object>

object

description

required

null | string

key

required

string

name

required

string

position

required

integer | string format: int32

/^-?(?:0|[1-9]\d*)$/

required

required

boolean

type

required

string

validations

One of:

null

null

object

object

allowed

Array<string> | null

fileTypes

Array<string> | null

max

null | number | string format: double

/^-?(?:0|[1-9]\d*)(?:\.\d+)?$/

maxFileMb

null | number | string format: double

/^-?(?:0|[1-9]\d*)(?:\.\d+)?$/

min

null | number | string format: double

/^-?(?:0|[1-9]\d*)(?:\.\d+)?$/

regex

null | string

Example^generated

[
  {
    "description": "example",
    "key": "example",
    "name": "example",
    "position": 1,
    "required": true,
    "type": "example",
    "validations": {
      "allowed": [
        "example"
      ],
      "fileTypes": [
        "example"
      ],
      "max": 1,
      "maxFileMb": 1,
      "min": 1,
      "regex": "example"
    }
  }
]

404

Not Found