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

# List Workflows

> Lists the business's published workflows (Transaction Monitoring and Customer Onboarding), cursor-paginated. Only published workflows are returned; `status` is not a filter here.



## OpenAPI

````yaml /api-reference/specs/cowork.json get /v2/workflows
openapi: 3.0.3
info:
  title: Youverify Cowork API
  version: 2.0.0
  description: >-
    Entity, Activity, Signal, Case and Workflow Events Management endpoints —
    the core Cowork platform object model. Assembled from
    doc.youverify.co/api-reference-sdk, endpoints kept in the exact order they
    appear in the GitBook navigation.


    Account-wide error responses (401, 429, 500 on every endpoint; 402 on paid
    verification calls; 404 on lookup-by-ID calls) are sourced verbatim from
    Youverify's own "Youverify OS Error Codes" and "Response Codes" pages
    (doc.youverify.co/youverify-os-error-codes, /get-started/response-codes) and
    attached via components.responses, since those pages document them
    account-wide rather than per endpoint. Any error example that a specific
    endpoint's own page actually showed is kept exactly as documented there
    instead of being replaced by these.
  contact:
    name: Youverify Support
    email: support@youverify.co
servers:
  - url: https://api.youverify.co
    description: Production (live, billed)
  - url: https://api.sandbox.youverify.co
    description: Sandbox (test data, not billed)
security:
  - ApiKeyAuth: []
tags:
  - name: Entity Management
    description: >-
      Create, retrieve and verify entities (individuals or businesses) — the
      core object every check attaches to.
  - name: Activity Management
    description: Inspect the verification activities run against your account.
  - name: Signal Management
    description: Retrieve monitoring signals and their events, by entity or business.
  - name: Case Management
    description: Create and manage compliance cases, including AI-generated case summaries.
  - name: Workflow Events Management
    description: >-
      Send events to your Transaction Monitoring (TM) and Customer Onboarding
      (CO) workflows, and read the workflows and evaluations (runs) for your
      business.
paths:
  /v2/workflows:
    get:
      tags:
        - Workflow Events Management
      summary: List Workflows
      description: >-
        Lists the business's published workflows (Transaction Monitoring and
        Customer Onboarding), cursor-paginated. Only published workflows are
        returned; `status` is not a filter here.
      operationId: listWorkflows
      parameters:
        - name: token
          in: header
          required: true
          schema:
            type: string
          description: API secret token
        - name: workflowType
          in: query
          required: false
          schema:
            type: string
            enum:
              - CO
              - TM
          description: >-
            Filter by workflow type: `CO` (Customer Onboarding) or `TM`
            (Transaction Monitoring).
        - name: isLive
          in: query
          required: false
          schema:
            type: boolean
          description: Filter by whether the workflow is live.
        - name: q
          in: query
          required: false
          schema:
            type: string
          description: Search text.
        - name: startDate
          in: query
          required: false
          schema:
            type: string
          description: Return workflows from this date.
        - name: endDate
          in: query
          required: false
          schema:
            type: string
          description: Return workflows up to this date.
        - name: limit
          in: query
          required: false
          schema:
            type: integer
          description: Number of records per page.
        - name: sortField
          in: query
          required: false
          schema:
            type: string
          description: Field to sort by.
        - name: sortOrder
          in: query
          required: false
          schema:
            type: string
            enum:
              - asc
              - desc
          description: Sort direction.
        - name: next
          in: query
          required: false
          schema:
            type: string
          description: Cursor for the next page.
        - name: prev
          in: query
          required: false
          schema:
            type: string
          description: Cursor for the previous page.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/WorkflowList'
              example:
                success: true
                statusCode: 200
                message: Workflows fetched successfully
                data:
                  docs:
                    - id: string
                      businessId: string
                      parentId: string
                      name: string
                      description: string
                      workflowType: CO
                      status: draft
                      lastCreatedVersion: 0
                      liveVersion: 0
                      registryVersion: 0
                      runs: 0
                      alerts: 0
                      failedRuns: 0
                      failedNodes: 0
                      triggerCount: 0
                      publishedAt: '2026-11-03T22:13:10.007Z'
                      activatedAt: '2026-11-03T22:13:10.007Z'
                      deactivatedAt: '2026-11-03T22:13:10.007Z'
                      archivedAt: '2026-11-03T22:13:10.007Z'
                      deletedAt: '2026-11-03T22:13:10.007Z'
                      createdBy: string
                      createdByUser:
                        id: 665f1c2ab7e4d21a9c8b4567
                        firstName: Ada
                        middleName: Augusta
                        lastName: Lovelace
                        email: ada@example.com
                      updatedBy: string
                      updatedByUser:
                        id: 665f1c2ab7e4d21a9c8b4567
                        firstName: Ada
                        middleName: Augusta
                        lastName: Lovelace
                        email: ada@example.com
                      createdAt: '2026-11-03T22:13:10.007Z'
                      updatedAt: '2026-11-03T22:13:10.007Z'
                  pagination:
                    type: cursor
                    perPage: 0
                    nextPage: string
                    prevPage: string
                    hasNextPage: true
                    hasPrevPage: true
                    totalDocs: 0
                    totalPages: 0
                links:
                  - {}
        '401':
          $ref: '#/components/responses/Error401Unauthorized'
        '429':
          $ref: '#/components/responses/Error429TooManyRequests'
        '500':
          $ref: '#/components/responses/Error500ServerError'
