Optimizely

Optimizely Property Permissions API

The Property Permissions API from Optimizely — 5 operation(s) for property permissions.

GitHub OpenAPI

Operations 9

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/PropertyPermissions List field-level property permissions · Returns the EntitySet PropertyPermissions #
Ask an LLM
“How do I see which admin roles can view or edit each configured property?”
“Can I filter property permissions to one role name?”
Tell an agent
List all property permissions.
List property permissions matching {filter}.
POST /api/v1/admin/PropertyPermissions Grant a role access to a property · Post a new entity to EntitySet PropertyPermissions #
Ask an LLM
“How do I let a role view but not edit a specific property?”
“What is required to create a property permission for a role?”
Tell an agent
Grant role {roleName} view access {canView} and edit access {canEdit} on property configuration {propertyConfigurationId}.
Create a property permission for role {roleName}.
GET /api/v1/admin/PropertyPermissions({id}) Get one property permission · Returns the entity with the key from PropertyPermissions #
Ask an LLM
“How do I check the view and edit flags on a single property permission?”
“Can I fetch a property permission by its ID?”
Tell an agent
Get property permission {id}.
Show whether property permission {id} allows viewing and editing.
PUT /api/v1/admin/PropertyPermissions({id}) Replace a property permission · Replace entity in EntitySet PropertyPermissions #
Ask an LLM
“How do I overwrite a whole property permission record?”
“Is there a way to fully replace a role's property permission instead of patching it?”
Tell an agent
Replace property permission {id} for role {roleName} with canEdit {canEdit}.
Overwrite property permission {id} with a complete record for role {roleName}.
DELETE /api/v1/admin/PropertyPermissions({id}) Delete a property permission · Delete entity in EntitySet PropertyPermissions #
Ask an LLM
“How do I remove a role's permission on a property?”
“Can I delete a property permission only if its ETag still matches?”
Tell an agent destructive · confirm first
Delete property permission {id}.
Remove property permission {id} if its ETag is still {etag}.
PATCH /api/v1/admin/PropertyPermissions({id}) Change a role's view or edit rights on a property · Update entity in EntitySet PropertyPermissions #
Ask an LLM
“How do I revoke edit rights on a property for a role without deleting the permission?”
“Can I flip just the canView flag on an existing property permission?”
Tell an agent
Set canEdit to {canEdit} on property permission {id}.
Set canView to {canView} on property permission {id}.
GET /api/v1/admin/PropertyPermissions/Default.Default() Get a blank property permission template · Call operation Default #
Ask an LLM
“What default values does a new property permission start with?”
“Can I fetch an empty property permission template before creating one?”
Tell an agent
Fetch the default property permission template.
Show me the starting values for a new property permission.
DELETE /api/v1/admin/propertypermissions/delete Bulk delete property permissions · Property permissions delete route #
Ask an LLM
“How do I delete several property permissions at once?”
“Can I remove a batch of property permissions by ID?”
Tell an agent destructive · confirm first
Bulk delete the property permissions with IDs {ids}.
Remove these property permissions in one call: {ids}.
GET /api/v1/admin/propertypermissions({key})/customproperties({custompropertyKey}) Get a custom property on a property permission · Property permissions get custom property by key and custompropertykey #
Ask an LLM
“How do I read a custom property stored on a property permission record?”
“Can I fetch one extra field value from a property permission?”
Tell an agent
Get custom property {custompropertyKey} on property permission {key}.
Show the custom property {custompropertyKey} of permission record {key}.

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/optimizely/refs/heads/main/openapi/optimizely-property-permissions-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-property-permissions-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-property-permissions-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  version: admin-v1
  title: Admin API V1 Property Permissions API
servers:
- url: https://dogfood.commerce.insitesandbox.com
security: []
tags:
- name: Property Permissions
paths:
  /api/v1/admin/PropertyPermissions:
    get:
      tags:
      - Property Permissions
      summary: Returns the EntitySet PropertyPermissions
      operationId: PropertyPermissions_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:
      - Property Permissions
      summary: Post a new entity to EntitySet PropertyPermissions
      operationId: PropertyPermissions_Post
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Insite.Data.Entities.PropertyPermission'
        description: The entity to post
        required: true
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                type: object
      deprecated: false
      security:
      - access_token: []
  /api/v1/admin/PropertyPermissions({id}):
    get:
      tags:
      - Property Permissions
      summary: Returns the entity with the key from PropertyPermissions
      operationId: PropertyPermissions_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:
      - Property Permissions
      summary: Replace entity in EntitySet PropertyPermissions
      operationId: PropertyPermissions_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.PropertyPermission'
        description: The entity to put
        required: true
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                type: object
      deprecated: false
      security:
      - access_token: []
    delete:
      tags:
      - Property Permissions
      summary: Delete entity in EntitySet PropertyPermissions
      operationId: PropertyPermissions_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:
      - Property Permissions
      summary: Update entity in EntitySet PropertyPermissions
      operationId: PropertyPermissions_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.PropertyPermission'
        description: The entity to patch
        required: true
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                type: object
      deprecated: false
      security:
      - access_token: []
  /api/v1/admin/PropertyPermissions/Default.Default():
    get:
      tags:
      - Property Permissions
      summary: Call operation Default
      operationId: PropertyPermissions_Default
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                type: object
      deprecated: false
      security:
      - access_token: []
  /api/v1/admin/propertypermissions/delete:
    delete:
      tags:
      - Property Permissions
      operationId: PropertyPermissions_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: []
      summary: Property permissions delete route
      x-summary-source: derived
  /api/v1/admin/propertypermissions({key})/customproperties({custompropertyKey}):
    get:
      tags:
      - Property Permissions
      operationId: PropertyPermissions_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: []
      summary: Property permissions get custom property by key and custompropertykey
      x-summary-source: derived
components:
  schemas:
    Insite.Data.Entities.PropertyPermission:
      required:
      - roleName
      type: object
      properties:
        id:
          format: uuid
          type: string
          example: 00000000-0000-0000-0000-000000000000
        canView:
          type: boolean
        canEdit:
          type: boolean
        propertyConfigurationId:
          format: uuid
          type: string
          example: 00000000-0000-0000-0000-000000000000
        roleName:
          maxLength: 256
          minLength: 0
          type: string
        createdOn:
          format: date-time
          type: string
        createdBy:
          type: string
        modifiedOn:
          format: date-time
          type: string
        modifiedBy:
          type: string
  securitySchemes:
    access_token:
      type: apiKey
      description: Token used to access storefront API.
      name: access_token
      in: query