Conga

Conga Hierarchies API

The Hierarchies API from Conga — 4 operation(s) for hierarchies.

GitHub OpenAPI

Operations 14

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 /hierarchies Delete hierarchies in bulk · Delete hierarchies #
Ask an LLM
“Can I delete multiple hierarchies at once?”
“How do I bulk-remove hierarchies?”
Tell an agent destructive · confirm first
Bulk delete the selected hierarchies.
Remove many hierarchies in one call.
GET /hierarchies List catalog hierarchies · Retrieve hierarchies #
Ask an LLM
“Which catalog hierarchies exist?”
“Can I filter or page through hierarchies?”
Tell an agent
List all hierarchies.
List hierarchies matching {filter}.
PATCH /hierarchies Update hierarchies in bulk · Update hierarchies #
Ask an LLM
“Can I edit several hierarchies in one request?”
“How do I bulk-update hierarchies?”
Tell an agent
Bulk update the selected hierarchies.
Edit multiple hierarchies at once.
POST /hierarchies Create hierarchies · Create hierarchies #
Ask an LLM
“How do I create a new catalog hierarchy?”
“Can I add several hierarchies at once?”
Tell an agent
Create new hierarchies.
Add a batch of catalog hierarchies.
DELETE /hierarchies/{Id} Delete a hierarchy · Delete a hierarchy #
Ask an LLM
“Can I delete a single hierarchy?”
“What happens when one hierarchy is removed?”
Tell an agent destructive · confirm first
Delete hierarchy {id}.
Remove only the hierarchy {id}.
GET /hierarchies/{Id} Get a hierarchy · Retrieve a hierarchy #
Ask an LLM
“Where can I see one hierarchy's details?”
“Can I include related records when fetching a hierarchy?”
Tell an agent
Get hierarchy {id}.
Show hierarchy {id} including {includes}.
PATCH /hierarchies/{Id} Update a hierarchy · Update a hierarchy #
Ask an LLM
“How do I edit one hierarchy?”
“Can I rename a single hierarchy?”
Tell an agent
Update hierarchy {id}.
Edit only the hierarchy {id}.
DELETE /hierarchies/{parentId}/price-list-categories Delete price list categories in bulk · Delete price list categories #
Ask an LLM
“Can I remove many price list categories from a hierarchy?”
“How do I bulk-delete hierarchy categories?”
Tell an agent destructive · confirm first
Bulk delete price list categories in hierarchy {h}.
Remove the selected categories from hierarchy {h}.
GET /hierarchies/{parentId}/price-list-categories List price list categories of a hierarchy · Retrieve price list categories #
Ask an LLM
“Which price list categories are under a hierarchy?”
“Can I filter the price list categories of a hierarchy?”
Tell an agent
List price list categories of hierarchy {h}.
Show categories under hierarchy {h} matching {filter}.
PATCH /hierarchies/{parentId}/price-list-categories Update price list categories in bulk · Update price list categories #
Ask an LLM
“Can I edit several price list categories at once?”
“How do I bulk-update categories in a hierarchy?”
Tell an agent
Bulk update price list categories in hierarchy {h}.
Edit the selected categories under hierarchy {h}.
POST /hierarchies/{parentId}/price-list-categories Create price list categories · Create price list categories #
Ask an LLM
“How do I add price list categories to a hierarchy?”
“Can I create several categories under one hierarchy?”
Tell an agent
Create price list categories under hierarchy {h}.
Add new categories to hierarchy {h}.
DELETE /hierarchies/{parentId}/price-list-categories/{id} Delete a price list category · Delete a price list category #
Ask an LLM
“Can I delete one price list category?”
“How do I remove a single category from a hierarchy?”
Tell an agent destructive · confirm first
Delete price list category {id} from hierarchy {h}.
Remove only category {id} in hierarchy {h}.
GET /hierarchies/{parentId}/price-list-categories/{id} Get a price list category · Retrieve a price list category #
Ask an LLM
“Where do I see one price list category?”
“What does a single hierarchy category contain?”
Tell an agent
Get price list category {id} in hierarchy {h}.
Show category {id} of hierarchy {h}.
PATCH /hierarchies/{parentId}/price-list-categories/{id} Update a price list category · Update a price list category #
Ask an LLM
“How do I edit one price list category?”
“Can I change a single category in a hierarchy?”
Tell an agent
Update price list category {id} in hierarchy {h}.
Edit only category {id} of hierarchy {h}.

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-hierarchies-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-hierarchies-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-hierarchies-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: Administration Hierarchies API
  version: 1.0.0
