Conga

Conga Favorites API

The Favorites API from Conga — 7 operation(s) for favorites.

GitHub OpenAPI

Operations 10

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 /favorites List favorite configurations · Retrieves a list of favorite configurations #
Ask an LLM
“Which favorite configurations have been saved?”
“Can I filter and page through favorites?”
Tell an agent
List my favorite configurations.
List favorites matching filter {filter}.
DELETE /favorites Delete favorite records in bulk · Delete the favorite records #
Ask an LLM
“Can I delete several favorites in a single request?”
“How do I bulk-remove favorite configurations?”
Tell an agent destructive · confirm first
Bulk delete the selected favorite records.
Remove multiple favorites at once.
GET /favorites/{id} Get a favorite configuration (lowercase id path) · Retrieves a favorite configuration by its identifier #
Ask an LLM
“Is there a separate lookup for a favorite configuration by identifier?”
“Which endpoint retrieves a favorite configuration via the lowercase id route?”
Tell an agent
Retrieve the favorite configuration {id} via the configuration lookup.
Get favorite configuration record {id}.
DELETE /favorites/{Id} Delete a favorite · Delete a favorite #
Ask an LLM
“Can I delete one favorite I saved?”
“Does removing a favorite affect carts it was added to?”
Tell an agent destructive · confirm first
Delete favorite {Id}.
Remove the favorite {Id}.
GET /favorites/{Id} Fetch a favorite by ID · Fetch favorite by ID #
Ask an LLM
“How do I fetch a single favorite?”
“What does one saved favorite contain?”
Tell an agent
Fetch favorite {Id}.
Show me favorite {Id}.
PATCH /favorites/{Id} Update a favorite · Update a favorite #
Ask an LLM
“How do I change a saved favorite?”
“Can a favorite update run asynchronously?”
Tell an agent
Update favorite {Id}.
Update favorite {Id} for line numbers {lines} asynchronously.
POST /favorites/{Id}/addtocart/{cartId} Add a favorite to a cart · Add favorite to a cart #
Ask an LLM
“Can I drop a saved favorite into a cart?”
“Is there a way to add a favorite without its adjustments?”
Tell an agent
Add favorite {Id} to cart {cart}.
Add favorite {Id} to cart {cart} excluding adjustments.
DELETE /favorites/{Id}/items Remove line items from a favorite · Delete the line-items from within the Favorite #
Ask an LLM
“How do I clear the line items inside a favorite?”
“Can I keep a favorite but delete its items?”
Tell an agent destructive · confirm first
Delete the line items inside favorite {Id}.
Empty out the items of favorite {Id}.
GET /favorites/{Id}/preview Preview a favorite · Preview favorite by ID #
Ask an LLM
“Can I preview what a favorite contains before using it?”
“Is there a preview for a favorite under a given config name?”
Tell an agent
Preview favorite {Id}.
Preview favorite {Id} with config {config}.
POST /favorites/{Id}/publish Publish a favorite to a price list · Publish favorite to a pricelist #
Ask an LLM
“How do I publish a favorite to a price list?”
“Can publishing a favorite run asynchronously?”
Tell an agent
Publish favorite {Id} to its price list.
Publish favorite {Id} to the pricelist asynchronously.

Documentation

📖
Authentication
https://raw.githubusercontent.com/api-evangelist/conga/refs/heads/main/authentication/conga-authentication.yml
📖
RateLimits
https://raw.githubusercontent.com/api-evangelist/conga/refs/heads/main/rate-limits/conga-rate-limits.yml

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/conga/refs/heads/main/openapi/conga-favorites-api-openapi.yml

Other Resources

