Skip to main content
GET
/
v1
/
variant_options
List
curl --request GET \
  --url https://{defaultHost}/v1/variant_options \
  --header 'Authorization: Bearer <token>'
{
  "object": "list",
  "pagination": {
    "count": 1,
    "limit": 20,
    "page": 1,
    "url": "/v1/variant_options"
  },
  "data": [
    {
      "id": "701657b4-a856-4ae6-8bb7-717f93bfad3d",
      "object": "variant_option",
      "display_type": "radio",
      "metadata": {},
      "name": "Color",
      "position": 0,
      "values": [],
      "product": "42c9bedf-8c2c-4634-8e34-cd7248b196af",
      "created_at": 1769675016,
      "updated_at": 1769675016
    }
  ]
}

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

ids[]
string[]

Only return objects with the given IDs.

limit
integer

A limit on the number of items to be returned, between 1 and 100.

page
integer

The page of items you want returned.

product_ids[]
string[]

Only return objects that belong to the given products.

Response

200 - application/json

Success

object
string

A string describing the object type returned.

pagination
object
data
array

An array of objects.