Optimizely

Optimizely Budget Calendars API

The Budget Calendars API from Optimizely — 5 operation(s) for budget calendars.

GitHub OpenAPI

Operations 12

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/BudgetCalendars List budget calendars · Returns the EntitySet BudgetCalendars #
Ask an LLM
“What fiscal-year budget calendars are set up for my B2B customers?”
“Can I filter budget calendars to one fiscal year or customer?”
Tell an agent
List all budget calendars.
List budget calendars where {filter}.
POST /api/v1/admin/BudgetCalendars Create a budget calendar · Post a new entity to EntitySet BudgetCalendars #
Ask an LLM
“How do I define budget periods for a customer's fiscal year?”
“Can a budget calendar have up to thirteen periods?”
Tell an agent
Create a budget calendar for customer {customerId} in fiscal year {fiscalYear}.
Add a {fiscalYear} budget calendar starting period one on {period1StartDate} and ending {fiscalYearEndDate}.
GET /api/v1/admin/BudgetCalendars({id}) Get a budget calendar by id · Returns the entity with the key from BudgetCalendars #
Ask an LLM
“When does each budget period start for a given budget calendar?”
“Can I look up one budget calendar record by id?”
Tell an agent
Get budget calendar {id}.
Fetch budget calendar {id} returning only {select}.
PUT /api/v1/admin/BudgetCalendars({id}) Replace a budget calendar · Replace entity in EntitySet BudgetCalendars #
Ask an LLM
“How do I overwrite every period date on a budget calendar at once?”
“What does a full replacement of a budget calendar need?”
Tell an agent
Replace budget calendar {id} with fiscal year {fiscalYear}.
Overwrite budget calendar {id} with fiscal year end {fiscalYearEndDate}.
DELETE /api/v1/admin/BudgetCalendars({id}) Delete a budget calendar · Delete entity in EntitySet BudgetCalendars #
Ask an LLM
“Can I remove one budget calendar by its id?”
“Does deleting a budget calendar support an If-Match ETag?”
Tell an agent destructive · confirm first
Delete budget calendar {id}.
Delete budget calendar {id} if its ETag is {etag}.
PATCH /api/v1/admin/BudgetCalendars({id}) Update dates on a budget calendar · Update entity in EntitySet BudgetCalendars #
Ask an LLM
“How do I shift just one period's start date on a budget calendar?”
“Can I change a budget calendar's fiscal year end without resending all periods?”
Tell an agent
Move period 2 of budget calendar {id} to start on {period2StartDate}.
Set the fiscal year end of budget calendar {id} to {fiscalYearEndDate}.
GET /api/v1/admin/BudgetCalendars/Default.Default() Get a blank budget calendar template · Call operation Default #
Ask an LLM
“What default values does a new budget calendar start with?”
“Is there an empty budget calendar template to fill in?”
Tell an agent
Get the default budget calendar template.
Show the defaults for a new budget calendar.
DELETE /api/v1/admin/budgetcalendars/delete Bulk delete budget calendars · Budget calendars delete route #
Ask an LLM
“Can I delete several budget calendars in one request?”
“How do I remove a list of budget calendars by id at once?”
Tell an agent destructive · confirm first
Bulk delete budget calendars {ids}.
Remove the budget calendars with ids {ids}.
GET /api/v1/admin/budgetcalendars({key})/customproperties({custompropertyKey}) Get a custom property of a budget calendar · Budget calendars get custom property by key and custompropertykey #
Ask an LLM
“What custom property values are stored on a budget calendar?”
“Can I read one extension field from a budget calendar?”
Tell an agent
Get custom property {custompropertyKey} of budget calendar {key}.
Read custom field {custompropertyKey} on budget calendar {key}.
GET /api/v1/budgetcalendars List budget calendars through the storefront API · Budget calendars V1 get collection async #
Ask an LLM
“Which fiscal years have budget calendars set up for the signed-in customer?”
“Can the website API show me the budget periods defined for my account?”
Tell an agent
Show the storefront budget calendars for the current customer.
List every fiscal year budget calendar available through the website API.
GET /api/v1/budgetcalendars/{fiscalYear} Get the budget calendar for a fiscal year · Budget calendars V1 get async #
Ask an LLM
“What budget periods are defined for a given fiscal year?”
“When does a particular fiscal year end in the budget calendar?”
Tell an agent
Get the budget calendar for fiscal year {fiscalYear}.
Show budget periods for fiscal year {fiscalYear}.
PATCH /api/v1/budgetcalendars/{fiscalYear} Update a fiscal year's budget calendar · Budget calendars V1 patch async #
Ask an LLM
“How do I change the budget periods for a fiscal year?”
“Can I set the fiscal year end date on a budget calendar?”
Tell an agent
Set the end date of fiscal year {fiscalYear} to {fiscalYearEndDate}.
Update budget periods for fiscal year {fiscalYear} to {budgetPeriods}.

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/optimizely/refs/heads/main/openapi/optimizely-budget-calendars-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-budget-calendars-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-budget-calendars-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  version: admin-v1
  title: Admin API V1 Budget Calendars API
