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

# List Workflow runs

> Lists individual Workflow runs started in the range, newest first.

**Each run includes**
- The Workflow and the person who started it
- Its status, such as `success`, `failed`, or `running`
- Whether it was a test run
- The credits it used

Filter by Workflow or person, or leave out test runs. Page through results with `cursor`.

`credits` is null while a run is in progress.

Requires the Workflow runs permission (`workflow_runs:read`).



## OpenAPI

````yaml /admin-api-openapi.json get /workflow-runs
openapi: 3.1.1
info:
  title: Cassidy Admin API
  description: Read your organization's usage analytics and activity in Cassidy.
  version: 1.0.0
servers:
  - url: https://app.cassidyai.com/api/admin/v1
security: []
tags:
  - name: Analytics
  - name: Workflow runs
  - name: Chats
  - name: Meetings
  - name: Audit logs
externalDocs:
  url: https://docs.cassidyai.com/reference/admin-api
paths:
  /workflow-runs:
    get:
      tags:
        - Workflow runs
      summary: List Workflow runs
      description: >-
        Lists individual Workflow runs started in the range, newest first.


        **Each run includes**

        - The Workflow and the person who started it

        - Its status, such as `success`, `failed`, or `running`

        - Whether it was a test run

        - The credits it used


        Filter by Workflow or person, or leave out test runs. Page through
        results with `cursor`.


        `credits` is null while a run is in progress.


        Requires the Workflow runs permission (`workflow_runs:read`).
      operationId: listWorkflowRuns
      parameters:
        - in: query
          name: from
          schema:
            type: string
            format: date-time
            description: >-
              Inclusive start of the range, by creation time, as an ISO 8601
              timestamp.
          required: true
          description: >-
            Inclusive start of the range, by creation time, as an ISO 8601
            timestamp.
        - in: query
          name: to
          schema:
            type: string
            format: date-time
            description: >-
              Exclusive end of the range as an ISO 8601 timestamp. The range can
              span at most 31 days.
          required: true
          description: >-
            Exclusive end of the range as an ISO 8601 timestamp. The range can
            span at most 31 days.
        - in: query
          name: limit
          schema:
            description: Maximum number of records to return.
            default: 100
            type: integer
            minimum: 1
            maximum: 1000
          description: Maximum number of records to return.
        - in: query
          name: cursor
          schema:
            description: The `nextCursor` from the previous page.
            type: string
          description: The `nextCursor` from the previous page.
        - in: query
          name: workflowId
          schema:
            description: Only list runs of this Workflow.
            type: string
          description: Only list runs of this Workflow.
        - in: query
          name: userId
          schema:
            description: Only list runs started by this user.
            type: string
          description: Only list runs started by this user.
        - in: query
          name: excludeTestRuns
          schema:
            description: Exclude test runs from the Workflow builder.
            default: 'false'
            type: string
            enum:
              - 'true'
              - 'false'
          description: Exclude test runs from the Workflow builder.
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                type: object
                properties:
                  nextCursor:
                    description: >-
                      Pass as `cursor` to get the next page. Null on the last
                      page.
                    type:
                      - string
                      - 'null'
                  workflowRuns:
                    type: array
                    items:
                      type: object
                      properties:
                        id:
                          type: string
                        workflow:
                          type: object
                          properties:
                            id:
                              type: string
                            name:
                              type: string
                          required:
                            - id
                            - name
                        user:
                          anyOf:
                            - type: object
                              properties:
                                id:
                                  type: string
                                name:
                                  type: string
                                email:
                                  type:
                                    - string
                                    - 'null'
                              required:
                                - id
                                - name
                                - email
                            - type: 'null'
                          description: >-
                            The user who started the run. Null for runs started
                            by a trigger or the API without a user.
                        status:
                          type: string
                          enum:
                            - pending
                            - running
                            - success
                            - failed
                            - triggerConditionsNotMet
                            - deferred
                            - cancelling
                            - cancelled
                            - notRun
                        isTestRun:
                          type: boolean
                        createdAt:
                          type: string
                        credits:
                          description: >-
                            Billable credits used by the run. Null while the run
                            is in progress.
                          type:
                            - number
                            - 'null'
                      required:
                        - id
                        - workflow
                        - user
                        - status
                        - isTestRun
                        - createdAt
                        - credits
                required:
                  - nextCursor
                  - workflowRuns
        '400':
          description: Invalid input data
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/error.BAD_REQUEST'
        '401':
          description: Authorization not provided
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/error.UNAUTHORIZED'
        '403':
          description: Insufficient access
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/error.FORBIDDEN'
        '404':
          description: Not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/error.NOT_FOUND'
        '500':
          description: Internal server error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/error.INTERNAL_SERVER_ERROR'
      security:
        - bearerAuth:
            - workflow_runs:read
components:
  schemas:
    error.BAD_REQUEST:
      type: object
      properties:
        message:
          type: string
          description: The error message
          example: Invalid input data
        code:
          type: string
          description: The error code
          example: BAD_REQUEST
        issues:
          description: An array of issues that were responsible for the error
          example: []
          type: array
          items:
            type: object
            properties:
              message:
                type: string
            required:
              - message
      required:
        - message
        - code
      title: Invalid input data error (400)
      description: The error information
      example:
        code: BAD_REQUEST
        message: Invalid input data
        issues: []
    error.UNAUTHORIZED:
      type: object
      properties:
        message:
          type: string
          description: The error message
          example: Authorization not provided
        code:
          type: string
          description: The error code
          example: UNAUTHORIZED
        issues:
          description: An array of issues that were responsible for the error
          example: []
          type: array
          items:
            type: object
            properties:
              message:
                type: string
            required:
              - message
      required:
        - message
        - code
      title: Authorization not provided error (401)
      description: The error information
      example:
        code: UNAUTHORIZED
        message: Authorization not provided
        issues: []
    error.FORBIDDEN:
      type: object
      properties:
        message:
          type: string
          description: The error message
          example: Insufficient access
        code:
          type: string
          description: The error code
          example: FORBIDDEN
        issues:
          description: An array of issues that were responsible for the error
          example: []
          type: array
          items:
            type: object
            properties:
              message:
                type: string
            required:
              - message
      required:
        - message
        - code
      title: Insufficient access error (403)
      description: The error information
      example:
        code: FORBIDDEN
        message: Insufficient access
        issues: []
    error.NOT_FOUND:
      type: object
      properties:
        message:
          type: string
          description: The error message
          example: Not found
        code:
          type: string
          description: The error code
          example: NOT_FOUND
        issues:
          description: An array of issues that were responsible for the error
          example: []
          type: array
          items:
            type: object
            properties:
              message:
                type: string
            required:
              - message
      required:
        - message
        - code
      title: Not found error (404)
      description: The error information
      example:
        code: NOT_FOUND
        message: Not found
        issues: []
    error.INTERNAL_SERVER_ERROR:
      type: object
      properties:
        message:
          type: string
          description: The error message
          example: Internal server error
        code:
          type: string
          description: The error code
          example: INTERNAL_SERVER_ERROR
        issues:
          description: An array of issues that were responsible for the error
          example: []
          type: array
          items:
            type: object
            properties:
              message:
                type: string
            required:
              - message
      required:
        - message
        - code
      title: Internal server error error (500)
      description: The error information
      example:
        code: INTERNAL_SERVER_ERROR
        message: Internal server error
        issues: []
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: An Admin API key, starting with `cas_admin_`.

````

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