🔗
DataModel
https://raw.githubusercontent.com/api-evangelist/conga/refs/heads/main/data-model/conga-data-model.yml
🔗
OAuthScopes
https://raw.githubusercontent.com/api-evangelist/conga/refs/heads/main/scopes/conga-scopes.yml
🔗
Conventions
https://raw.githubusercontent.com/api-evangelist/conga/refs/heads/main/conventions/conga-conventions.yml
🔗
ErrorCatalog
https://raw.githubusercontent.com/api-evangelist/conga/refs/heads/main/errors/conga-problem-types.yml
🔗
Lifecycle
https://raw.githubusercontent.com/api-evangelist/conga/refs/heads/main/lifecycle/conga-lifecycle.yml
🔗
Conformance
https://raw.githubusercontent.com/api-evangelist/conga/refs/heads/main/conformance/conga-conformance.yml
🔗
Sandbox
https://raw.githubusercontent.com/api-evangelist/conga/refs/heads/main/sandbox/conga-sandbox.yml
🔗
Webhooks
https://raw.githubusercontent.com/api-evangelist/conga/refs/heads/main/asyncapi/conga-webhooks.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/conga:conga-favorites-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

conga-favorites-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: Conga Favorites API
  version: 1.0.0
  description: 'Operations tagged Favorites across 2 of this provider''s published API definitions: conga-administration.json, conga-catalog.json. Each path carries the servers of the definition it was published in.'
