Conga

Conga Visibility Rules API

The Visibility Rules API from Conga — 2 operation(s) for visibility rules.

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 /visibility-rule Delete several visibility rules at once · Delete visibility rules #
Ask an LLM
“Can I remove a whole batch of visibility rules in one go?”
“Is there a bulk delete for product visibility rules?”
Tell an agent destructive · confirm first
Bulk-delete the visibility rules in this list.
Remove all of these catalog visibility rules together.
GET /visibility-rule List catalog visibility rules · Retrieve visibility rules #
Ask an LLM
“Which visibility rules control what products show in my Conga catalog?”
“Can I narrow the list of visibility rules down by rule name?”
Tell an agent
List all visibility rules matching {filter}.
Show {limit} visibility rules per page, page {page}, sorted by {sort}.
PATCH /visibility-rule Update several visibility rules at once · Update visibility rules #
Ask an LLM
“Can I deactivate many visibility rules with a single update?”
“Which call edits multiple product visibility rules together?”
Tell an agent
Apply these changes to multiple visibility rules in bulk.
Bulk-update the listed catalog visibility rules.
POST /visibility-rule Create visibility rules · Create visibility rules #
Ask an LLM
“How do I set up a new rule that hides certain products from the catalog?”
“Can I create several product visibility rules in one request?”
Tell an agent
Create these new visibility rules to control which products appear in the catalog.
Add a batch of catalog visibility rules from this payload.
DELETE /visibility-rule/{Id} Delete one visibility rule · Delete a visibility rule #
Ask an LLM
“How do I delete a single visibility rule by its ID?”
“If I delete one visibility rule, do the other rules stay in place?”
Tell an agent destructive · confirm first
Delete visibility rule {Id}.
Remove the single catalog visibility rule {Id}.
GET /visibility-rule/{Id} Get one visibility rule · Retrieve a visibility rule #
Ask an LLM
“What does one particular visibility rule contain?”
“Can I fetch a single visibility rule along with its related records?”
Tell an agent
Show visibility rule {Id}.
Get visibility rule {Id} including {includes}.
PATCH /visibility-rule/{Id} Update one visibility rule · Update a visibility rule #
Ask an LLM
“Can I edit just one visibility rule without touching the rest?”
“Is it possible to switch off a single product visibility rule?”
Tell an agent
Update visibility rule {Id} with these changes.
Edit the one visibility rule {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-visibility-rules-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-visibility-rules-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-visibility-rules-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: Administration Visibility Rules API
  version: 1.0.0
servers:
- url: https://rls.congacloud.com/api/revenue-admin/v1
security:
- Bearer: []
tags:
- name: Visibility Rules
paths:
  /visibility-rule:
    delete:
      tags:
      - Visibility Rules
      summary: Delete visibility rules
      description: Deletes one or more visibility rules.
      requestBody:
        description: The list of visibility rules to delete
        content:
          application/json:
            schema:
              type: array
              items:
                $ref: '#/components/schemas/VisibilityRule'
            example:
            - Id: Id of the record to delete
          text/json:
            schema:
              type: array
              items:
                $ref: '#/components/schemas/VisibilityRule'
          application/*+json:
            schema:
              type: array
              items:
                $ref: '#/components/schemas/VisibilityRule'
      responses:
        '200':
          description: OK
      operationId: deleteVisibilityRule
      x-operation-id-source: derived
    get:
      tags:
      - Visibility Rules
      summary: Retrieve visibility rules
      description: 'Retrieves the list of all visibility rules in system. Use record name to narrow down the search. The API returns the following fields:


        Name


        IsActive


        Business Object


        Description'
      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: getVisibilityRule
      x-operation-id-source: derived
    patch:
      tags:
      - Visibility Rules
      summary: Update visibility rules
      description: Updates one or more visibility rules, which control which products are displayed in the catalog. Visibility rules are updated based on the requested details.
      requestBody:
        description: The list of visibility rules with updated data
        content:
          application/json:
            schema:
              type: array
              items:
                type: object
                additionalProperties: {}
            example:
            - Name: Name of the VisibilityRule
              BusinessObject: Attribute
              Description: Description
              InclusionCriteria: Criteria in string
              PriceList:
                Id: PL-Id
                Name: PL-Name
              IsActive: true
              Sequence: 1
              Users:
              - user1
              - user2
              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: patchVisibilityRule
      x-operation-id-source: derived
    post:
      tags:
      - Visibility Rules
      summary: Create visibility rules
      description: Creates one or more visibility rules, based on details in the request body, to control which products are displayed in the catalog.
      requestBody:
        description: The list of visibility rules to create
        content:
          application/json:
            schema:
              type: array
              items:
                $ref: '#/components/schemas/VisibilityRule'
          text/json:
            schema:
              type: array
              items:
                $ref: '#/components/schemas/VisibilityRule'
          application/*+json:
            schema:
              type: array
              items:
                $ref: '#/components/schemas/VisibilityRule'
      responses:
        '200':
          description: OK
      operationId: postVisibilityRule
      x-operation-id-source: derived
  /visibility-rule/{Id}:
    delete:
      tags:
      - Visibility Rules
      summary: Delete a visibility rule
      description: Deletes a single visibility rule by its identifier.
      parameters:
      - name: Id
        in: path
        description: The identifier of the visibility rule to delete
        required: true
        schema:
          type: string
      responses:
        '200':
          description: OK
      operationId: deleteVisibilityRuleById
      x-operation-id-source: derived
    get:
      tags:
      - Visibility Rules
      summary: Retrieve a visibility rule
      description: Retrieves a single visibility rule by its identifier.
      parameters:
      - name: Id
        in: path
        description: The identifier of the visibility rule
        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
        '204':
          description: No Content
      operationId: getVisibilityRuleById
      x-operation-id-source: derived
    patch:
      tags:
      - Visibility Rules
      summary: Update a visibility rule
      description: Updates a single visibility rule.
      parameters:
      - name: Id
        in: path
        description: The identifier of the visibility rule to update
        required: true
        schema:
          type: string
      requestBody:
        description: The updated data of the visibility rule
        content:
          application/json:
            schema:
              type: object
              additionalProperties: {}
            example:
              Name: Name of the VisibilityRule
              BusinessObject: Attribute
              Description: Description
              InclusionCriteria: Criteria in string
              PriceList:
                Id: PL-Id
                Name: PL-Name
              IsActive: true
              Sequence: 1
              Users:
              - user1
              - user2
          text/json:
            schema:
              type: object
              additionalProperties: {}
          application/*+json:
            schema:
              type: object
              additionalProperties: {}
      responses:
        '200':
          description: OK
      operationId: patchVisibilityRuleById
      x-operation-id-source: derived
components:
  schemas:
    LookupObject:
      type: object
      properties:
        Id:
          type:
          - string
          - 'null'
        Name:
          type:
          - string
          - 'null'
      additionalProperties: false
    VisibilityRule:
      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'
        BusinessObject:
          type:
          - string
          - 'null'
        Sequence:
          type:
          - number
          - 'null'
          format: double
        Description:
          type:
          - string
          - 'null'
        IsActive:
          type:
          - boolean
          - 'null'
        Criteria:
          type:
          - string
          - 'null'
        PriceList:
          $ref: '#/components/schemas/LookupObject'
        InclusionCriteria:
          type:
          - string
          - 'null'
        Users:
          type:
          - array
          - 'null'
          items:
            type: string
        Roles:
          type:
          - array
          - 'null'
          items:
            type: string
      additionalProperties: {}
      example:
        Name: Name of the VisibilityRule
        BusinessObject: Attribute
        Description: Description
        InclusionCriteria: Criteria in string
        PriceList:
          Id: PL-Id
          Name: PL-Name
        IsActive: true
        Sequence: 1
        Users:
        - user1
        - user2
  securitySchemes:
    Bearer:
      type: apiKey
      description: Please insert JWT with Bearer into field
      name: Authorization
      in: header