servers:
- url: https://dogfood.commerce.insitesandbox.com
security: []
tags:
- name: Budget Calendars
paths:
  /api/v1/admin/BudgetCalendars:
    get:
      tags:
      - Budget Calendars
      summary: Returns the EntitySet BudgetCalendars
      operationId: BudgetCalendars_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:
      - Budget Calendars
      summary: Post a new entity to EntitySet BudgetCalendars
      operationId: BudgetCalendars_Post
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Insite.Data.Entities.BudgetCalendar'
        description: The entity to post
        required: true
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                type: object
      deprecated: false
      security:
      - access_token: []
  /api/v1/admin/BudgetCalendars({id}):
    get:
      tags:
      - Budget Calendars
      summary: Returns the entity with the key from BudgetCalendars
      operationId: BudgetCalendars_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:
      - Budget Calendars
      summary: Replace entity in EntitySet BudgetCalendars
      operationId: BudgetCalendars_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.BudgetCalendar'
        description: The entity to put
        required: true
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                type: object
      deprecated: false
      security:
      - access_token: []
    delete:
      tags:
      - Budget Calendars
      summary: Delete entity in EntitySet BudgetCalendars
      operationId: BudgetCalendars_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:
      - Budget Calendars
      summary: Update entity in EntitySet BudgetCalendars
      operationId: BudgetCalendars_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.BudgetCalendar'
        description: The entity to patch
        required: true
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                type: object
      deprecated: false
      security:
      - access_token: []
  /api/v1/admin/BudgetCalendars/Default.Default():
    get:
      tags:
      - Budget Calendars
      summary: Call operation Default
      operationId: BudgetCalendars_Default
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                type: object
      deprecated: false
      security:
      - access_token: []
  /api/v1/admin/budgetcalendars/delete:
    delete:
      tags:
      - Budget Calendars
      operationId: BudgetCalendars_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: Budget calendars delete route
      x-summary-source: derived
  /api/v1/admin/budgetcalendars({key})/customproperties({custompropertyKey}):
    get:
      tags:
      - Budget Calendars
      operationId: BudgetCalendars_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: Budget calendars get custom property by key and custompropertykey
      x-summary-source: derived
  /api/v1/budgetcalendars:
    get:
      tags:
      - Budget Calendars
      operationId: BudgetCalendarsV1_GetCollectionAsync
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Insite.Budget.WebApi.V1.ApiModels.BudgetCalendarCollectionModel'
            text/json:
              schema:
                $ref: '#/components/schemas/Insite.Budget.WebApi.V1.ApiModels.BudgetCalendarCollectionModel'
            application/xml:
              schema:
                $ref: '#/components/schemas/Insite.Budget.WebApi.V1.ApiModels.BudgetCalendarCollectionModel'
            text/xml:
              schema:
                $ref: '#/components/schemas/Insite.Budget.WebApi.V1.ApiModels.BudgetCalendarCollectionModel'
            text/html:
              schema:
                $ref: '#/components/schemas/Insite.Budget.WebApi.V1.ApiModels.BudgetCalendarCollectionModel'
      security:
      - access_token: []
      summary: Budget calendars V1 get collection async
      x-summary-source: derived
  /api/v1/budgetcalendars/{fiscalYear}:
    get:
      tags:
      - Budget Calendars
      operationId: BudgetCalendarsV1_GetAsync
      parameters:
      - name: fiscalYear
        in: path
        required: true
        schema:
          type: integer
          format: int32
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Insite.Budget.WebApi.V1.ApiModels.BudgetCalendarModel'
            text/json:
              schema:
                $ref: '#/components/schemas/Insite.Budget.WebApi.V1.ApiModels.BudgetCalendarModel'
            application/xml:
              schema:
                $ref: '#/components/schemas/Insite.Budget.WebApi.V1.ApiModels.BudgetCalendarModel'
            text/xml:
              schema:
                $ref: '#/components/schemas/Insite.Budget.WebApi.V1.ApiModels.BudgetCalendarModel'
            text/html:
              schema:
                $ref: '#/components/schemas/Insite.Budget.WebApi.V1.ApiModels.BudgetCalendarModel'
      security:
      - access_token: []
      summary: Budget calendars V1 get async
      x-summary-source: derived
    patch:
      tags:
      - Budget Calendars
      operationId: BudgetCalendarsV1_PatchAsync
      parameters:
      - name: fiscalYear
        in: path
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Insite.Budget.WebApi.V1.ApiModels.BudgetCalendarModel'
          text/json:
            schema:
              $ref: '#/components/schemas/Insite.Budget.WebApi.V1.ApiModels.BudgetCalendarModel'
          application/xml:
            schema:
              $ref: '#/components/schemas/Insite.Budget.WebApi.V1.ApiModels.BudgetCalendarModel'
          text/xml:
            schema:
              $ref: '#/components/schemas/Insite.Budget.WebApi.V1.ApiModels.BudgetCalendarModel'
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/Insite.Budget.WebApi.V1.ApiModels.BudgetCalendarModel'
          text/html:
            schema:
              $ref: '#/components/schemas/Insite.Budget.WebApi.V1.ApiModels.BudgetCalendarModel'
        required: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Insite.Budget.WebApi.V1.ApiModels.BudgetCalendarModel'
            text/json:
              schema:
                $ref: '#/components/schemas/Insite.Budget.WebApi.V1.ApiModels.BudgetCalendarModel'
            application/xml:
              schema:
                $ref: '#/components/schemas/Insite.Budget.WebApi.V1.ApiModels.BudgetCalendarModel'
            text/xml:
              schema:
                $ref: '#/components/schemas/Insite.Budget.WebApi.V1.ApiModels.BudgetCalendarModel'
            text/html:
              schema:
                $ref: '#/components/schemas/Insite.Budget.WebApi.V1.ApiModels.BudgetCalendarModel'
      security:
      - access_token: []
      summary: Budget calendars V1 patch async
      x-summary-source: derived
