Skip to main content
GET
List metafield definitions

Authorizations

Authorization
string
header
required

Bearer token authentication

Query Parameters

owner_resource
string

Return only definitions for this kind of record, for example Product. Member and Customer match Company::Member definitions.

Example:

"Product"

pinned
boolean

Return only pinned definitions when true, or only unpinned ones when false.

search_query
string

Return only definitions whose name, namespace, key or description contains the text.

Example:

"tagline"

page
integer
default:1

The page to return, starting at 1.

Required range: x >= 1
per_page
integer
default:20

How many definitions to return per page, up to 100. The default is 20.

Required range: 1 <= x <= 100

Response

The page of definitions.

metafield_definitions
object[]
required
meta
object
required

Response metadata for a paginated list.