Optimizely Budgets API

The Budgets API from Optimizely — 2 operation(s) for budgets.

Documentation GitHub OpenAPI

Operations 3

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/budgets List budgets · Budgets V1 get collection async #

Ask an LLM

“Which budgets are available to me in the storefront?”

“Can I see budgets for a particular ship-to address or user?”

Tell an agent

List my budgets.

Show budgets for ship-to {shipToId}.

GET /api/v1/budgets/{fiscalYear} Get the budget for a fiscal year · Budgets V1 get async #

Ask an LLM

“What does my budget look like for a given fiscal year?”

“Can I get the full budget grid for one year?”

Tell an agent

Show the budget for fiscal year {fiscalYear}.

Get the {fiscalYear} budget as a full grid: {fullGrid}.

PATCH /api/v1/budgets/{fiscalYear} Update the budget for a fiscal year · Budgets V1 patch async #

Ask an LLM

“How do I change budget amounts for a fiscal year?”

“Can I update a year's budget lines for a specific ship-to?”

Tell an agent

Update the budget lines for fiscal year {fiscalYear} to {budgetLineCollection}.

Set the {fiscalYear} budget end date to {fiscalYearEndDate}.

Specifications

⚙

OpenAPI

https://raw.githubusercontent.com/api-evangelist/optimizely/refs/heads/main/openapi/optimizely-budgets-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-budgets-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: storefront-v1
  title: Storefront API V1 Budgets API
servers:
- url: https://dogfood.commerce.insitesandbox.com
security: []
tags:
- name: Budgets
paths:
  /api/v1/budgets:
    get:
      tags:
      - Budgets
      operationId: BudgetsV1_GetCollectionAsync
      parameters:
      - name: parameter.shipToId
        in: query
        required: false
        schema:
          type: string
          format: uuid
      - name: parameter.userProfileId
        in: query
        required: false
        schema:
          type: string
          format: uuid
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Insite.Budget.WebApi.V1.ApiModels.BudgetCollectionModel'
            text/json:
              schema:
                $ref: '#/components/schemas/Insite.Budget.WebApi.V1.ApiModels.BudgetCollectionModel'
            application/xml:
              schema:
                $ref: '#/components/schemas/Insite.Budget.WebApi.V1.ApiModels.BudgetCollectionModel'
            text/xml:
              schema:
                $ref: '#/components/schemas/Insite.Budget.WebApi.V1.ApiModels.BudgetCollectionModel'
            text/html:
              schema:
                $ref: '#/components/schemas/Insite.Budget.WebApi.V1.ApiModels.BudgetCollectionModel'
      security:
      - access_token: []
      summary: Budgets V1 get collection async
      x-summary-source: derived
  /api/v1/budgets/{fiscalYear}:
    get:
      tags:
      - Budgets
      operationId: BudgetsV1_GetAsync
      parameters:
      - name: fiscalYear
        in: path
        required: true
        schema:
          type: integer
          format: int32
      - name: parameter.fiscalYear
        in: query
        required: false
        schema:
          type: integer
          format: int32
      - name: parameter.shipToId
        in: query
        required: false
        schema:
          type: string
          format: uuid
      - name: parameter.userProfileId
        in: query
        required: false
        schema:
          type: string
          format: uuid
      - name: parameter.fullGrid
        in: query
        required: false
        schema:
          type: boolean
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Insite.Budget.WebApi.V1.ApiModels.BudgetModel'
            text/json:
              schema:
                $ref: '#/components/schemas/Insite.Budget.WebApi.V1.ApiModels.BudgetModel'
            application/xml:
              schema:
                $ref: '#/components/schemas/Insite.Budget.WebApi.V1.ApiModels.BudgetModel'
            text/xml:
              schema:
                $ref: '#/components/schemas/Insite.Budget.WebApi.V1.ApiModels.BudgetModel'
            text/html:
              schema:
                $ref: '#/components/schemas/Insite.Budget.WebApi.V1.ApiModels.BudgetModel'
      security:
      - access_token: []
      summary: Budgets V1 get async
      x-summary-source: derived
    patch:
      tags:
      - Budgets
      operationId: BudgetsV1_PatchAsync
      parameters:
      - name: fiscalYear
        in: path
        required: true
        schema:
          type: integer
          format: int32
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Insite.Budget.WebApi.V1.ApiModels.BudgetModel'
          text/json:
            schema:
              $ref: '#/components/schemas/Insite.Budget.WebApi.V1.ApiModels.BudgetModel'
          application/xml:
            schema:
              $ref: '#/components/schemas/Insite.Budget.WebApi.V1.ApiModels.BudgetModel'
          text/xml:
            schema:
              $ref: '#/components/schemas/Insite.Budget.WebApi.V1.ApiModels.BudgetModel'
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/Insite.Budget.WebApi.V1.ApiModels.BudgetModel'
          text/html:
            schema:
              $ref: '#/components/schemas/Insite.Budget.WebApi.V1.ApiModels.BudgetModel'
        required: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Insite.Budget.WebApi.V1.ApiModels.BudgetModel'
            text/json:
              schema:
                $ref: '#/components/schemas/Insite.Budget.WebApi.V1.ApiModels.BudgetModel'
            application/xml:
              schema:
                $ref: '#/components/schemas/Insite.Budget.WebApi.V1.ApiModels.BudgetModel'
            text/xml:
              schema:
                $ref: '#/components/schemas/Insite.Budget.WebApi.V1.ApiModels.BudgetModel'
            text/html:
              schema:
                $ref: '#/components/schemas/Insite.Budget.WebApi.V1.ApiModels.BudgetModel'
      security:
      - access_token: []
      summary: Budgets V1 patch async
      x-summary-source: derived