components:
  schemas:
    Insite.Data.Entities.BudgetCalendar:
      type: object
      properties:
        id:
          format: uuid
          type: string
          example: 00000000-0000-0000-0000-000000000000
        customerId:
          format: uuid
          type: string
          example: 00000000-0000-0000-0000-000000000000
        fiscalYear:
          format: int32
          type: integer
        period1StartDate:
          format: date-time
          type: string
        period2StartDate:
          format: date-time
          type: string
        period3StartDate:
          format: date-time
          type: string
        period4StartDate:
          format: date-time
          type: string
        period5StartDate:
          format: date-time
          type: string
        period6StartDate:
          format: date-time
          type: string
        period7StartDate:
          format: date-time
          type: string
        period8StartDate:
          format: date-time
          type: string
        period9StartDate:
          format: date-time
          type: string
        period10StartDate:
          format: date-time
          type: string
        period11StartDate:
          format: date-time
          type: string
        period12StartDate:
          format: date-time
          type: string
        period13StartDate:
          format: date-time
          type: string
        fiscalYearEndDate:
          format: date-time
          type: string
        createdOn:
          format: date-time
          type: string
        createdBy:
          type: string
        modifiedOn:
          format: date-time
          type: string
        modifiedBy:
          type: string
    Insite.Budget.WebApi.V1.ApiModels.BudgetCalendarModel:
      type: object
      properties:
        uri:
          type: string
        fiscalYear:
          format: int32
          type: integer
        fiscalYearEndDate:
          format: date-time
          type: string
        budgetPeriods:
          type: array
          items:
            format: date-time
            type: string
        properties:
          type: object
          additionalProperties:
            type: string
    Insite.Budget.WebApi.V1.ApiModels.BudgetCalendarCollectionModel:
      type: object
      properties:
        uri:
          type: string
        budgetCalendarCollection:
          type: array
          items:
            $ref: '#/components/schemas/Insite.Budget.WebApi.V1.ApiModels.BudgetCalendarModel'
        properties:
          type: object
          additionalProperties:
            type: string
  securitySchemes:
    access_token:
      type: apiKey
      description: Token used to access storefront API.
      name: access_token
      in: query