Conga

Conga Lookup Field Settings API

The Lookup Field Settings API from Conga — 2 operation(s) for lookup field settings.

GitHub OpenAPI

Operations 7

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 /lookupfield-settings Delete lookup field settings in bulk · Delete lookup field settings #
Ask an LLM
“Can I delete several lookup field settings at once?”
“How do I bulk-remove lookup settings?”
Tell an agent destructive · confirm first
Bulk delete the selected lookup field settings.
Remove many lookup settings in one call.
GET /lookupfield-settings List lookup field settings · Retrieve lookup field settings #
Ask an LLM
“Which lookup field settings are configured?”
“Can I filter or page through lookup field settings?”
Tell an agent
List all lookup field settings.
List lookup field settings matching {filter}.
PATCH /lookupfield-settings Update lookup field settings in bulk · Update lookup field settings #
Ask an LLM
“Can I edit multiple lookup field settings in one request?”
“How do I bulk-update lookup settings?”
Tell an agent
Bulk update the selected lookup field settings.
Edit several lookup settings at once.
POST /lookupfield-settings Create lookup field settings · Create lookup field settings #
Ask an LLM
“How do I configure a new lookup field setting?”
“Can I create several lookup settings at once?”
Tell an agent
Create new lookup field settings.
Add a batch of lookup field settings.
DELETE /lookupfield-settings/{Id} Delete a lookup field setting · Delete a lookup field setting #
Ask an LLM
“Can I delete a single lookup field setting?”
“What happens when one lookup setting is removed?”
Tell an agent destructive · confirm first
Delete lookup field setting {id}.
Remove only the lookup setting {id}.
GET /lookupfield-settings/{Id} Get a lookup field setting · Retrieve a lookup field setting #
Ask an LLM
“Where can I see one lookup field setting?”
“Can I include related data when fetching a lookup setting?”
Tell an agent
Get lookup field setting {id}.
Show lookup setting {id} including {includes}.
PATCH /lookupfield-settings/{Id} Update a lookup field setting · Update a lookup field setting #
Ask an LLM
“How do I edit one lookup field setting?”
“Can I change a single lookup setting's filter?”
Tell an agent
Update lookup field setting {id}.
Edit only the lookup setting {id}.

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-lookup-field-settings-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-lookup-field-settings-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-lookup-field-settings-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: Administration Lookup Field Settings API
  version: 1.0.0
