Optimizely Websites API
The Websites API from Optimizely — 41 operation(s) for websites.
Operations 45
GET
/api/v1/admin/Websites({id})/Default.userProfilesWithRolesFilter()
Call operation userProfilesWithRolesFilter
#
The Websites API from Optimizely — 41 operation(s) for websites.
Every API here is available over the APIs.io API and to AI agents over MCP.
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
find_apisBrowse and filter every API in the catalog.get_api_artifactsOne API's artifacts, grouped by type.get_openapiThe primary OpenAPI for this API.find_similar_apisAPIs that look like this one.apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.resolveTurn a domain, URL or GitHub org into the provider it belongs to.find_cohortsEvery scored population of providers in the catalog.curl "https://apis.io/api/v1/apis/optimizely-websites-api"
curl "https://apis.io/api/v1/apis?limit=25"
Discovery needs no key. Ratings and market analysis are Pro.
openapi: 3.2.0
info:
title: Optimizely Websites API
version: '1.0'
description: 'Operations tagged Websites across 2 of this provider''s published API definitions: optimizely-configured-commerce-admin-api-v1-openapi.json, optimizely-configured-commerce-storefront-api-v1-openapi.json. Each path carries the servers of the definition it was published in.'
servers:
- url: https://dogfood.commerce.insitesandbox.com
security: []
tags:
- name: Websites
paths:
/api/v1/admin/Websites:
get:
tags:
- Websites
summary: Returns the EntitySet Websites
operationId: Websites_Get
parameters:
- name: $expand
in: query
description: Expands related entities inline.
required: false
schema:
type: string
- name: $filter
in: query
description: Filters the results, based on a Boolean condition.
required: false
schema:
type: string
- name: $select
in: query
description: Selects which properties to include in the response.
required: false
schema:
type: string
- name: $apply
in: query
description: Aggregates the results according to one or more transformations.
required: false
schema:
type: string
- name: $orderby
in: query
description: Sorts the results.
required: false
schema:
type: string
- name: $top
in: query
description: Returns only the first n results.
required: false
schema:
type: integer
format: int32
- name: $skip
in: query
description: Skips the first n results.
required: false
schema:
type: integer
format: int32
- name: $count
in: query
description: Includes a count of the matching results in the response.
required: false
schema:
type: boolean
responses:
'200':
description: OK
content:
'*/*':
schema:
type: object
deprecated: false
security:
- access_token: []
post:
tags:
- Websites
summary: Post a new entity to EntitySet Websites
operationId: Websites_Post
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/Insite.Data.Entities.Website'
description: The entity to post
required: true
responses:
'200':
description: OK
content:
'*/*':
schema:
type: object
deprecated: false
security:
- access_token: []
servers:
- url: https://dogfood.commerce.insitesandbox.com
/api/v1/admin/Websites({id}):
get:
tags:
- Websites
summary: Returns the entity with the key from Websites
operationId: Websites_GetById
parameters:
- name: id
in: path
description: 'key: id'
required: true
schema:
type: string
format: uuid
- name: $expand
in: query
description: Expands related entities inline.
required: false
schema:
type: string
- name: $select
in: query
description: Selects which properties to include in the response.
required: false
schema:
type: string
responses:
'200':
description: OK
content:
'*/*':
schema:
type: object
deprecated: false
security:
- access_token: []
put:
tags:
- Websites
summary: Replace entity in EntitySet Websites
operationId: Websites_PutById
parameters:
- name: id
in: path
description: 'key: id'
required: true
schema:
type: string
format: uuid
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/Insite.Data.Entities.Website'
description: The entity to put
required: true
responses:
'200':
description: OK
content:
'*/*':
schema:
type: object
deprecated: false
security:
- access_token: []
delete:
tags:
- Websites
summary: Delete entity in EntitySet Websites
operationId: Websites_DeleteById
parameters:
- name: id
in: path
description: 'key: id'
required: true
schema:
type: string
format: uuid
- name: If-Match
in: header
description: If-Match header
required: false
schema:
type: string
responses:
'200':
description: OK
content:
'*/*':
schema:
type: object
deprecated: false
security:
- access_token: []
patch:
tags:
- Websites
summary: Update entity in EntitySet Websites
operationId: Websites_PatchById
parameters:
- name: id
in: path
description: 'key: id'
required: true
schema:
type: string
format: uuid
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/Insite.Data.Entities.Website'
description: The entity to patch
required: true
responses:
'200':
description: OK
content:
'*/*':
schema:
type: object
deprecated: false
security:
- access_token: []
servers:
- url: https://dogfood.commerce.insitesandbox.com
/api/v1/admin/Websites/Default.Default():
get:
tags:
- Websites
summary: Call operation Default
operationId: Websites_Default
responses:
'200':
description: OK
content:
'*/*':
schema:
type: object
deprecated: false
security:
- access_token: []
servers:
- url: https://dogfood.commerce.insitesandbox.com
/api/v1/admin/Websites/Default.archive:
post:
tags:
- Websites
summary: Call operation archive
operationId: Websites_Archive
parameters:
- name: ids
in: query
required: true
explode: true
schema:
type: array
items:
type: string
format: uuid
requestBody:
$ref: '#/components/requestBodies/Affiliates_ArchiveParameters'
responses:
'200':
description: OK
content:
'*/*':
schema:
type: object
deprecated: false
security:
- access_token: []
servers:
- url: https://dogfood.commerce.insitesandbox.com
/api/v1/admin/Websites({id})/Default.userProfilesWithRolesFilter():
get:
tags:
- Websites
summary: Call operation userProfilesWithRolesFilter
operationId: Websites_GetUserProfilesWithRolesFilterById
parameters:
- name: id
in: path
description: 'key: id'
required: true
schema:
type: string
format: uuid
- name: $expand
in: query
description: Expands related entities inline.
required: false
schema:
type: string
- name: $select
in: query
description: Selects which properties to include in the response.
required: false
schema:
type: string
responses:
'200':
description: OK
content:
'*/*':
schema:
type: object
deprecated: false
security:
- access_token: []
servers:
- url: https://dogfood.commerce.insitesandbox.com
/api/v1/admin/websites({key})/userProfilesWithRolesFilter:
get:
tags:
- Websites
operationId: Websites_GetUserProfilesWithRolesFilterByKey
parameters:
- name: key
in: path
required: true
schema:
type: string
format: uuid
- name: $expand
in: query
description: Expands related entities inline.
required: false
schema:
type: string
- name: $select
in: query
description: Selects which properties to include in the response.
required: false
schema:
type: string
responses:
'200':
description: OK
content:
'*/*':
schema:
type: object
deprecated: false
security:
- access_token: []
servers:
- url: https://dogfood.commerce.insitesandbox.com
/api/v1/admin/websites/IsMicrositeUrlInUseByContent:
get:
tags:
- Websites
operationId: Websites_IsMicrositeUrlInUseByContent
parameters:
- name: value
in: query
required: true
schema:
type: string
- name: $expand
in: query
description: Expands related entities inline.
required: false
schema:
type: string
- name: $select
in: query
description: Selects which properties to include in the response.
required: false
schema:
type: string
responses:
'200':
description: OK
content:
'*/*':
schema:
type: object
deprecated: false
security:
- access_token: []
servers:
- url: https://dogfood.commerce.insitesandbox.com
/api/v1/admin/websites/archive:
delete:
tags:
- Websites
operationId: Websites_ArchiveRoute
parameters:
- name: ids
in: query
required: true
explode: true
schema:
type: array
items:
type: string
format: uuid
responses:
'200':
description: OK
content:
'*/*':
schema:
type: object
deprecated: false
security:
- access_token: []
servers:
- url: https://dogfood.commerce.insitesandbox.com
/api/v1/admin/websites/delete:
delete:
tags:
- Websites
operationId: Websites_DeleteRoute
parameters:
- name: ids
in: query
required: true
explode: true
schema:
type: array
items:
type: string
format: uuid
responses:
'200':
description: OK
content:
'*/*':
schema:
type: object
deprecated: false
security:
- access_token: []
servers:
- url: https://dogfood.commerce.insitesandbox.com
/api/v1/admin/websites({key})/adminuserprofiles({adminuserprofileKey}):
get:
tags:
- Websites
operationId: Websites_GetAdminUserProfileByKeyAndAdminuserprofilekey
parameters:
- name: key
in: path
required: true
schema:
type: string
format: uuid
- name: adminuserprofileKey
in: path
required: true
schema:
type: string
format: uuid
- name: $expand
in: query
description: Expands related entities inline.
required: false
schema:
type: string
- name: $select
in: query
description: Selects which properties to include in the response.
required: false
schema:
type: string
responses:
'200':
description: OK
content:
'*/*':
schema:
type: object
deprecated: false
security:
- access_token: []
servers:
- url: https://dogfood.commerce.insitesandbox.com
/api/v1/admin/websites({key})/applicationmessages({applicationmessageKey}):
get:
tags:
- Websites
operationId: Websites_GetApplicationMessageByKeyAndApplicationmessagekey
parameters:
- name: key
in: path
required: true
schema:
type: string
format: uuid
- name: applicationmessageKey
in: path
required: true
schema:
type: string
format: uuid
- name: $expand
in: query
description: Expands related entities inline.
required: false
schema:
type: string
- name: $select
in: query
description: Selects which properties to include in the response.
required: false
schema:
type: string
responses:
'200':
description: OK
content:
'*/*':
schema:
type: object
deprecated: false
security:
- access_token: []
servers:
- url: https://dogfood.commerce.insitesandbox.com
/api/v1/admin/websites({key})/billtoaddressfields({billtoaddressfieldKey}):
get:
tags:
- Websites
operationId: Websites_GetBillToAddressFieldByKeyAndBilltoaddressfieldkey
parameters:
- name: key
in: path
required: true
schema:
type: string
format: uuid
- name: billtoaddressfieldKey
in: path
required: true
schema:
type: string
format: uuid
- name: $expand
in: query
description: Expands related entities inline.
required: false
schema:
type: string
- name: $select
in: query
description: Selects which properties to include in the response.
required: false
schema:
type: string
responses:
'200':
description: OK
content:
'*/*':
schema:
type: object
deprecated: false
security:
- access_token: []
servers:
- url: https://dogfood.commerce.insitesandbox.com
/api/v1/admin/websites({key})/carriers({carrierKey}):
get:
tags:
- Websites
operationId: Websites_GetCarrierByKeyAndCarrierkey
parameters:
- name: key
in: path
required: true
schema:
type: string
format: uuid
- name: carrierKey
in: path
required: true
schema:
type: string
format: uuid
- name: $expand
in: query
description: Expands related entities inline.
required: false
schema:
type: string
- name: $select
in: query
description: Selects which properties to include in the response.
required: false
schema:
type: string
responses:
'200':
description: OK
content:
'*/*':
schema:
type: object
deprecated: false
security:
- access_token: []
servers:
- url: https://dogfood.commerce.insitesandbox.com
/api/v1/admin/websites({key})/categories({categoryKey}):
get:
tags:
- Websites
operationId: Websites_GetCategoryByKeyAndCategorykey
parameters:
- name: key
in: path
required: true
schema:
type: string
format: uuid
- name: categoryKey
in: path
required: true
schema:
type: string
format: uuid
- name: $expand
in: query
description: Expands related entities inline.
required: false
schema:
type: string
- name: $select
in: query
description: Selects which properties to include in the response.
required: false
schema:
type: string
responses:
'200':
description: OK
content:
'*/*':
schema:
type: object
deprecated: false
security:
- access_token: []
servers:
- url: https://dogfood.commerce.insitesandbox.com
/api/v1/admin/websites({key})/countries({countryKey}):
get:
tags:
- Websites
operationId: Websites_GetCountryByKeyAndCountrykey
parameters:
- name: key
in: path
required: true
schema:
type: string
format: uuid
- name: countryKey
in: path
required: true
schema:
type: string
format: uuid
- name: $expand
in: query
description: Expands related entities inline.
required: false
schema:
type: string
- name: $select
in: query
description: Selects which properties to include in the response.
required: false
schema:
type: string
responses:
'200':
description: OK
content:
'*/*':
schema:
type: object
deprecated: false
security:
- access_token: []
servers:
- url: https://dogfood.commerce.insitesandbox.com
/api/v1/admin/websites({key})/crosssells({productKey}):
get:
tags:
- Websites
operationId: Websites_GetCrossSellByKeyAndProductkey
parameters:
- name: key
in: path
required: true
schema:
type: string
format: uuid
- name: productKey
in: path
required: true
schema:
type: string
format: uuid
- name: $expand
in: query
description: Expands related entities inline.
required: false
schema:
type: string
- name: $select
in: query
description: Selects which properties to include in the response.
required: false
schema:
type: string
responses:
'200':
description: OK
content:
'*/*':
schema:
type: object
deprecated: false
security:
- access_token: []
servers:
- url: https://dogfood.commerce.insitesandbox.com
/api/v1/admin/websites({key})/customers({customerKey}):
get:
tags:
- Websites
operationId: Websites_GetCustomerByKeyAndCustomerkey
parameters:
- name: key
in: path
required: true
schema:
type: string
format: uuid
- name: customerKey
in: path
required: true
schema:
type: string
format: uuid
- name: $expand
in: query
description: Expands related entities inline.
required: false
schema:
type: string
- name: $select
in: query
description: Selects which properties to include in the response.
required: false
schema:
type: string
responses:
'200':
description: OK
content:
'*/*':
schema:
type: object
deprecated: false
security:
- access_token: []
servers:
- url: https://dogfood.commerce.insitesandbox.com
/api/v1/admin/websites({key})/customproperties({custompropertyKey}):
get:
tags:
- Websites
operationId: Websites_GetCustomPropertyByKeyAndCustompropertykey
parameters:
- name: key
in: path
required: true
schema:
type: string
format: uuid
- name: custompropertyKey
in: path
required: true
schema:
type: string
format: uuid
- name: $expand
in: query
description: Expands related entities inline.
required: false
schema:
type: string
- name: $select
in: query
description: Selects which properties to include in the response.
required: false
schema:
type: string
responses:
'200':
description: OK
content:
'*/*':
schema:
type: object
deprecated: false
security:
- access_token: []
servers:
- url: https://dogfood.commerce.insitesandbox.com
/api/v1/admin/websites({key})/dealers({dealerKey}):
get:
tags:
- Websites
operationId: Websites_GetDealerByKeyAndDealerkey
parameters:
- name: key
in: path
required: true
schema:
type: string
format: uuid
- name: dealerKey
in: path
required: true
schema:
type: string
format: uuid
- name: $expand
in: query
description: Expands related entities inline.
required: false
schema:
type: string
- name: $select
in: query
description: Selects which properties to include in the response.
required: false
schema:
type: string
responses:
'200':
description: OK
content:
'*/*':
schema:
type: object
deprecated: false
security:
- access_token: []
servers:
- url: https://dogfood.commerce.insitesandbox.com
/api/v1/admin/websites({key})/experiments({experimentKey}):
get:
tags:
- Websites
operationId: Websites_GetExperimentByKeyAndExperimentkey
parameters:
- name: key
in: path
required: true
schema:
type: string
format: uuid
- name: experimentKey
in: path
required: true
schema:
type: string
format: uuid
- name: $expand
in: query
description: Expands related entities inline.
required: false
schema:
type: string
- name: $select
in: query
description: Selects which properties to include in the response.
required: false
schema:
type: string
responses:
'200':
description: OK
content:
'*/*':
schema:
type: object
deprecated: false
security:
- access_token: []
servers:
- url: https://dogfood.commerce.insitesandbox.com
/api/v1/admin/websites({key})/promotions({promotionKey}):
get:
tags:
- Websites
operationId: Websites_GetPromotionByKeyAndPromotionkey
parameters:
- name: key
in: path
required: true
schema:
type: string
format: uuid
- name: promotionKey
in: path
required: true
schema:
type: string
format: uuid
- name: $expand
in: query
description: Expands related entities inline.
required: false
schema:
type: string
- name: $select
in: query
description: Selects which properties to include in the response.
required: false
schema:
type: string
responses:
'200':
description: OK
content:
'*/*':
schema:
type: object
deprecated: false
security:
- access_token: []
servers:
- url: https://dogfood.commerce.insitesandbox.com
/api/v1/admin/websites({key})/restrictiongroups({restrictiongroupKey}):
get:
tags:
- Websites
operationId: Websites_GetRestrictionGroupByKeyAndRestrictiongroupkey
parameters:
- name: key
in: path
required: true
schema:
type: string
format: uuid
- name: restrictiongroupKey
in: path
required: true
schema:
type: string
format: uuid
- name: $expand
in: query
description: Expands related entities inline.
required: false
schema:
type: string
- name: $select
in: query
description: Selects which properties to include in the response.
required: false
schema:
type: string
responses:
'200':
description: OK
content:
'*/*':
schema:
type: object
deprecated: false
security:
- access_token: []
servers:
- url: https://dogfood.commerce.insitesandbox.com
/api/v1/admin/websites({key})/shiptoaddressfields({shiptoaddressfieldKey}):
get:
tags:
- Websites
operationId: Websites_GetShipToAddressFieldByKeyAndShiptoaddressfieldkey
parameters:
- name: key
in: path
required: true
schema:
type: string
format: uuid
- name: shiptoaddressfieldKey
in: path
required: true
schema:
type: string
format: uuid
- name: $expand
in: query
description: Expands related entities inline.
required: false
schema:
type: string
- name: $select
in: query
description: Selects which properties to include in the response.
required: false
schema:
type: string
responses:
'200':
description: OK
content:
'*/*':
schema:
type: object
deprecated: false
security:
- access_token: []
servers:
- url: https://dogfood.commerce.insitesandbox.com
/api/v1/admin/websites({key})/states({stateKey}):
get:
tags:
- Websites
operationId: Websites_GetStateByKeyAndStatekey
parameters:
- name: key
in: path
required: true
schema:
type: string
format: uuid
- name: stateKey
in: path
required: true
schema:
type: string
format: uuid
- name: $expand
in: query
description: Expands related entities inline.
required: false
schema:
type: string
- name: $select
in: query
description: Selects which properties to include in the response.
required: false
schema:
type: string
responses:
'200':
description: OK
content:
'*/*':
schema:
type: object
deprecated: false
security:
- access_token: []
servers:
- url: https://dogfood.commerce.insitesandbox.com
/api/v1/admin/websites({key})/systemsettings({systemsettingKey}):
get:
tags:
- Websites
operationId: Websites_GetSystemSettingByKeyAndSystemsettingkey
parameters:
- name: key
in: path
required: true
schema:
type: string
format: uuid
- name: systemsettingKey
in: path
required: true
schema:
type: string
format: uuid
- name: $expand
in: query
description: Expands related entities inline.
required: false
schema:
type: string
- name: $select
in: query
description: Selects which properties to include in the response.
required: false
schema:
type: string
responses:
'200':
description: OK
content:
'*/*':
schema:
type: object
deprecated: false
security:
- access_token: []
servers:
- url: https://dogfood.commerce.insitesandbox.com
/api/v1/admin/websites({key})/userprofiles({userprofileKey}):
get:
tags:
- Websites
operationId: Websites_GetUserProfileByKeyAndUserprofilekey
parameters:
- name: key
in: path
required: true
schema:
type: string
format: uuid
- name: userprofileKey
in: path
required: true
schema:
type: string
format: uuid
- name: $expand
in: query
description: Expands related entities inline.
required: false
schema:
type: string
- name: $select
in: query
description: Selects which properties to include in the response.
required: false
schema:
type: string
responses:
'200':
description: OK
content:
'*/*':
schema:
type: object
deprecated: false
security:
- access_token: []
servers:
- url: https://dogfood.commerce.insitesandbox.com
/api/v1/admin/websites({key})/warehouses({warehouseKey}):
get:
tags:
- Websites
operationId: Websites_GetWarehouseByKeyAndWarehousekey
parameters:
- name: key
in: path
required: true
schema:
type: string
format: uuid
- name: warehouseKey
in: path
required: true
schema:
type: string
format: uuid
- name: $expand
in: query
description: Expands related entities inline.
required: false
schema:
type: string
- name: $select
in: query
description: Selects which properties to include in the response.
required: false
schema:
type: string
responses:
'200':
description: OK
content:
'*/*':
schema:
type: object
deprecated: false
security:
- access_token: []
servers:
- url: https://dogfood.commerce.insitesandbox.com
/api/v1/admin/websites({key})/websitecurrencies({websitecurrencyKey}):
get:
tags:
- Websites
operationId: Websites_GetWebsiteCurrencyByKeyAndWebsitecurrencykey
parameters:
- name: key
in: path
required: true
schema:
type: string
format: uuid
- name: websitecurrencyKey
in: path
required: true
schema:
type: string
format: uuid
- name: $expand
in: query
description: Expands related entities inline.
required: false
schema:
type: string
- name: $select
in: query
description: Selects which properties to include in the response.
required: false
schema:
type: string
responses:
'200':
description: OK
content:
'*/*':
schema:
type: object
deprecated: false
security:
- access_token: []
servers:
- url: https://dogfood.commerce.insitesandbox.com
/api/v1/admin/websites({key})/websitelanguages({websitelanguageKey}):
get:
tags:
- Websites
operationId: Websites_GetWebsiteLanguageByKeyAndWebsitelanguagekey
parameters:
- name: key
in: path
required: true
schema:
type: string
format: uuid
- name: websitelanguageKey
in: path
required: true
schema:
type: string
format: uuid
- name: $expand
in: query
description: Expands related entities inline.
required: false
schema:
type: string
- name: $select
in: query
description: Selects which properties to include in the response.
required: false
schema:
type: string
responses:
'200':
description: OK
content:
'*/*':
schema:
type: object
deprecated: false
security:
- access_token: []
servers:
- url: https://dogfood.commerce.insitesandbox.com
/api/v1/websites/current/countries:
get:
tags:
- Websites
operationId: CountriesV1_GetCollectionAsync
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/Insite.Websites.WebApi.V1.ApiModels.CountryCollectionModel'
text/json:
schema:
$ref: '#/components/schemas/Insite.Websites.WebApi.V1.ApiModels.CountryCollectionModel'
application/xml:
schema:
$ref: '#/components/schemas/Insite.Websites.WebApi.V1.ApiModels.CountryCollectionModel'
# --- truncated at 32 KB (84 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/optimizely/refs/heads/main/openapi/optimizely-websites-api-openapi.yml