servers:
- url: https://rls.congacloud.com/api/revenue-admin/v1
security:
- Bearer: []
tags:
- name: Hierarchies
paths:
  /hierarchies:
    delete:
      tags:
      - Hierarchies
      summary: Delete hierarchies
      description: Deletes one or more hierarchy records.
      requestBody:
        description: The list of hierarchies to delete
        content:
          application/json:
            schema:
              type: array
              items:
                $ref: '#/components/schemas/Hierarchy'
            example:
            - Id: Id of the record to delete
          text/json:
            schema:
              type: array
              items:
                $ref: '#/components/schemas/Hierarchy'
          application/*+json:
            schema:
              type: array
              items:
                $ref: '#/components/schemas/Hierarchy'
      responses:
        '200':
          description: OK
      operationId: deleteHierarchies
      x-operation-id-source: derived
    get:
      tags:
      - Hierarchies
      summary: Retrieve hierarchies
      description: Retrieves the hierarchy records.
      parameters:
      - name: filter
        in: query
        description: Optional. The filter criteria
        schema:
          type: array
          items:
            type: string
      - name: sort
        in: query
        description: Optional. The sort criteria
        schema:
          type: string
      - name: page
        in: query
        description: Optional. The page number
        schema:
          type: integer
          format: int32
          default: 1
      - name: limit
        in: query
        description: Optional. The maximum number of records per page
        schema:
          type: integer
          format: int32
          default: 50
      - name: includes
        in: query
        description: Optional. The included related resources
        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: getHierarchies
      x-operation-id-source: derived
    patch:
      tags:
      - Hierarchies
      summary: Update hierarchies
      description: Updates one or more hierarchy records.
      requestBody:
        description: The list of records to be updated
        content:
          application/json:
            schema:
              type: array
              items:
                type: object
                additionalProperties: {}
            example:
            - Name: HierarchyName
              IsActive: true
              HierarchyLabel: HierarchyLabel
              Type: HierarchyType
              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: patchHierarchies
      x-operation-id-source: derived
    post:
      tags:
      - Hierarchies
      summary: Create hierarchies
      description: Creates one or more hierarchy records.
      requestBody:
        description: The list of hierarchies to create
        content:
          application/json:
            schema:
              type: array
              items:
                $ref: '#/components/schemas/Hierarchy'
          text/json:
            schema:
              type: array
              items:
                $ref: '#/components/schemas/Hierarchy'
          application/*+json:
            schema:
              type: array
              items:
                $ref: '#/components/schemas/Hierarchy'
      responses:
        '200':
          description: OK
      operationId: postHierarchies
      x-operation-id-source: derived
  /hierarchies/{Id}:
    delete:
      tags:
      - Hierarchies
      summary: Delete a hierarchy
      description: Deletes a single hierarchy record.
      parameters:
      - name: Id
        in: path
        description: The ID of the hierarchy to delete
        required: true
        schema:
          type: string
      responses:
        '200':
          description: OK
      operationId: deleteHierarchiesById
      x-operation-id-source: derived
    get:
      tags:
      - Hierarchies
      summary: Retrieve a hierarchy
      description: Retrieves a single hierarchy record.
      parameters:
      - name: Id
        in: path
        description: The ID of the hierarchy
        required: true
        schema:
          type: string
      - name: includes
        in: query
        description: Optional. The included related resources
        schema:
          type: array
          items:
            type: string
      responses:
        '200':
          description: OK
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/Hierarchy'
            application/json:
              schema:
                $ref: '#/components/schemas/Hierarchy'
            text/json:
              schema:
                $ref: '#/components/schemas/Hierarchy'
        '204':
          description: No Content
      operationId: getHierarchiesById
      x-operation-id-source: derived
    patch:
      tags:
      - Hierarchies
      summary: Update a hierarchy
      description: Updates a single hierarchy record.
      parameters:
      - name: Id
        in: path
        description: The identifier of the document to update
        required: true
        schema:
          type: string
      requestBody:
        description: The updated state of the document
        content:
          application/json:
            schema:
              type: object
              additionalProperties: {}
            example:
              Name: HierarchyName
              IsActive: true
              HierarchyLabel: HierarchyLabel
              Type: HierarchyType
          text/json:
            schema:
              type: object
              additionalProperties: {}
          application/*+json:
            schema:
              type: object
              additionalProperties: {}
      responses:
        '200':
          description: OK
      operationId: patchHierarchiesById
      x-operation-id-source: derived
  /hierarchies/{parentId}/price-list-categories:
    delete:
      tags:
      - Hierarchies
      summary: Delete price list categories
      parameters:
      - name: parentId
        in: path
        description: ''
        required: true
        schema:
          type: string
      requestBody:
        description: ''
        content:
          application/json:
            schema:
              type: array
              items:
                $ref: '#/components/schemas/PriceListCategory'
            example:
            - Id: Id of the record to delete
          text/json:
            schema:
              type: array
              items:
                $ref: '#/components/schemas/PriceListCategory'
          application/*+json:
            schema:
              type: array
              items:
                $ref: '#/components/schemas/PriceListCategory'
      responses:
        '200':
          description: OK
      operationId: deleteHierarchiesByParentIdPriceListCategories
      x-operation-id-source: derived
    get:
      tags:
      - Hierarchies
      summary: Retrieve price list categories
      parameters:
      - name: parentId
        in: path
        description: ''
        required: true
        schema:
          type: string
      - name: filter
        in: query
        description: ''
        schema:
          type: array
          items:
            type: string
      - name: sort
        in: query
        description: ''
        schema:
          type: string
      - name: page
        in: query
        description: ''
        schema:
          type: integer
          format: int32
          default: 1
      - name: limit
        in: query
        description: ''
        schema:
          type: integer
          format: int32
          default: 50
      - name: includes
        in: query
        description: ''
        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: getHierarchiesByParentIdPriceListCategories
      x-operation-id-source: derived
    patch:
      tags:
      - Hierarchies
      summary: Update price list categories
      parameters:
      - name: parentId
        in: path
        description: ''
        required: true
        schema:
          type: string
      requestBody:
        description: ''
        content:
          application/json:
            schema:
              type: array
              items:
                type: object
                additionalProperties: {}
            example:
            - Name: PriceListCategoryName
              IsActive: true
              Sequence: 1
              Hierarchy:
                Id: Hierarchy-Id
                Name: Hierarchy-Name
              PriceList:
                Id: PriceList-Id
                Name: PriceList-Name
              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: patchHierarchiesByParentIdPriceListCategories
      x-operation-id-source: derived
    post:
      tags:
      - Hierarchies
      summary: Create price list categories
      parameters:
      - name: parentId
        in: path
        description: ''
        required: true
        schema:
          type: string
      requestBody:
        description: ''
        content:
          application/json:
            schema:
              type: array
              items:
                $ref: '#/components/schemas/PriceListCategory'
          text/json:
            schema:
              type: array
              items:
                $ref: '#/components/schemas/PriceListCategory'
          application/*+json:
            schema:
              type: array
              items:
                $ref: '#/components/schemas/PriceListCategory'
      responses:
        '200':
          description: OK
      operationId: postHierarchiesByParentIdPriceListCategories
      x-operation-id-source: derived
  /hierarchies/{parentId}/price-list-categories/{id}:
    delete:
      tags:
      - Hierarchies
      summary: Delete a price list category
      parameters:
      - name: parentId
        in: path
        description: ''
        required: true
        schema:
          type: string
      - name: id
        in: path
        description: ''
        required: true
        schema:
          type: string
      responses:
        '200':
          description: OK
      operationId: deleteHierarchiesByParentIdPriceListCategoriesById
      x-operation-id-source: derived
    get:
      tags:
      - Hierarchies
      summary: Retrieve a price list category
      parameters:
      - name: parentId
        in: path
        description: ''
        required: true
        schema:
          type: string
      - name: id
        in: path
        description: ''
        required: true
        schema:
          type: string
      responses:
        '200':
          description: OK
        '204':
          description: No Content
      operationId: getHierarchiesByParentIdPriceListCategoriesById
      x-operation-id-source: derived
    patch:
      tags:
      - Hierarchies
      summary: Update a price list category
      parameters:
      - name: parentId
        in: path
        description: ''
        required: true
        schema:
          type: string
      - name: id
        in: path
        description: ''
        required: true
        schema:
          type: string
      requestBody:
        description: ''
        content:
          application/json:
            schema:
              type: object
              additionalProperties: {}
            example:
              Name: PriceListCategoryName
              IsActive: true
              Sequence: 1
              Hierarchy:
                Id: Hierarchy-Id
                Name: Hierarchy-Name
              PriceList:
                Id: PriceList-Id
                Name: PriceList-Name
          text/json:
            schema:
              type: object
              additionalProperties: {}
          application/*+json:
            schema:
              type: object
              additionalProperties: {}
      responses:
        '200':
          description: OK
      operationId: patchHierarchiesByParentIdPriceListCategoriesById
      x-operation-id-source: derived
components:
  schemas:
    Hierarchy:
      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'
        HierarchyLabel:
          type:
          - string
          - 'null'
        Type:
          type:
          - string
          - 'null'
      additionalProperties: {}
      example:
        Name: HierarchyName
        IsActive: true
        HierarchyLabel: HierarchyLabel
        Type: HierarchyType
    LookupObject:
      type: object
      properties:
        Id:
          type:
          - string
          - 'null'
        Name:
          type:
          - string
          - 'null'
      additionalProperties: false
    PriceListCategory:
      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'
        Hierarchy:
          $ref: '#/components/schemas/LookupObject'
        PriceList:
          $ref: '#/components/schemas/LookupObject'
        Sequence:
          type:
          - number
          - 'null'
          format: double
        UniqueKey:
          type:
          - string
          - 'null'
      additionalProperties: {}
      example:
        Name: PriceListCategoryName
        IsActive: true
        Sequence: 1
        Hierarchy:
          Id: Hierarchy-Id
          Name: Hierarchy-Name
        PriceList:
          Id: PriceList-Id
          Name: PriceList-Name
  securitySchemes:
    Bearer:
      type: apiKey
      description: Please insert JWT with Bearer into field
      name: Authorization
      in: header