Skip to main content
GET
/
variant-options
/
{optionId}
cURL
curl --request GET \
  --url https://admin.fanfare.io/api/variant-options/{optionId} \
  --header 'Authorization: Bearer <token>'
{
  "archived": true,
  "createdAt": "2023-11-07T05:31:56Z",
  "createdBy": "<string>",
  "displayName": "<string>",
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "isRestricted": true,
  "name": "<string>",
  "organizationId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "sortOrder": 123,
  "updatedAt": "2023-11-07T05:31:56Z",
  "updatedBy": "<string>",
  "values": [
    {
      "archived": true,
      "colorHex": "<string>",
      "createdAt": "2023-11-07T05:31:56Z",
      "createdBy": "<string>",
      "displayValue": "<string>",
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "isCentrallyManaged": true,
      "optionId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "organizationId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "sortOrder": 123,
      "value": "<string>",
      "updatedAt": "2023-11-07T05:31:56Z",
      "updatedBy": "<string>"
    }
  ]
}

Authorizations

Authorization
string
header
required

Fanfare secret key. Keep secret credentials on your server.

Path Parameters

optionId
string
required

Response

Variant option retrieved successfully

archived
boolean
required
createdAt
string<date-time>
required
createdBy
string
required
displayName
string
required
Minimum string length: 1
id
string<uuid>
required
isRestricted
boolean
required
name
string
required
Minimum string length: 1
organizationId
string<uuid>
required
sortOrder
number | null
required
updatedAt
string<date-time> | null
updatedBy
string | null
values
object[]