servers:
- url: https://rls.congacloud.com/api/revenue-admin/v1
security:
- Bearer: []
tags:
- name: Lookup Field Settings
paths:
  /lookupfield-settings:
    delete:
      tags:
      - Lookup Field Settings
      summary: Delete lookup field settings
      description: Deletes multiple lookup field settings.
      requestBody:
        description: The list of lookup field settings to delete
        content:
          application/json:
            schema:
              type: array
              items:
                $ref: '#/components/schemas/LookupFieldSetting'
            example:
            - Id: Id of the record to delete
          text/json:
            schema:
              type: array
              items:
                $ref: '#/components/schemas/LookupFieldSetting'
          application/*+json:
            schema:
              type: array
              items:
                $ref: '#/components/schemas/LookupFieldSetting'
      responses:
        '200':
          description: OK
      operationId: deleteLookupfieldSettings
      x-operation-id-source: derived
    get:
      tags:
      - Lookup Field Settings
      summary: Retrieve lookup field settings
      description: Retrieves the collection of lookup field settings.
      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: getLookupfieldSettings
      x-operation-id-source: derived
    patch:
      tags:
      - Lookup Field Settings
      summary: Update lookup field settings
      description: Updates multiple lookup field settings.
      requestBody:
        description: The list of lookup field settings with updated data
        content:
          application/json:
            schema:
              type: array
              items:
                type: object
                additionalProperties: {}
            example:
            - Name: FieldName
              ObjectName: LineItem
              LookupFieldName: Category
              DisplayFields: Display Fields
              FilterCriteria: Criteria
              LookupRecordLimit: 20
              EnableQuickView: false
              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: patchLookupfieldSettings
      x-operation-id-source: derived
    post:
      tags:
      - Lookup Field Settings
      summary: Create lookup field settings
      description: Creates multiple lookup field settings.
      requestBody:
        description: The list of lookup field settings to create
        content:
          application/json:
            schema:
              type: array
              items:
                $ref: '#/components/schemas/LookupFieldSetting'
          text/json:
            schema:
              type: array
              items:
                $ref: '#/components/schemas/LookupFieldSetting'
          application/*+json:
            schema:
              type: array
              items:
                $ref: '#/components/schemas/LookupFieldSetting'
      responses:
        '200':
          description: OK
      operationId: postLookupfieldSettings
      x-operation-id-source: derived
  /lookupfield-settings/{Id}:
    delete:
      tags:
      - Lookup Field Settings
      summary: Delete a lookup field setting
      description: Deletes a single lookup field setting by its identifier.
      parameters:
      - name: Id
        in: path
        description: The identifier of the lookup field setting to delete
        required: true
        schema:
          type: string
      responses:
        '200':
          description: OK
      operationId: deleteLookupfieldSettingsById
      x-operation-id-source: derived
    get:
      tags:
      - Lookup Field Settings
      summary: Retrieve a lookup field setting
      description: Retrieves a single lookup field setting by its identifier.
      parameters:
      - name: Id
        in: path
        description: The identifier of the lookup field setting
        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/LookupFieldSetting'
            application/json:
              schema:
                $ref: '#/components/schemas/LookupFieldSetting'
            text/json:
              schema:
                $ref: '#/components/schemas/LookupFieldSetting'
        '204':
          description: No Content
      operationId: getLookupfieldSettingsById
      x-operation-id-source: derived
    patch:
      tags:
      - Lookup Field Settings
      summary: Update a lookup field setting
      description: Updates a single lookup field setting.
      parameters:
      - name: Id
        in: path
        description: The identifier of the lookup field setting to update
        required: true
        schema:
          type: string
      requestBody:
        description: The updated data of the lookup field setting
        content:
          application/json:
            schema:
              type: object
              additionalProperties: {}
            example:
              Name: FieldName
              ObjectName: LineItem
              LookupFieldName: Category
              DisplayFields: Display Fields
              FilterCriteria: Criteria
              LookupRecordLimit: 20
              EnableQuickView: false
          text/json:
            schema:
              type: object
              additionalProperties: {}
          application/*+json:
            schema:
              type: object
              additionalProperties: {}
      responses:
        '200':
          description: OK
      operationId: patchLookupfieldSettingsById
      x-operation-id-source: derived
components:
  schemas:
    LookupObject:
      type: object
      properties:
        Id:
          type:
          - string
          - 'null'
        Name:
          type:
          - string
          - 'null'
      additionalProperties: false
    LookupFieldSetting:
      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'
        ObjectName:
          type:
          - string
          - 'null'
        LookupFieldName:
          type:
          - string
          - 'null'
        DisplayFields:
          type:
          - string
          - 'null'
        FilterCriteria:
          type:
          - string
          - 'null'
        LookupRecordLimit:
          type:
          - integer
          - 'null'
          format: int32
        EnableQuickView:
          type:
          - boolean
          - 'null'
        SortFieldName:
          type:
          - string
          - 'null'
        SortDirection:
          type:
          - string
          - 'null'
        SourceObject:
          type:
          - string
          - 'null'
        SourceField:
          type:
          - string
          - 'null'
      additionalProperties: {}
      example:
        Name: FieldName
        ObjectName: LineItem
        LookupFieldName: Category
        DisplayFields: Display Fields
        FilterCriteria: Criteria
        LookupRecordLimit: 20
        EnableQuickView: false
  securitySchemes:
    Bearer:
      type: apiKey
      description: Please insert JWT with Bearer into field
      name: Authorization
      in: header