Conga

Conga Field Expressions API

The Field Expressions API from Conga — 5 operation(s) for field expressions.

GitHub OpenAPI

Operations 15

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

DELETE /field-expressions Delete field expressions in bulk · Delete field expressions #
Ask an LLM
“Can I delete many field expressions at once?”
“How do I bulk-remove field expressions?”
Tell an agent destructive · confirm first
Bulk delete the selected field expressions.
Remove multiple field expressions in one call.
GET /field-expressions List field expressions · Retrieve field expressions #
Ask an LLM
“What field expressions are defined?”
“Can I filter or page through field expressions?”
Tell an agent
List all field expressions.
List field expressions matching {filter}.
PATCH /field-expressions Update field expressions in bulk · Update field expressions #
Ask an LLM
“Can I edit several field expressions in one call?”
“How do I bulk-update field expressions?”
Tell an agent
Bulk update the selected field expressions.
Edit many field expressions at once.
POST /field-expressions Create field expressions · Create field expressions #
Ask an LLM
“How do I create new field expressions?”
“Can I add several field expressions at once?”
Tell an agent
Create new field expressions.
Add a batch of field expressions.
DELETE /field-expressions/{Id} Delete a field expression · Delete a field expression #
Ask an LLM
“Can I delete a single field expression?”
“What happens when one field expression is removed?”
Tell an agent destructive · confirm first
Delete field expression {id}.
Remove only the field expression {id}.
GET /field-expressions/{Id} Get a field expression · Retrieve a field expression #
Ask an LLM
“Where can I see one field expression's definition?”
“Can I include related data when fetching a field expression?”
Tell an agent
Get field expression {id}.
Show field expression {id} including {includes}.
PATCH /field-expressions/{Id} Update a field expression · Update a field expression #
Ask an LLM
“How do I edit one field expression?”
“Can I change a single field expression's formula?”
Tell an agent
Update field expression {id}.
Edit only the field expression {id}.
GET /field-expressions/{id}/constraint-rule-actions Look up constraint rule actions for an expression · Retrieve lookup records for ConstraintRuleAction #
Ask an LLM
“Which constraint rule actions can a field expression reference?”
“Can I page through the ConstraintRuleAction lookup records?”
Tell an agent
Show the constraint rule action lookup records for field expression {id}.
Look up ConstraintRuleAction records available to expression {id}.
DELETE /field-expressions/{parentId}/constraint-rule-action-expressions Delete constraint rule action expressions in bulk · Delete ConstraintRuleActionExpressions #
Ask an LLM
“Can I bulk-remove action expressions from a field expression?”
“How do I delete many constraint rule action expressions?”
Tell an agent destructive · confirm first
Bulk delete constraint rule action expressions under {parent}.
Remove the selected action expressions from field expression {parent}.
GET /field-expressions/{parentId}/constraint-rule-action-expressions List constraint rule action expressions · Retrieve ConstraintRuleActionExpression #
Ask an LLM
“What constraint rule action expressions sit under a field expression?”
“Can I filter the action expressions of a field expression?”
Tell an agent
List constraint rule action expressions under field expression {parent}.
Show action expressions of {parent} matching {filter}.
PATCH /field-expressions/{parentId}/constraint-rule-action-expressions Update constraint rule action expressions in bulk · Update ConstraintRuleActionExpressions #
Ask an LLM
“Can I edit several action expressions in one request?”
“How do I bulk-update constraint rule action expressions?”
Tell an agent
Bulk update constraint rule action expressions under {parent}.
Edit the selected action expressions on field expression {parent}.
POST /field-expressions/{parentId}/constraint-rule-action-expressions Create constraint rule action expressions · Create ConstraintRuleActionExpressions #
Ask an LLM
“How do I add constraint rule action expressions to a field expression?”
“Can I create several action expressions at once?”
Tell an agent
Create constraint rule action expressions under field expression {parent}.
Add new action expressions to {parent}.
DELETE /field-expressions/{parentId}/constraint-rule-action-expressions/{id} Delete a constraint rule action expression · Delete a ConstraintRuleActionExpressions #
Ask an LLM
“Can I delete one constraint rule action expression?”
“How do I remove a single action expression?”
Tell an agent destructive · confirm first
Delete constraint rule action expression {id} under {parent}.
Remove only action expression {id} from {parent}.
GET /field-expressions/{parentId}/constraint-rule-action-expressions/{id} Get a constraint rule action expression · Retrieve a ConstraintRuleActionExpressions #
Ask an LLM
“Where do I see one constraint rule action expression?”
“What does a single action expression contain?”
Tell an agent
Get constraint rule action expression {id} under {parent}.
Show action expression {id} of field expression {parent}.
PATCH /field-expressions/{parentId}/constraint-rule-action-expressions/{id} Update a constraint rule action expression · Update a ConstraintRuleActionExpressions #
Ask an LLM
“How do I edit one constraint rule action expression?”
“Can I change a single action expression?”
Tell an agent
Update constraint rule action expression {id} under {parent}.
Edit only action expression {id} of {parent}.

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-field-expressions-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-field-expressions-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-field-expressions-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: Administration Field Expressions API
  version: 1.0.0
