Dealops api API

openapi: 3.1.0
info:
  title: Dealops api API
  version: '2026-10-22'
  description: 'GENERATED FROM DOCUMENTATION by API Evangelist on 2026-10-22: 10 operation(s) read from 2 public documentation page(s) (each operation
    names its page in x-source). This is not the provider''s published contract; Dealops has published no machine-readable contract that the pipeline
    could find. Engine: local.'
  x-evidence-tiers:
    code-example: 3
    documentation: 13
    pages-with-code: 4
    pages-read: 18
  x-generated-from: documentation
  x-provenance: generated
  x-authored-by: API Evangelist
  x-generated: '2026-10-22'
  x-generator: generate-contract-from-docs.py
  x-engine: local
  x-sources:
  - https://docs.dealops.com/docs/api/api-overview
  - https://docs.dealops.com/docs/api/pagination
  x-docs-section: api
servers:
- url: https://api.dealops.com
paths:
  /approval-groups:
    get:
      operationId: get_approval_groups
      tags:
      - Approval Groups
      summary: Pagination
      x-source: https://docs.dealops.com/docs/api/pagination
      parameters:
      - name: limit
        in: query
        required: false
        schema:
          type: string
        description: Page size. Each endpoint's default and ceiling are listed below.
      - name: cursor
        in: query
        required: false
        schema:
          type: string
        description: The previous response's nextCursor. Omit for the first page.
      responses:
        '200':
          description: Success (status as documented)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetApprovalGroupsResponse'
      x-evidence:
        kind: documentation
  /approval-rule-groups:
    get:
      operationId: get_approval_rule_groups
      tags:
      - Approval Rule Groups
      summary: Pagination
      x-source: https://docs.dealops.com/docs/api/pagination
      parameters:
      - name: limit
        in: query
        required: false
        schema:
          type: string
        description: Page size. Each endpoint's default and ceiling are listed below.
      - name: cursor
        in: query
        required: false
        schema:
          type: string
        description: The previous response's nextCursor. Omit for the first page.
      responses:
        '200':
          description: Success (status as documented)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetApprovalRuleGroupsResponse'
      x-evidence:
        kind: documentation
  /approval-rules:
    get:
      operationId: get_approval_rules
      tags:
      - Approval Rules
      summary: Pagination
      x-source: https://docs.dealops.com/docs/api/pagination
      parameters:
      - name: limit
        in: query
        required: false
        schema:
          type: string
        description: Page size. Each endpoint's default and ceiling are listed below.
      - name: cursor
        in: query
        required: false
        schema:
          type: string
        description: The previous response's nextCursor. Omit for the first page.
      responses:
        '200':
          description: Success (status as documented)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetApprovalRulesResponse'
      x-evidence:
        kind: documentation
  /approvals:
    get:
      operationId: get_approvals
      tags:
      - Approvals
      summary: Pagination
      x-source: https://docs.dealops.com/docs/api/pagination
      parameters:
      - name: limit
        in: query
        required: false
        schema:
          type: string
        description: Page size. Each endpoint's default and ceiling are listed below.
      - name: cursor
        in: query
        required: false
        schema:
          type: string
        description: The previous response's nextCursor. Omit for the first page.
      responses:
        '200':
          description: Success (status as documented)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetApprovalsResponse'
      x-evidence:
        kind: documentation
  /external/v1/products:
    get:
      operationId: get_external_v1_products
      tags:
      - External
      summary: GET /external/v1/products
      x-source: https://docs.dealops.com/docs/api/pagination
      parameters:
      - name: limit
        in: query
        required: false
        schema:
          type: string
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: code-example
        language: curl
        snippet: "curl \"https://api.dealops.com/external/v1/products?limit=100\" \\ -H \"x-api-key: $DEALOPS_API_KEY \" # next page curl \"https://api.dealops.com/external/v1/products?limit=100&cursor=\
          \ $NEXT_CURSOR \" \\ -H \"x-api-key: $DEALOPS_API_KEY \" \n def read_all ( path , collection , ** params ) : cursor , items = None ,\
          \ [ ] while True : page = get ( path , params = { ** params , \"cursor\" : cursor } if cursor else "
  /external/v1/whoami:
    get:
      operationId: get_external_v1_whoami
      tags:
      - External
      summary: GET /external/v1/whoami
      x-source: https://docs.dealops.com/docs/api/api-overview
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: code-example
        language: curl
        snippet: "curl https://api.dealops.com/external/v1/whoami \\ -H \"x-api-key: $DEALOPS_API_KEY \" \n /whoami is the cheapest way to confirm\
          \ a key works — it returns the organization the key belongs to and nothing else, so it's a good connectivity check to run first and\
          \ to wire into your own health checks. \n Requests and responses ​ \n Everything is JSON. Send Content-Type: application/json on requests\
          \ with a body"
  /pricing-quotes:
    get:
      operationId: get_pricing_quotes
      tags:
      - Pricing Quotes
      summary: Pagination
      x-source: https://docs.dealops.com/docs/api/pagination
      parameters:
      - name: limit
        in: query
        required: false
        schema:
          type: string
        description: Page size. Each endpoint's default and ceiling are listed below.
      - name: cursor
        in: query
        required: false
        schema:
          type: string
        description: The previous response's nextCursor. Omit for the first page.
      responses:
        '200':
          description: Success (status as documented)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetPricingQuotesResponse'
      x-evidence:
        kind: documentation
  /products:
    get:
      operationId: get_products
      tags:
      - Products
      summary: Pagination
      x-source: https://docs.dealops.com/docs/api/pagination
      parameters:
      - name: limit
        in: query
        required: false
        schema:
          type: string
        description: Page size. Each endpoint's default and ceiling are listed below.
      - name: cursor
        in: query
        required: false
        schema:
          type: string
        description: The previous response's nextCursor. Omit for the first page.
      responses:
        '200':
          description: Success (status as documented)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetProductsResponse'
      x-evidence:
        kind: documentation
  /webhook-configs:
    get:
      operationId: get_webhook_configs
      tags:
      - Webhook Configs
      summary: Pagination
      x-source: https://docs.dealops.com/docs/api/pagination
      parameters:
      - name: limit
        in: query
        required: false
        schema:
          type: string
        description: Page size. Each endpoint's default and ceiling are listed below.
      - name: cursor
        in: query
        required: false
        schema:
          type: string
        description: The previous response's nextCursor. Omit for the first page.
      responses:
        '200':
          description: Success (status as documented)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetWebhookConfigsResponse'
      x-evidence:
        kind: documentation
  /whoami:
    get:
      operationId: get_whoami
      tags:
      - Whoami
      summary: Cheapest way to confirm a key works — it returns the organization the key belongs to and nothing else
      description: Returns the organization the API key belongs to; used as a connectivity check.
      x-source: https://docs.dealops.com/docs/api/api-overview
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
security:
- apiKey: []
components:
  schemas:
    GetApprovalGroupsResponse:
      type: object
      properties:
        nextCursor:
          type: string
          description: Always present. null means you've read everything.
    GetApprovalRuleGroupsResponse:
      type: object
      properties:
        nextCursor:
          type: string
          description: Always present. null means you've read everything.
    GetApprovalRulesResponse:
      type: object
      properties:
        nextCursor:
          type: string
          description: Always present. null means you've read everything.
    GetApprovalsResponse:
      type: object
      properties:
        nextCursor:
          type: string
          description: Always present. null means you've read everything.
    GetPricingQuotesResponse:
      type: object
      properties:
        nextCursor:
          type: string
          description: Always present. null means you've read everything.
    GetProductsResponse:
      type: object
      properties:
        nextCursor:
          type: string
          description: Always present. null means you've read everything.
    GetWebhookConfigsResponse:
      type: object
      properties:
        nextCursor:
          type: string
          description: Always present. null means you've read everything.
  securitySchemes:
    apiKey:
      type: apiKey
      in: header
      name: x-api-key
tags:
- name: Approval Groups
- name: Approval Rule Groups
- name: Approval Rules
- name: Approvals
- name: External
- name: Pricing Quotes
- name: Products
- name: Webhook Configs
- name: Whoami