Optimizely Restriction Group Customers API

The Restriction Group Customers API from Optimizely — 5 operation(s) for restriction group customers.

Documentation 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/RestrictionGroupCustomers List customer assignments to restriction groups · Returns the EntitySet RestrictionGroupCustomers #

Ask an LLM

“Which customers are assigned to product restriction groups?”

“Can I filter restriction group assignments by customer or group?”

Tell an agent

List all restriction group customer assignments.

List restriction group customers matching {filter}.

POST /api/v1/admin/RestrictionGroupCustomers Assign a customer to a restriction group · Post a new entity to EntitySet RestrictionGroupCustomers #

Ask an LLM

“How do I put a customer into a restriction group so their catalog is limited?”

“Can a restriction apply only when the customer is the bill-to or only the ship-to?”

Tell an agent

Add customer {customerId} to restriction group {restrictionGroupId}.

Assign customer {customerId} to group {restrictionGroupId}, applying when ship-to is {applyWhenShipTo}.

GET /api/v1/admin/RestrictionGroupCustomers({id}) Get one restriction group assignment · Returns the entity with the key from RestrictionGroupCustomers #

Ask an LLM

“How do I look up a single customer-to-restriction-group assignment?”

“Can I expand the customer on one restriction group assignment?”

Tell an agent

Get restriction group customer {id}.

Show restriction group assignment {id} with {expand} expanded.

PUT /api/v1/admin/RestrictionGroupCustomers({id}) Replace a restriction group assignment · Replace entity in EntitySet RestrictionGroupCustomers #

Ask an LLM

“How do I overwrite a customer's restriction group assignment in full?”

“Does replacing an assignment reset the bill-to and ship-to flags?”

Tell an agent

Replace assignment {id} with customer {customerId} in group {restrictionGroupId}.

Fully overwrite restriction group customer record {id}.

DELETE /api/v1/admin/RestrictionGroupCustomers({id}) Remove a customer from a restriction group · Delete entity in EntitySet RestrictionGroupCustomers #

Ask an LLM

“How do I lift a product restriction by removing the customer from the group?”

“Can I make the removal conditional on the record's ETag?”

Tell an agent destructive · confirm first

Delete restriction group assignment {id}.

Remove assignment {id} if its ETag is {ifMatch}.

PATCH /api/v1/admin/RestrictionGroupCustomers({id}) Change when a restriction applies to a customer · Update entity in EntitySet RestrictionGroupCustomers #

Ask an LLM

“Can I switch a restriction to apply only when the customer is the bill-to?”

“How do I move a customer's assignment to another restriction group?”

Tell an agent

Set apply-when-bill-to to {applyWhenBillTo} on assignment {id}.

Move assignment {id} to restriction group {restrictionGroupId}.

GET /api/v1/admin/RestrictionGroupCustomers/Default.Default() Call the Default function on restriction assignments · Call operation Default #

Ask an LLM

“What does the Default OData function on restriction group customers return?”

“Is there a default restriction group customer entity to start from?”

Tell an agent

Call the Default function on restriction group customers.

Get the default restriction group customer entity.

DELETE /api/v1/admin/restrictiongroupcustomers/delete Bulk remove restriction group assignments · Restriction group customers delete route #

Ask an LLM

“Can I remove many customers from restriction groups in a single call?”

“How do I delete a list of restriction group assignments by ID?”

Tell an agent destructive · confirm first

Bulk delete restriction group assignments {ids}.

Remove these customer restriction assignments: {ids}.

GET /api/v1/admin/restrictiongroupcustomers({key})/customproperties({custompropertyKey}) Get a custom property on a restriction assignment · Restriction group customers get custom property by key and custompropertykey #

Ask an LLM

“How do I read a custom property stored on a restriction group assignment?”

“Can restriction group customer records carry custom fields?”

Tell an agent

Get custom property {custompropertyKey} of restriction assignment {key}.

Read custom field {custompropertyKey} on restriction group customer {key}.

Specifications

⚙

OpenAPI

https://raw.githubusercontent.com/api-evangelist/optimizely/refs/heads/main/openapi/optimizely-restriction-group-customers-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-restriction-group-customers-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

openapi: 3.2.0
info:
  version: admin-v1
  title: Admin API V1 Restriction Group Customers API
servers:
- url: https://dogfood.commerce.insitesandbox.com
security: []
tags:
- name: Restriction Group Customers
paths:
  /api/v1/admin/RestrictionGroupCustomers:
    get:
      tags:
      - Restriction Group Customers
      summary: Returns the EntitySet RestrictionGroupCustomers
      operationId: RestrictionGroupCustomers_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:
      - Restriction Group Customers
      summary: Post a new entity to EntitySet RestrictionGroupCustomers
      operationId: RestrictionGroupCustomers_Post
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Insite.Data.Entities.RestrictionGroupCustomer'
        description: The entity to post
        required: true
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                type: object
      deprecated: false
      security:
      - access_token: []
  /api/v1/admin/RestrictionGroupCustomers({id}):
    get:
      tags:
      - Restriction Group Customers
      summary: Returns the entity with the key from RestrictionGroupCustomers
      operationId: RestrictionGroupCustomers_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:
      - Restriction Group Customers
      summary: Replace entity in EntitySet RestrictionGroupCustomers
      operationId: RestrictionGroupCustomers_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.RestrictionGroupCustomer'
        description: The entity to put
        required: true
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                type: object
      deprecated: false
      security:
      - access_token: []
    delete:
      tags:
      - Restriction Group Customers
      summary: Delete entity in EntitySet RestrictionGroupCustomers
      operationId: RestrictionGroupCustomers_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:
      - Restriction Group Customers
      summary: Update entity in EntitySet RestrictionGroupCustomers
      operationId: RestrictionGroupCustomers_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.RestrictionGroupCustomer'
        description: The entity to patch
        required: true
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                type: object
      deprecated: false
      security:
      - access_token: []
  /api/v1/admin/RestrictionGroupCustomers/Default.Default():
    get:
      tags:
      - Restriction Group Customers
      summary: Call operation Default
      operationId: RestrictionGroupCustomers_Default
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                type: object
      deprecated: false
      security:
      - access_token: []
  /api/v1/admin/restrictiongroupcustomers/delete:
    delete:
      tags:
      - Restriction Group Customers
      operationId: RestrictionGroupCustomers_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: Restriction group customers delete route
      x-summary-source: derived
  /api/v1/admin/restrictiongroupcustomers({key})/customproperties({custompropertyKey}):
    get:
      tags:
      - Restriction Group Customers
      operationId: RestrictionGroupCustomers_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: Restriction group customers get custom property by key and custompropertykey
      x-summary-source: derived
components:
  schemas:
    Insite.Data.Entities.RestrictionGroupCustomer:
      type: object
      properties:
        id:
          format: uuid
          type: string
          example: 00000000-0000-0000-0000-000000000000
        restrictionGroupId:
          format: uuid
          type: string
          example: 00000000-0000-0000-0000-000000000000
        customerId:
          format: uuid
          type: string
          example: 00000000-0000-0000-0000-000000000000
        applyWhenBillTo:
          type: boolean
        applyWhenShipTo:
          type: boolean
        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