components:
  schemas:
    Insite.Budget.WebApi.V1.ApiModels.BudgetModel:
      type: object
      properties:
        uri:
          type: string
        fiscalYear:
          format: int32
          type: integer
        fiscalYearEndDate:
          format: date-time
          type: string
        budgetLineCollection:
          type: array
          items:
            $ref: '#/components/schemas/Insite.Budget.WebApi.V1.ApiModels.BudgetLineModel'
        userProfileId:
          type: string
        shipToId:
          type: string
        properties:
          type: object
          additionalProperties:
            type: string
    Insite.Budget.WebApi.V1.ApiModels.BudgetLineModel:
      type: object
      properties:
        uri:
          type: string
        period:
          format: int32
          type: integer
        startDate:
          format: date-time
          type: string
        currentFiscalYearBudget:
          format: decimal
          type: number
        currentFiscalYearBudgetDisplay:
          type: string
        currentFiscalYearActual:
          format: decimal
          type: number
        currentFiscalYearActualDisplay:
          type: string
        currentFiscalYearVariance:
          format: decimal
          type: number
        currentFiscalYearVarianceDisplay:
          type: string
        lastFiscalYearBudget:
          format: decimal
          type: number
        lastFiscalYearBudgetDisplay:
          type: string
        lastFiscalYearActual:
          format: decimal
          type: number
        lastFiscalYearActualDisplay:
          type: string
        lastFiscalYearVariance:
          format: decimal
          type: number
        lastFiscalYearVarianceDisplay:
          type: string
        properties:
          type: object
          additionalProperties:
            type: string
    Insite.Budget.WebApi.V1.ApiModels.BudgetCollectionModel:
      type: object
      properties:
        uri:
          type: string
        budgetCollection:
          type: array
          items:
            $ref: '#/components/schemas/Insite.Budget.WebApi.V1.ApiModels.BudgetModel'
        properties:
          type: object
          additionalProperties:
            type: string
  securitySchemes:
    access_token:
      type: apiKey
      description: Token used to access storefront API.
      name: access_token
      in: query