Skip to main content
GET
/
api
/
v3
/
admin
/
option_types
/
{id}
Spree Admin SDK
import { createAdminClient } from '@spree/admin-sdk'

const client = createAdminClient({
  baseUrl: 'https://your-store.com',
  secretKey: 'sk_xxx',
})

const optionType = await client.optionTypes.get('ot_UkLWZg9DAJ')
{
  "id": "opt_UkLWZg9DAJ",
  "name": "foo-size-5",
  "label": "Size",
  "position": 1,
  "kind": "dropdown",
  "metadata": {},
  "filterable": true,
  "created_at": "2026-06-17T13:37:03.000Z",
  "updated_at": "2026-06-17T13:37:03.000Z"
}

Authorizations

​
x-spree-api-key
string
header
required

Secret API key for admin access

​
Authorization
string
header
required

JWT token for admin user authentication

Headers

​
x-spree-api-key
string
required
​
Authorization
string
required

Bearer token for admin authentication

Path Parameters

​
id
string
required

Option type ID

Query Parameters

​
expand
string

Comma-separated associations to expand (e.g., option_values). Use dot notation for nested expand (max 4 levels).

​
fields
string

Comma-separated list of fields to include (e.g., name,label,position). id is always included.

Response

option type found

​
id
string
required
​
name
string
required
​
label
string
required
​
position
number
required
​
kind
string
required
​
metadata
object
required
​
filterable
boolean
required
​
created_at
string
required
​
updated_at
string
required
​
option_values
object[]