Optimizely

Optimizely User Profiles API

The User Profiles API from Optimizely — 26 operation(s) for user profiles.

GitHub OpenAPI

Operations 33

Each operation below carries the questions people ask an LLM about it and the instructions they give an agent to run it. Generated by API Evangelist overlay

GET /api/v1/admin/UserProfiles List user profiles · Returns the EntitySet UserProfiles #
Ask an LLM
“How do I pull a list of every user profile in the commerce admin?”
“Can I filter user profiles by last name or activation status and page through them?”
Tell an agent
List all user profiles.
List user profiles matching {filter}, sorted by {orderby}, first {top} only.
POST /api/v1/admin/UserProfiles Create a user profile · Post a new entity to EntitySet UserProfiles #
Ask an LLM
“What fields are required to add a new user profile to the storefront admin?”
“Can I create a buyer account with a default customer and warehouse already set?”
Tell an agent
Create a user profile for {firstName} {lastName} with email {email} and username {userName}.
Add a new user {userName} at company {company} linked to customer {defaultCustomerId}.
GET /api/v1/admin/UserProfiles({id}) Get a user profile by id · Returns the entity with the key from UserProfiles #
Ask an LLM
“How can I look up a single user profile when I know its id?”
“Can I expand related records inline when fetching one user profile?”
Tell an agent
Get user profile {id}.
Fetch user profile {id} and expand {expand}.
PUT /api/v1/admin/UserProfiles({id}) Replace a user profile · Replace entity in EntitySet UserProfiles #
Ask an LLM
“Is there a way to overwrite an entire user profile record in one call?”
“What happens to fields I leave out when I fully replace a user profile?”
Tell an agent
Replace user profile {id} entirely with a new record for {email}.
Overwrite the whole user profile {id}, setting position to {position}.
DELETE /api/v1/admin/UserProfiles({id}) Delete a user profile · Delete entity in EntitySet UserProfiles #
Ask an LLM
“Can I permanently remove one user profile by its id?”
“Does deleting a single user profile support an If-Match concurrency check?”
Tell an agent destructive · confirm first
Delete user profile {id}.
Delete user profile {id} only if its ETag still matches {etag}.
PATCH /api/v1/admin/UserProfiles({id}) Update fields on a user profile · Update entity in EntitySet UserProfiles #
Ask an LLM
“How do I change just a user's phone number without resending the whole profile?”
“Can I deactivate a user by patching their profile?”
Tell an agent
Change the phone number on user profile {id} to {phone}.
Mark user profile {id} as deactivated: {isDeactivated}.
GET /api/v1/admin/UserProfiles/Default.Default() Get a blank user profile template · Call operation Default #
Ask an LLM
“What default values does a brand-new user profile start with?”
“Is there an empty user profile template I can fill in before creating one?”
Tell an agent
Get the default user profile template.
Show me the default field values for a new user profile.
GET /api/v1/admin/UserProfiles({id})/Default.Roles() Get a user's roles via the Roles function · Call operation Roles #
Ask an LLM
“Which roles are attached to a user profile, using the Default.Roles() function?”
“Can I call the OData Roles function on a user profile id to see its permissions?”
Tell an agent
Call the Roles function for user profile {id}.
Run Default.Roles() on user {id} and filter to {filter}.
GET /api/v1/admin/UserProfiles/Default.Current() Get the signed-in user via the Current function · Call operation Current #
Ask an LLM
“Which user profile am I signed in as, using the Default.Current() OData function?”
“Can the Current function tell me the calling admin's own profile?”
Tell an agent
Call Default.Current() to get my own user profile.
Run the Current function and select only {select}.
GET /api/v1/admin/userprofiles/current Get the signed-in user from the current route · User profiles current 2 #
Ask an LLM
“Is there a plain /userprofiles/current route that returns my own profile?”
“What does the lowercase current-user route return for the caller?”
Tell an agent
Fetch my profile from the userprofiles/current route.
Get the current user record from the current route and expand {expand}.
GET /api/v1/admin/userprofiles({key})/roles List roles assigned to a user · User profiles get roles by key #
Ask an LLM
“Where can I read the role list for a user from the roles sub-route?”
“Can I see which admin roles a specific user currently holds?”
Tell an agent
List the roles on user profile {key} from its roles route.
Show roles for user {key}, first {top}.
PUT /api/v1/admin/userprofiles({key})/roles Replace a user's roles (PUT) · User profiles set roles by key 1 #
Ask an LLM
“Can I overwrite the full set of roles a user has with a PUT?”
“How are a user's roles replaced rather than appended?”
Tell an agent
Replace the role set on user profile {key} using PUT.
PUT a new role list onto user {key}.
POST /api/v1/admin/userprofiles({key})/roles Assign roles to a user (POST) · User profiles set roles by key 2 #
Ask an LLM
“Is there a POST route for assigning roles to a user?”
“Can I grant roles to a user profile by posting to its roles endpoint?”
Tell an agent
POST roles to user profile {key}.
Grant roles to user {key} through the POST roles route.
DELETE /api/v1/admin/userprofiles({key})/roles Remove roles from a user · User profiles delete roles by key #
Ask an LLM
“Can I strip roles off a user profile?”
“What removes the roles a user has been granted?”
Tell an agent destructive · confirm first
Remove the roles from user profile {key}.
Revoke role assignments for user {key}.
GET /api/v1/admin/userprofiles({key})/allowedwebsites List websites a user may access · User profiles allowed websites by key #
Ask an LLM
“Which storefront websites is a given user allowed to sign in to?”
“Can I check the allowed websites for a user profile?”
Tell an agent
List the allowed websites for user {key}.
Show which websites user {key} can access, filtered by {filter}.
GET /api/v1/admin/userprofiles({key})/approvers List a user's order approvers · User profiles approvers by key #
Ask an LLM
“Who can approve orders for a particular user?”
“What approvers are available to a buyer's user profile?”
Tell an agent
List the approvers for user profile {key}.
Show possible order approvers for user {key}.
GET /api/v1/admin/userprofiles({key})/availablecustomers List customers a user can be assigned to · User profiles available customers by key #
Ask an LLM
“Which customers could still be assigned to this user?”
“Can I get the available bill-to customers for a user profile?”
Tell an agent
List available customers for user {key}.
Show the first {top} customers user {key} could be linked to.
DELETE /api/v1/admin/userprofiles/delete Bulk delete user profiles · User profiles delete route #
Ask an LLM
“Can I delete several user profiles at once by passing a list of ids?”
“Is there a bulk delete route for user accounts?”
Tell an agent destructive · confirm first
Bulk delete user profiles {ids}.
Remove all of these users in one call: {ids}.
GET /api/v1/admin/userprofiles({key})/customers({customerKey}) Get a customer linked to a user · User profiles get customer by key and customerkey #
Ask an LLM
“Can I read one specific customer assigned to a user profile?”
“Is a given customer account attached to this user?”
Tell an agent
Get customer {customerKey} assigned to user {key}.
Show the customer record {customerKey} under user profile {key}.
GET /api/v1/admin/userprofiles({key})/customproperties({custompropertyKey}) Get a custom property on a user · User profiles get custom property by key and custompropertykey #
Ask an LLM
“How do I read a custom property stored on a user profile?”
“Can I fetch one extended attribute from a user record?”
Tell an agent
Get custom property {custompropertyKey} on user {key}.
Read user {key}'s custom field {custompropertyKey}.
GET /api/v1/admin/userprofiles({key})/dashboardpanelpositions({dashboardpanelpositionKey}) Get a user's dashboard panel position · User profiles get dashboard panel position by key and dashboardpanelpositionkey #
Ask an LLM
“Where is a given dashboard panel placed for a user?”
“Can I read one saved dashboard layout position for a user profile?”
Tell an agent
Get dashboard panel position {dashboardpanelpositionKey} for user {key}.
Show where user {key} placed dashboard panel {dashboardpanelpositionKey}.
GET /api/v1/admin/userprofiles({key})/emaillists({emaillistKey}) Get an email list a user is on · User profiles get email list by key and emaillistkey #
Ask an LLM
“Is a user subscribed to a particular email list?”
“Can I look up one email list membership on a user profile?”
Tell an agent
Get email list {emaillistKey} for user {key}.
Check user {key}'s membership in email list {emaillistKey}.
GET /api/v1/admin/userprofiles({key})/messagestatuses({messagestatusKey}) Get a message status for a user · User profiles get message status by key and messagestatuskey #
Ask an LLM
“Has a user read a particular site message?”
“What is the status of one message delivered to a user profile?”
Tell an agent
Get message status {messagestatusKey} for user {key}.
Show whether user {key} has seen message status {messagestatusKey}.
GET /api/v1/admin/userprofiles({key})/odppersonas({personaKey}) Get a user's ODP persona · User profiles get odp persona by key and personakey #
Ask an LLM
“Which Optimizely Data Platform persona is attached to a user?”
“Can I read one ODP persona record from a user profile?”
Tell an agent
Get ODP persona {personaKey} for user {key}.
Show the data platform persona {personaKey} linked to user {key}.
GET /api/v1/admin/userprofiles({key})/salespersons({salespersonKey}) Get a salesperson tied to a user · User profiles get salesperson by key and salespersonkey #
Ask an LLM
“Who is the sales rep assigned to a user profile?”
“Can I read one salesperson record linked to a user?”
Tell an agent
Get salesperson {salespersonKey} for user {key}.
Show sales rep {salespersonKey} associated with user {key}.
GET /api/v1/admin/userprofiles({key})/userpaymentprofiles({userpaymentprofileKey}) Get a user's saved payment profile · User profiles get user payment profile by key and userpaymentprofilekey #
Ask an LLM
“Can I see a stored payment method saved on a user's profile?”
“What does one saved payment profile for a user contain?”
Tell an agent
Get payment profile {userpaymentprofileKey} for user {key}.
Show user {key}'s saved card {userpaymentprofileKey}.
GET /api/v1/admin/userprofiles({key})/userprofilepasswords({userprofilepasswordKey}) Get a user's password history record · User profiles get user profile password by key and userprofilepasswordkey #
Ask an LLM
“Can I read a stored password history entry for a user?”
“Where is one previous-password record for a user profile kept?”
Tell an agent
Get password record {userprofilepasswordKey} for user {key}.
Show password history entry {userprofilepasswordKey} of user {key}.
GET /api/v1/admin/userprofiles({key})/userprofilewishlistfavorites({userprofilewishlistfavoriteKey}) Get a user's favorited wish list · User profiles get user profile wish list favorite by key and… #
Ask an LLM
“Which wish lists has a user marked as favorite?”
“Can I read one wish list favorite flag for a user profile?”
Tell an agent
Get wish list favorite {userprofilewishlistfavoriteKey} for user {key}.
Show favorited list entry {userprofilewishlistfavoriteKey} of user {key}.
GET /api/v1/admin/userprofiles({key})/userprofilewishlisthides({userprofilewishlisthideKey}) Get a wish list a user has hidden · User profiles get user profile wish list hide by key and… #
Ask an LLM
“Has a user hidden a shared wish list from view?”
“Can I look up one hidden wish list record for a user?”
Tell an agent
Get hidden wish list record {userprofilewishlisthideKey} for user {key}.
Show wish list hide entry {userprofilewishlisthideKey} of user {key}.
GET /api/v1/admin/userprofiles({key})/userprofilewishlisttags({userprofilewishlisttagKey}) Get a wish list tag on a user · User profiles get user profile wish list tag by key and… #
Ask an LLM
“What tags has a user applied to their wish lists?”
“Can I fetch one wish list tag belonging to a user profile?”
Tell an agent
Get wish list tag {userprofilewishlisttagKey} for user {key}.
Show list tag {userprofilewishlisttagKey} created by user {key}.
GET /api/v1/admin/userprofiles({key})/websites({websiteKey}) Get a website assigned to a user · User profiles get website by key and websitekey #
Ask an LLM
“Is a specific website assigned to this user profile?”
“Can I read one website record from a user's assigned sites?”
Tell an agent
Get website {websiteKey} assigned to user {key}.
Show assigned site {websiteKey} on user profile {key}.
GET /api/v1/admin/userprofiles({key})/wishlistproducts({wishlistproductKey}) Get a wish list product for a user · User profiles get wish list product by key and wishlistproductkey #
Ask an LLM
“Can I read one product a user has saved to a wish list?”
“What quantity and details does a user's wish list item have?”
Tell an agent
Get wish list product {wishlistproductKey} for user {key}.
Show saved item {wishlistproductKey} on user {key}'s lists.
GET /api/v1/admin/userprofiles({key})/wishlists({wishlistKey}) Get a wish list owned by a user · User profiles get wish list by key and wishlistkey #
Ask an LLM
“Can I pull up one of a user's wish lists by its id?”
“What does a single wish list belonging to a user look like?”
Tell an agent
Get wish list {wishlistKey} owned by user {key}.
Open user {key}'s wish list {wishlistKey}.

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/optimizely/refs/heads/main/openapi/optimizely-user-profiles-api-openapi.yml

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • 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.
All 92 tools →

Call it yourself

curl for this page
This API 
curl "https://apis.io/api/v1/apis/optimizely:optimizely-user-profiles-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

optimizely-user-profiles-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  version: admin-v1
  title: Admin API V1 User Profiles API
servers:
- url: https://dogfood.commerce.insitesandbox.com
security: []
tags:


# --- truncated at 32 KB (40 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/optimizely/refs/heads/main/openapi/optimizely-user-profiles-api-openapi.yml