Conga · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Conga Accounts API

5 actions 5 updates phrasing extends openapi/conga-accounts-api-openapi.yml

Generated by API Evangelist Written by API Evangelist tooling for Conga's API. It is a proposal applied on top of the contract, not a document Conga publishes.

View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 5

$.info

$.paths['/accounts/active'].get

$.paths['/v1/cs-account/usage'].get

$.paths['/api/clm/v1/accounts/{accountId}/contracts/hierarchy/query'].post

$.paths['/api/clm/v1/accounts/{accountId}/contracts/{contractId}/hierarchy/query'].post

OpenAPI Overlay

# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Conga Accounts API
  version: 1.0.0
extends: openapi/conga-accounts-api-openapi.yml
actions:
- target: $.info
  update:
    x-apievangelist-phrasing:
      method: generated
      generated: '2026-10-01'
      generator: build-phrasing.py
      label: Generated by API Evangelist
      operations: 4
- target: $.paths['/accounts/active'].get
  update:
    x-apievangelist-phrasing:
      intent: Get the active account's price list
      effect: read
      questions:
      - Which price list applies to the active account?
      - Can I see the active account's pricing for a particular storefront?
      instructions:
      - text: Get the active price list for account {accountId}.
        slots:
          accountId: header.accountId
      - text: Show the active account pricing for account {accountId} on storefront {storeFrontId}.
        slots:
          accountId: header.accountId
          storeFrontId: header.storeFrontId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/cs-account/usage'].get
  update:
    x-apievangelist-phrasing:
      intent: Get e-signature usage for my account
      effect: read
      questions:
      - How many signing transactions has our account used?
      - Where can I check current account usage in Conga Sign?
      instructions:
      - text: Show usage information for my signing account.
      - text: Get the current account's e-signature usage.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/clm/v1/accounts/{accountId}/contracts/hierarchy/query'].post
  update:
    x-apievangelist-phrasing:
      intent: Query the contract hierarchy for an account
      effect: read
      questions:
      - How can I see every contract under an account arranged as a parent-child hierarchy?
      - Can I filter an account's contract tree to only active agreements?
      instructions:
      - text: Get the full contract hierarchy for account {accountId}.
        slots:
          accountId: path.accountId
      - text: Query account {accountId}'s contract hierarchy where {CriteriaExpression}, returning {Limit} records.
        slots:
          accountId: path.accountId
          CriteriaExpression: requestBody.CriteriaExpression
          Limit: requestBody.Limit
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/clm/v1/accounts/{accountId}/contracts/{contractId}/hierarchy/query'].post
  update:
    x-apievangelist-phrasing:
      intent: Get the hierarchy below one contract of an account
      effect: read
      questions:
      - Which child agreements sit beneath a specific contract on an account?
      - Can I start the contract tree from one particular contract rather than the whole account?
      instructions:
      - text: Show the hierarchy starting from contract {contractId} under account {accountId}.
        slots:
          contractId: path.contractId
          accountId: path.accountId
      - text: Return fields {Fields} for the contract tree rooted at {contractId} on account {accountId}.
        slots:
          Fields: requestBody.Fields
          contractId: path.contractId
          accountId: path.accountId
      method: generated
      generated: '2026-10-01'