servers:
- url: https://rls.congacloud.com/api/revenue-admin/v1
- url: https://rls.congacloud.com/api/catalog/v1
security:
- Bearer: []
tags:
- name: Favorites
paths:
  /favorites:
    get:
      tags:
      - Favorites
      summary: Retrieves a list of favorite configurations
      parameters:
      - name: filter
        in: query
        description: Optional filter criteria.
        schema:
          type: array
          items:
            type: string
      - name: sort
        in: query
        description: Optional sort order.
        schema:
          type: string
      - name: page
        in: query
        description: 'Page number (default: 1).'
        schema:
          type: integer
          format: int32
          default: 1
      - name: limit
        in: query
        description: 'Number of items per page (default: 50).'
        schema:
          type: integer
          format: int32
          default: 50
      - name: field
        in: query
        description: Optional fields to include in the response.
        schema:
          type: array
          items:
            type: string
      - name: filterExpression
        in: query
        description: Optional filter expression.
        schema:
          type: string
      responses:
        '200':
          description: Returns the list of favorite configurations.
        '204':
          description: No favorite configurations found.
      operationId: getFavorites
      x-operation-id-source: derived
    delete:
      tags:
      - Favorites
      summary: Delete the favorite records
      requestBody:
        description: ''
        content:
          application/json-patch+json:
            schema:
              type: array
              items:
                $ref: '#/components/schemas/Conga.Revenue.Entities.Platform.FavoriteConfiguration'
          application/json:
            schema:
              type: array
              items:
                $ref: '#/components/schemas/Conga.Revenue.Entities.Platform.FavoriteConfiguration'
          text/json:
            schema:
              type: array
              items:
                $ref: '#/components/schemas/Conga.Revenue.Entities.Platform.FavoriteConfiguration'
          application/*+json:
            schema:
              type: array
              items:
                $ref: '#/components/schemas/Conga.Revenue.Entities.Platform.FavoriteConfiguration'
      responses:
        '200':
          description: OK
      deprecated: true
      operationId: deleteFavorites
      x-operation-id-source: derived
    servers:
    - url: https://rls.congacloud.com/api/revenue-admin/v1
  /favorites/{id}:
    get:
      tags:
      - Favorites
      summary: Retrieves a favorite configuration by its identifier
      parameters:
      - name: id
        in: path
        description: The unique identifier of the favorite configuration.
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Returns the favorite configuration.
        '204':
          description: No favorite configuration found for the given identifier.
      operationId: getFavoritesById
      x-operation-id-source: derived
    servers:
    - url: https://rls.congacloud.com/api/revenue-admin/v1
  /favorites/{Id}:
    delete:
      tags:
      - Favorites
      summary: Delete a favorite
      parameters:
      - name: Id
        in: path
        description: A unique identifier of the favorite.
        required: true
        schema:
          type: string
      responses:
        '200':
          description: OK
      deprecated: true
      operationId: deleteFavoritesById
      x-operation-id-source: derived
    get:
      tags:
      - Favorites
      summary: Fetch favorite by ID
      parameters:
      - name: Id
        in: path
        description: A unique identifier of the favorite.
        required: true
        schema:
          type: string
      responses:
        '200':
          description: OK
      deprecated: true
      operationId: getFavoritesById
      x-operation-id-source: derived
    patch:
      tags:
      - Favorites
      summary: Update a favorite
      parameters:
      - name: Id
        in: path
        description: A unique identifier of the favorite.
        required: true
        schema:
          type: string
      - name: isasync
        in: query
        description: if set to `true` [is asynchronous].
        schema:
          type: boolean
      - name: line-numbers
        in: query
        description: "Line numbers.\n            The following example shows how to specify multiple line numbers:\n            GET  ../api/cart/v1/carts/{cartId}/status?lineNumbers=1,2,3"
        schema:
          type: array
          items:
            type: integer
            format: int32
      requestBody:
        description: Favorite record fields to be updated.
        content:
          application/json-patch+json:
            schema:
              type: object
              additionalProperties: {}
            example:
              Name: CreateFavorite
              Description: CreateFavorite
              Scope: Public
          application/json:
            schema:
              type: object
              additionalProperties: {}
            example:
              Name: CreateFavorite
              Description: CreateFavorite
              Scope: Public
          text/json:
            schema:
              type: object
              additionalProperties: {}
            example:
              Name: CreateFavorite
              Description: CreateFavorite
              Scope: Public
          application/*+json:
            schema:
              type: object
              additionalProperties: {}
            example:
              Name: CreateFavorite
              Description: CreateFavorite
              Scope: Public
      responses:
        '200':
          description: OK
      deprecated: true
      operationId: patchFavoritesById
      x-operation-id-source: derived
    servers:
    - url: https://rls.congacloud.com/api/catalog/v1
  /favorites/{Id}/addtocart/{cartId}:
    post:
      tags:
      - Favorites
      summary: Add favorite to a cart
      description: Adds a favorite to the cart identified in cartId.
      parameters:
      - name: Id
        in: path
        description: The identifier
        required: true
        schema:
          type: string
      - name: cartId
        in: path
        description: A unique identifier of the cart.
        required: true
        schema:
          type: string
      - name: isasync
        in: query
        description: if set to `true` [is asynchronous].
        schema:
          type: boolean
      - name: excludeadjustments
        in: query
        description: Set to <i>True</i> to exclude adjustments.
        schema:
          type: boolean
      responses:
        '200':
          description: OK
      deprecated: true
      operationId: postFavoritesByIdAddtocartByCartId
      x-operation-id-source: derived
    servers:
    - url: https://rls.congacloud.com/api/catalog/v1
  /favorites/{Id}/items:
    delete:
      tags:
      - Favorites
      summary: Delete the line-items from within the Favorite
      parameters:
      - name: Id
        in: path
        description: Favorite Id
        required: true
        schema:
          type: string
      requestBody:
        description: line-items to be removed
        content:
          application/json-patch+json:
            schema:
              type: array
              items:
                type: object
                additionalProperties: {}
          application/json:
            schema:
              type: array
              items:
                type: object
                additionalProperties: {}
          text/json:
            schema:
              type: array
              items:
                type: object
                additionalProperties: {}
          application/*+json:
            schema:
              type: array
              items:
                type: object
                additionalProperties: {}
      responses:
        '200':
          description: OK
      deprecated: true
      operationId: deleteFavoritesByIdItems
      x-operation-id-source: derived
    servers:
    - url: https://rls.congacloud.com/api/catalog/v1
  /favorites/{Id}/preview:
    get:
      tags:
      - Favorites
      summary: Preview favorite by ID
      parameters:
      - name: Id
        in: path
        description: A unique identifier of the favorite to preview it.
        required: true
        schema:
          type: string
      - name: configName
        in: query
        description: Preview Favorite response field list
        schema:
          type: string
          default: PreviewFavoriteResponseFieldList_Default
      responses:
        '200':
          description: OK
      deprecated: true
      operationId: getFavoritesByIdPreview
      x-operation-id-source: derived
    servers:
    - url: https://rls.congacloud.com/api/catalog/v1
  /favorites/{Id}/publish:
    post:
      tags:
      - Favorites
      summary: Publish favorite to a pricelist
      description: Publishes a favorite for the given pricelist.
      parameters:
      - name: Id
        in: path
        description: A unique identifier of the favorite.
        required: true
        schema:
          type: string
      - name: isasync
        in: query
        description: if set to `true` [is asynchronous].
        schema:
          type: boolean
      requestBody:
        description: A unique identifier for the price list.
        content:
          application/json-patch+json:
            schema:
              type: array
              items:
                type: string
          application/json:
            schema:
              type: array
              items:
                type: string
          text/json:
            schema:
              type: array
              items:
                type: string
          application/*+json:
            schema:
              type: array
              items:
                type: string
      responses:
        '200':
          description: OK
      deprecated: true
      operationId: postFavoritesByIdPublish
      x-operation-id-source: derived
    servers:
    - url: https://rls.congacloud.com/api/catalog/v1
components:
  schemas:
    Conga.Revenue.Catalog.API.Models.CatalogError:
      type: object
      properties:
        code:
          type: integer
          description: Error code
          format: int32
        message:
          type:
          - string
          - 'null'
          description: Error Message
        timestamp:
          type: string
          description: Time when the error occurred
          format: date-time
        additionalDetails:
          description: Additional details about the error
      additionalProperties: false
      description: Error object returned by the Catalog APIs
    Conga.Revenue.Entities.BaseEntity:
      type: object
      properties:
        createdBy:
          $ref: '#/components/schemas/Conga.Revenue.Entities.BaseEntity'
        createdDate:
          type:
          - string
          - 'null'
          format: date-time
        id:
          type:
          - string
          - 'null'
        modifiedBy:
          $ref: '#/components/schemas/Conga.Revenue.Entities.BaseEntity'
        modifiedDate:
          type:
          - string
          - 'null'
          format: date-time
        name:
          type:
          - string
          - 'null'
        currency:
          type:
          - string
          - 'null'
        digest:
          type:
          - string
          - 'null'
      additionalProperties: {}
    Conga.Platform.Common.Models.LookupObject:
      type: object
      properties:
        id:
          type:
          - string
          - 'null'
        name:
          type:
          - string
          - 'null'
      additionalProperties: false
    Conga.Revenue.Entities.Platform.FavoritePriceListMetadata:
      type: object
      properties:
        id:
          type:
          - string
          - 'null'
        isSource:
          type:
          - boolean
          - 'null'
      additionalProperties: false
    Conga.Revenue.Entities.Platform.FavoriteConfiguration:
      type: object
      properties:
        id:
          type:
          - string
          - 'null'
        name:
          type:
          - string
          - 'null'
        createdBy:
          $ref: '#/components/schemas/Conga.Platform.Common.Models.LookupObject'
        createdDate:
          type: string
          format: date-time
        modifiedBy:
          $ref: '#/components/schemas/Conga.Platform.Common.Models.LookupObject'
        modifiedDate:
          type: string
          format: date-time
        externalId:
          type:
          - string
          - 'null'
        eTag:
          type:
          - string
          - 'null'
        productConfiguration:
          $ref: '#/components/schemas/Conga.Platform.Common.Models.LookupObject'
        description:
          type:
          - string
          - 'null'
        isActive:
          type:
          - boolean
          - 'null'
        lastUsedDate:
          type:
          - string
          - 'null'
          format: date-time
        favoritePriceList:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/Conga.Revenue.Entities.Platform.FavoritePriceListMetadata'
        scope:
          type:
          - string
          - 'null'
        type:
          type:
          - string
          - 'null'
      additionalProperties: {}
    Conga.Revenue.Entities.FavoriteConfiguration:
      type: object
      properties:
        createdBy:
          $ref: '#/components/schemas/Conga.Revenue.Entities.BaseEntity'
        createdDate:
          type:
          - string
          - 'null'
          format: date-time
        id:
          type:
          - string
          - 'null'
        modifiedBy:
          $ref: '#/components/schemas/Conga.Revenue.Entities.BaseEntity'
        modifiedDate:
          type:
          - string
          - 'null'
          format: date-time
        name:
          type:
          - string
          - 'null'
        currency:
          type:
          - string
          - 'null'
        digest:
          type:
          - string
          - 'null'
      additionalProperties: {}
  securitySchemes:
    Bearer:
      type: apiKey
      description: Please insert JWT with Bearer into field
      name: Authorization
      in: header
x-refined-from:
- conga-administration.json
- conga-catalog.json