servers:
- url: https://rls.congacloud.com/api/revenue-admin/v1
security:
- Bearer: []
tags:
- name: Field Expressions
paths:
  /field-expressions:
    delete:
      tags:
      - Field Expressions
      summary: Delete field expressions
      description: Deletes multiple field expressions.
      requestBody:
        description: The list of field expressions to delete
        content:
          application/json:
            schema:
              type: array
              items:
                $ref: '#/components/schemas/FieldExpression'
            example:
            - Id: Id of the record to delete
          text/json:
            schema:
              type: array
              items:
                $ref: '#/components/schemas/FieldExpression'
          application/*+json:
            schema:
              type: array
              items:
                $ref: '#/components/schemas/FieldExpression'
      responses:
        '200':
          description: OK
      operationId: deleteFieldExpressions
      x-operation-id-source: derived
    get:
      tags:
      - Field Expressions
      summary: Retrieve field expressions
      description: Retrieves the collection of field expressions.
      parameters:
      - name: filter
        in: query
        description: Optional filter parameters
        schema:
          type: array
          items:
            type: string
      - name: sort
        in: query
        description: Optional sort parameter
        schema:
          type: string
      - name: page
        in: query
        description: Page number
        schema:
          type: integer
          format: int32
          default: 1
      - name: limit
        in: query
        description: Number of items per page
        schema:
          type: integer
          format: int32
          default: 50
      - name: includes
        in: query
        description: Optional related entities to include
        schema:
          type: array
          items:
            type: string
      - name: field
        in: query
        description: Pass Comma separated mulitple fields
        schema:
          type: array
          items:
            type: string
      - name: filterExpression
        in: query
        description: ''
        schema:
          type: string
      responses:
        '200':
          description: OK
        '204':
          description: No Content
      operationId: getFieldExpressions
      x-operation-id-source: derived
    patch:
      tags:
      - Field Expressions
      summary: Update field expressions
      description: Updates multiple field expressions.
      requestBody:
        description: The list of field expressions with updated data
        content:
          application/json:
            schema:
              type: array
              items:
                type: object
                additionalProperties: {}
            example:
            - Name: FieldExpressionName
              IsActive: true
              ConditionExpression: null
              ConditionScope: null
              EvaluationContext: Evaluation Context
              ExpressionType: Expression Type
              Expression: Expression
              GroupByField: null
              IsModifiable: false
              Operation: null
              ParentField: null
              ProductGroup: null
              Product: null
              SourceObject: Source Object
              UpdateField: Update Field
              UpdateObject: Update Object
              Id: Id of the record
          text/json:
            schema:
              type: array
              items:
                type: object
                additionalProperties: {}
          application/*+json:
            schema:
              type: array
              items:
                type: object
                additionalProperties: {}
      responses:
        '200':
          description: OK
      operationId: patchFieldExpressions
      x-operation-id-source: derived
    post:
      tags:
      - Field Expressions
      summary: Create field expressions
      description: Creates multiple field expressions.
      requestBody:
        description: The list of field expressions to create
        content:
          application/json:
            schema:
              type: array
              items:
                $ref: '#/components/schemas/FieldExpression'
          text/json:
            schema:
              type: array
              items:
                $ref: '#/components/schemas/FieldExpression'
          application/*+json:
            schema:
              type: array
              items:
                $ref: '#/components/schemas/FieldExpression'
      responses:
        '200':
          description: OK
      operationId: postFieldExpressions
      x-operation-id-source: derived
  /field-expressions/{Id}:
    delete:
      tags:
      - Field Expressions
      summary: Delete a field expression
      description: Deletes a single field expression by its identifier.
      parameters:
      - name: Id
        in: path
        description: The identifier of the field expression to delete
        required: true
        schema:
          type: string
      responses:
        '200':
          description: OK
      operationId: deleteFieldExpressionsById
      x-operation-id-source: derived
    get:
      tags:
      - Field Expressions
      summary: Retrieve a field expression
      description: Retrieves a single field expression by its identifier.
      parameters:
      - name: Id
        in: path
        description: The identifier of the field expression
        required: true
        schema:
          type: string
      - name: includes
        in: query
        description: Optional related entities to include
        schema:
          type: array
          items:
            type: string
      responses:
        '200':
          description: OK
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/FieldExpression'
            application/json:
              schema:
                $ref: '#/components/schemas/FieldExpression'
            text/json:
              schema:
                $ref: '#/components/schemas/FieldExpression'
      operationId: getFieldExpressionsById
      x-operation-id-source: derived
    patch:
      tags:
      - Field Expressions
      summary: Update a field expression
      description: Updates a single field expression.
      parameters:
      - name: Id
        in: path
        description: The identifier of the field expression to update
        required: true
        schema:
          type: string
      requestBody:
        description: The updated data of the field expression
        content:
          application/json:
            schema:
              type: object
              additionalProperties: {}
            example:
              Name: FieldExpressionName
              IsActive: true
              ConditionExpression: null
              ConditionScope: null
              EvaluationContext: Evaluation Context
              ExpressionType: Expression Type
              Expression: Expression
              GroupByField: null
              IsModifiable: false
              Operation: null
              ParentField: null
              ProductGroup: null
              Product: null
              SourceObject: Source Object
              UpdateField: Update Field
              UpdateObject: Update Object
          text/json:
            schema:
              type: object
              additionalProperties: {}
          application/*+json:
            schema:
              type: object
              additionalProperties: {}
      responses:
        '200':
          description: OK
      operationId: patchFieldExpressionsById
      x-operation-id-source: derived
  /field-expressions/{id}/constraint-rule-actions:
    get:
      tags:
      - Field Expressions
      summary: Retrieve lookup records for ConstraintRuleAction
      description: Retrieves the lookup records for a specific ConstraintRuleAction based on the identifier.
      parameters:
      - name: id
        in: path
        description: The ID of the ConstraintRuleAction
        required: true
        schema:
          type: string
      - name: page
        in: query
        description: The page number
        schema:
          type: integer
          format: int32
          default: 1
      - name: limit
        in: query
        description: The maximum number of records to retrieve per page
        schema:
          type: integer
          format: int32
          default: 50
      responses:
        '200':
          description: OK
      operationId: getFieldExpressionsByIdConstraintRuleActions
      x-operation-id-source: derived
  /field-expressions/{parentId}/constraint-rule-action-expressions:
    delete:
      tags:
      - Field Expressions
      summary: Delete ConstraintRuleActionExpressions
      parameters:
      - name: parentId
        in: path
        description: The ID of the parent entity
        required: true
        schema:
          type: string
      requestBody:
        description: The list of ConstraintRuleActionExpressions to delete
        content:
          application/json:
            schema:
              type: array
              items:
                $ref: '#/components/schemas/ConstraintRuleActionExpression'
            example:
            - Id: Id of the record to delete
          text/json:
            schema:
              type: array
              items:
                $ref: '#/components/schemas/ConstraintRuleActionExpression'
          application/*+json:
            schema:
              type: array
              items:
                $ref: '#/components/schemas/ConstraintRuleActionExpression'
      responses:
        '200':
          description: OK
        '204':
          description: No Content
      operationId: deleteFieldExpressionsByParentIdConstraintRuleActionExpressions
      x-operation-id-source: derived
    get:
      tags:
      - Field Expressions
      summary: Retrieve ConstraintRuleActionExpression
      description: 'Retrieves all ConstraintRuleActionExpressions in a ConstraintRuleAction, with their details. Use query parameters to further narrow the results.


        When executed, this API returns all ConstraintRuleActionExpressions in a ConstraintRuleAction.'
      parameters:
      - name: parentId
        in: path
        description: The ID of the parent entity
        required: true
        schema:
          type: string
      - name: filter
        in: query
        description: Optional filter conditions
        schema:
          type: array
          items:
            type: string
      - name: sort
        in: query
        description: Optional sort expression
        schema:
          type: string
      - name: page
        in: query
        description: The page number
        schema:
          type: integer
          format: int32
          default: 1
      - name: limit
        in: query
        description: The maximum number of records to retrieve per page
        schema:
          type: integer
          format: int32
          default: 50
      - name: includes
        in: query
        description: Optional related entities to include
        schema:
          type: array
          items:
            type: string
      - name: field
        in: query
        description: Pass Comma separated multiple fields
        schema:
          type: array
          items:
            type: string
      - name: filterExpression
        in: query
        description: ''
        schema:
          type: string
      responses:
        '200':
          description: OK
        '204':
          description: No Content
      operationId: getFieldExpressionsByParentIdConstraintRuleActionExpressions
      x-operation-id-source: derived
    patch:
      tags:
      - Field Expressions
      summary: Update ConstraintRuleActionExpressions
      description: 'Updates specific fields on one or more ConstraintRuleActionExpressions. It can update any field except the ConstraintRuleActionExpressions ID.


        When executed, this API returns the updated ConstraintRuleActionExpressions or items.'
      parameters:
      - name: parentId
        in: path
        description: The ID of the parent entity
        required: true
        schema:
          type: string
      requestBody:
        description: The list of ConstraintRuleActionExpressions to update
        content:
          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
      operationId: patchFieldExpressionsByParentIdConstraintRuleActionExpressions
      x-operation-id-source: derived
    post:
      tags:
      - Field Expressions
      summary: Create ConstraintRuleActionExpressions
      description: 'creates one or more ConstraintRuleActionExpressions in a specific ConstraintRuleAction. It can create a maximum of 1000 ConstraintRuleActionExpressions. It can create multiple ConstraintRuleActionExpressions for the same FieldExpression or multiple FieldExpressions. To create multiple ConstraintRuleActionExpressions, pass one array for each ConstraintRuleActionExpressions record in the API request.


        When executed, this API returns a unique ConstraintRuleActionExpressions ID (string) that CPQ automatically generates.'
      parameters:
      - name: parentId
        in: path
        description: The ID of the parent entity
        required: true
        schema:
          type: string
      requestBody:
        description: The list of ConstraintRuleActionExpressions to create
        content:
          application/json:
            schema:
              type: array
              items:
                $ref: '#/components/schemas/ConstraintRuleActionExpression'
          text/json:
            schema:
              type: array
              items:
                $ref: '#/components/schemas/ConstraintRuleActionExpression'
          application/*+json:
            schema:
              type: array
              items:
                $ref: '#/components/schemas/ConstraintRuleActionExpression'
      responses:
        '201':
          description: Created
      operationId: postFieldExpressionsByParentIdConstraintRuleActionExpressions
      x-operation-id-source: derived
  /field-expressions/{parentId}/constraint-rule-action-expressions/{id}:
    delete:
      tags:
      - Field Expressions
      summary: Delete a ConstraintRuleActionExpressions
      description: 'Deletes a specified ConstraintRuleActionExpressions in a ConstraintRuleAction.


        When executed, this API returns the delete status of associated record ID.'
      parameters:
      - name: parentId
        in: path
        description: The ID of the parent entity
        required: true
        schema:
          type: string
      - name: id
        in: path
        description: The ID of the ConstraintRuleActionExpressions to delete
        required: true
        schema:
          type: string
      responses:
        '200':
          description: OK
        '204':
          description: No Content
      operationId: deleteFieldExpressionsByParentIdConstraintRuleActionExpressionsById
      x-operation-id-source: derived
    get:
      tags:
      - Field Expressions
      summary: Retrieve a ConstraintRuleActionExpressions
      description: 'Retrieves a ConstraintRuleActionExpressions in a ConstraintRuleAction, with their details. Use query parameters to further narrow the results.


        When executed, this API returns a ConstraintRuleActionExpressions in a ConstraintRuleAction.'
      parameters:
      - name: parentId
        in: path
        description: The ID of the parent entity
        required: true
        schema:
          type: string
      - name: id
        in: path
        description: The ID of the ConstraintRuleActionExpressions
        required: true
        schema:
          type: string
      responses:
        '200':
          description: OK
        '204':
          description: No Content
      operationId: getFieldExpressionsByParentIdConstraintRuleActionExpressionsById
      x-operation-id-source: derived
    patch:
      tags:
      - Field Expressions
      summary: Update a ConstraintRuleActionExpressions
      description: 'Updates specific fields on specified ConstraintRuleActionExpressions. It can update any field except the ConstraintRuleActionExpressions ID.


        When executed, this API returns the updated ConstraintRuleActionExpressions.'
      parameters:
      - name: parentId
        in: path
        description: The ID of the parent entity
        required: true
        schema:
          type: string
      - name: id
        in: path
        description: The ID of the ConstraintRuleActionExpressions
        required: true
        schema:
          type: string
      requestBody:
        description: The updated ConstraintRuleActionExpressions
        content:
          application/json:
            schema:
              type: object
              additionalProperties: {}
          text/json:
            schema:
              type: object
              additionalProperties: {}
          application/*+json:
            schema:
              type: object
              additionalProperties: {}
      responses:
        '200':
          description: OK
        '204':
          description: No Content
      operationId: patchFieldExpressionsByParentIdConstraintRuleActionExpressionsById
      x-operation-id-source: derived
components:
  schemas:
    LookupObject:
      type: object
      properties:
        Id:
          type:
          - string
          - 'null'
        Name:
          type:
          - string
          - 'null'
      additionalProperties: false
    FieldExpression:
      type: object
      properties:
        Id:
          type:
          - string
          - 'null'
        Name:
          type:
          - string
          - 'null'
        CreatedBy:
          $ref: '#/components/schemas/LookupObject'
        CreatedDate:
          type: string
          format: date-time
        ModifiedBy:
          $ref: '#/components/schemas/LookupObject'
        ModifiedDate:
          type: string
          format: date-time
        ExternalId:
          type:
          - string
          - 'null'
        ETag:
          type:
          - string
          - 'null'
        IsActive:
          type:
          - boolean
          - 'null'
        ConditionScope:
          type:
          - string
          - 'null'
        ConditionExpression:
          type:
          - string
          - 'null'
        EvaluationContext:
          type:
          - string
          - 'null'
        ExpressionType:
          type:
          - string
          - 'null'
        Expression:
          type:
          - string
          - 'null'
        GroupByField:
          type:
          - string
          - 'null'
        IsModifiable:
          type:
          - boolean
          - 'null'
        Operation:
          type:
          - string
          - 'null'
        ParentField:
          type:
          - string
          - 'null'
        ProductGroup:
          $ref: '#/components/schemas/LookupObject'
        Product:
          $ref: '#/components/schemas/LookupObject'
        SourceObject:
          type:
          - string
          - 'null'
        UpdateField:
          type:
          - string
          - 'null'
        UpdateObject:
          type:
          - string
          - 'null'
      additionalProperties: {}
      example:
        Name: FieldExpressionName
        IsActive: true
        ConditionExpression: null
        ConditionScope: null
        EvaluationContext: Evaluation Context
        ExpressionType: Expression Type
        Expression: Expression
        GroupByField: null
        IsModifiable: false
        Operation: null
        ParentField: null
        ProductGroup: null
        Product: null
        SourceObject: Source Object
        UpdateField: Update Field
        UpdateObject: Update Object
    ConstraintRuleActionExpression:
      type: object
      properties:
        Id:
          type:
          - string
          - 'null'
        Name:
          type:
          - string
          - 'null'
        CreatedBy:
          $ref: '#/components/schemas/LookupObject'
        CreatedDate:
          type: string
          format: date-time
        ModifiedBy:
          $ref: '#/components/schemas/LookupObject'
        ModifiedDate:
          type: string
          format: date-time
        ExternalId:
          type:
          - string
          - 'null'
        ETag:
          type:
          - string
          - 'null'
        ConstraintRuleAction:
          $ref: '#/components/schemas/LookupObject'
        FieldExpression:
          $ref: '#/components/schemas/LookupObject'
        UniqueKey:
          type:
          - string
          - 'null'
      additionalProperties: {}
  securitySchemes:
    Bearer:
      type: apiKey
      description: Please insert JWT with Bearer into field
      name: Authorization
      in: header