components:
  schemas:
    WorkflowList:
      type: object
      properties:
        success:
          type: boolean
          example: true
        statusCode:
          type: integer
          enum:
            - 200
          example: 200
        message:
          type: string
          enum:
            - Workflows fetched successfully
          example: Workflows fetched successfully
        data:
          type: object
          properties:
            docs:
              type: array
              items:
                type: object
                properties:
                  id:
                    type: string
                  businessId:
                    type: string
                  parentId:
                    type: string
                    nullable: true
                  name:
                    type: string
                  description:
                    type: string
                    nullable: true
                  workflowType:
                    type: string
                    nullable: true
                    enum:
                      - CO
                      - TM
                  status:
                    type: string
                    enum:
                      - draft
                      - published
                      - archived
                      - live
                  lastCreatedVersion:
                    type: integer
                    nullable: true
                  liveVersion:
                    type: integer
                    nullable: true
                  registryVersion:
                    type: integer
                    nullable: true
                  runs:
                    type: integer
                  alerts:
                    type: integer
                  failedRuns:
                    type: integer
                  failedNodes:
                    type: integer
                  triggerCount:
                    type: integer
                  publishedAt:
                    type: string
                    format: date-time
                    nullable: true
                  activatedAt:
                    type: string
                    format: date-time
                    nullable: true
                  deactivatedAt:
                    type: string
                    format: date-time
                    nullable: true
                  archivedAt:
                    type: string
                    format: date-time
                    nullable: true
                  deletedAt:
                    type: string
                    format: date-time
                    nullable: true
                  createdBy:
                    type: string
                  createdByUser:
                    type: object
                    properties:
                      id:
                        type: string
                        example: 665f1c2ab7e4d21a9c8b4567
                      firstName:
                        type: string
                        example: Ada
                      middleName:
                        type: string
                        example: Augusta
                      lastName:
                        type: string
                        example: Lovelace
                      email:
                        type: string
                        example: ada@example.com
                    required:
                      - id
                  updatedBy:
                    type: string
                    nullable: true
                  updatedByUser:
                    type: object
                    properties:
                      id:
                        type: string
                        example: 665f1c2ab7e4d21a9c8b4567
                      firstName:
                        type: string
                        example: Ada
                      middleName:
                        type: string
                        example: Augusta
                      lastName:
                        type: string
                        example: Lovelace
                      email:
                        type: string
                        example: ada@example.com
                    required:
                      - id
                  createdAt:
                    type: string
                    format: date-time
                  updatedAt:
                    type: string
                    format: date-time
                required:
                  - id
                  - businessId
                  - name
                  - status
                  - runs
                  - alerts
                  - createdBy
            pagination:
              type: object
              properties:
                type:
                  type: string
                  enum:
                    - cursor
                perPage:
                  type: integer
                nextPage:
                  type: string
                  nullable: true
                prevPage:
                  type: string
                  nullable: true
                hasNextPage:
                  type: boolean
                hasPrevPage:
                  type: boolean
                totalDocs:
                  type: integer
                totalPages:
                  type: integer
              required:
                - type
                - perPage
                - nextPage
                - prevPage
                - hasNextPage
                - hasPrevPage
                - totalDocs
                - totalPages
          required:
            - docs
            - pagination
        links:
          type: array
          items:
            type: object
      required:
        - success
        - statusCode
        - message
        - data
  responses:
    Error401Unauthorized:
      description: Unauthorized — the token header is missing or invalid.
      content:
        application/json:
          example:
            success: false
            statusCode: 401
            message: Permission denied
            name: UnauthorizedError
            data: {}
    Error429TooManyRequests:
      description: Too Many Requests — you have exceeded the rate limit; wait and retry.
      content:
        application/json:
          example:
            success: false
            statusCode: 429
            message: Too many requests
            name: RateLimitError
            data: {}
    Error500ServerError:
      description: >-
        Internal Server Error — a rare, unexpected failure on Youverify's side.
        Contact support@youverify.co if it persists.
      content:
        application/json:
          example:
            success: false
            statusCode: 500
            message: Internal Server Error
            name: Error
            data: {}
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      in: header
      name: token
      description: Your Youverify API secret key. Never expose client-side.

````

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