> ## Documentation Index
> Fetch the complete documentation index at: https://developers.logicgate.ai/llms.txt
> Use this file to discover all available pages before exploring further.

# Return aggregated record summary results for all workflows within an environment



## OpenAPI

````yaml GET /api/v1/records/search/summarize/workflows
openapi: 3.1.0
info:
  title: Risk Cloud API
  description: >-
    The Risk Cloud API is a collection of RESTful API endpoints that empower you
    and your team to directly integrate, automate, and build with the Risk
    Cloud. Risk Cloud API endpoint payloads are JSON based, with some endpoints
    supporting exports in CSV and XSLX formats for flexible integration.


    This API documentation showcases our Risk Cloud API v1, containing a variety
    of endpoints with continued support for enabling integrations with the Risk
    Cloud.


    Visit the [LogicGate Risk Cloud Developer
    Portal](https://www.logicgate.com/developer/) to get started with building
    your custom integration with quick start guides, usage guides, release
    notes, and more. Or download the [v1 OpenAPI
    specification](/legacy-openapi.json).


    Explore our [Risk Cloud API v2](https://docs.logicgate.com/v2/index.html)
    endpoints and documentation as well. [Risk Cloud API
    v2](https://docs.logicgate.com/v2/index.html) is our collection of API-First
    endpoints that are tailor made for our developer users, offer concise and
    highly documented details, are supported by a [Postman
    collection](https://www.postman.com/logicgate-postman/workspace/logicgate-risk-cloud-api/collection/29257227-de8d264b-6eeb-4177-bea6-2da0a8cabffc)
    and [v2 OpenAPI specification](https://github.com/LogicGateTech/openapi),
    and contain our latest API endpoint releases.
  contact:
    name: developer-relations@logicgate.com
    email: developer-relations@logicgate.com
  version: v2026.11.0
servers:
  - url: https://{subdomain}.logicgate.com
    description: Your Risk Cloud environment.
    variables:
      subdomain:
        description: Your Risk Cloud environment's subdomain (e.g. `qa`).
        default: your-instance
security:
  - ApiToken: []
  - basic: []
tags:
  - name: Authentication
    description: >-
      Getting Started: How to create an [API Access
      Token](https://www.logicgate.com/developer/risk-cloud-api-authentication/)
      to begin integrating with the Risk Cloud API
  - name: Attachment
    description: Endpoints for uploading, downloading, and retrieving record attachments.
  - name: Field
    description: Endpoints for creating, updating, and querying fields.
  - name: Principal
    description: >-
      Endpoints for the authenticated principal to view and manage their own
      details.
  - name: Record Audit
    description: Endpoints for retrieving record audit history and productivity data.
  - name: Step
    description: Endpoints for retrieving steps and the steps a user can access.
  - name: Table Report
    description: Endpoints for retrieving and managing table reports.
  - name: User Group
    description: Endpoints for managing user groups and their membership.
externalDocs:
  description: Developer Portal
  url: https://www.logicgate.com/developer/
paths:
  /api/v1/records/search/summarize/workflows:
    get:
      tags:
        - Record Search
      summary: >-
        Return aggregated record summary results for all workflows within an
        environment.
      operationId: summarizeByWorkflow
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/WorkflowSummaryResult'
        '401':
          description: Unauthorized
        '403':
          description: Forbidden
components:
  schemas:
    WorkflowSummaryResult:
      type: object
      properties:
        allowAec:
          type: boolean
        allowGroups:
          type: boolean
        id:
          type: string
        name:
          type: string
        recordPrefix:
          type: string
        xpos:
          type: integer
          format: int32
        ypos:
          type: integer
          format: int32
        workflowType:
          type: string
          enum:
            - WORKFLOW
            - JIRA_WORKFLOW
            - CONTROL_WORKFLOW
            - ANALYSIS_WORKFLOW
        application:
          $ref: '#/components/schemas/ApplicationResult'
        records:
          type: integer
          format: int64
        recordsComplete:
          type: integer
          format: int64
        recordsOverdue:
          type: integer
          format: int64
        recordsArchived:
          type: integer
          format: int64
        steps:
          type: integer
          format: int64
      required:
        - records
        - recordsArchived
        - recordsComplete
        - recordsOverdue
    ApplicationResult:
      type: object
      properties:
        id:
          type: string
        name:
          type: string
        shortCode:
          type: string
        color:
          type: string
        icon:
          type: string
        hasDashboard:
          type: boolean
        type:
          type: string
        live:
          type: boolean
        permissionsEnabled:
          type: boolean
        workflows:
          type: array
          items:
            description: Circular reference to WorkflowResult
      required:
        - color
        - hasDashboard
        - icon
        - id
        - live
        - name
        - permissionsEnabled
        - shortCode
        - type
        - workflows
  securitySchemes:
    ApiToken:
      type: http
      scheme: bearer
      bearerFormat: API Token
    basic:
      type: http
      scheme: basic

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.