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

# List workflowRun resource



## OpenAPI

````yaml https://api.amply-app.com/v1/openapi.json get /v1/users/{userId}/broadcasts/{broadcastId}/workflows/{workflowId}/workflowRuns
openapi: 3.1.0
info:
  title: Amply API
  version: 1.0.0
  description: >-
    Authentication: send your API key in the `X-API-KEY` header.


    Each API key is tied to a single broadcast. A key cannot manage multiple
    broadcasts.


    API keys can be generated from the broadcast developer settings.
servers:
  - url: https://api.amply-app.com
security:
  - ApiKeyAuth: []
tags:
  - name: broadcastEvent resource
    description: API endpoints for managing broadcastEvent resources
    x-tag-schema:
      $ref: '#/components/schemas/broadcastEventResponse'
    x-tag-schema-example:
      type: app.opened
      metadata: {}
      _id: 64b7f8b6f23a4a4f3d0a9b12
      _createdAt: '2024-01-01T00:00:00.000Z'
  - name: broadcastNetworkingForm resource
    description: API endpoints for managing broadcastNetworkingForm resources
    x-tag-schema:
      $ref: '#/components/schemas/broadcastNetworkingForm'
    x-tag-schema-example:
      _id: 64b7f8b6f23a4a4f3d0a9b12
      _createdAt: '2024-01-01T00:00:00.000Z'
  - name: media resource
    description: API endpoints for managing media resources
    x-tag-schema:
      $ref: '#/components/schemas/media'
    x-tag-schema-example:
      _id: 64b7f8b6f23a4a4f3d0a9b12
      _userId: string
      mediaUrl: string
      external: true
      _createdAt: '2024-01-01T00:00:00.000Z'
  - name: broadcastContact resource
    description: API endpoints for managing broadcastContact resources
    x-tag-schema:
      $ref: '#/components/schemas/broadcastContact'
    x-tag-schema-example:
      _id: 64b7f8b6f23a4a4f3d0a9b12
      _createdAt: '2024-01-01T00:00:00.000Z'
  - name: broadcastCategory resource
    description: API endpoints for managing broadcastCategory resources
    x-tag-schema:
      $ref: '#/components/schemas/broadcastCategory'
    x-tag-schema-example:
      status: draft
      _id: 64b7f8b6f23a4a4f3d0a9b12
      _createdAt: '2024-01-01T00:00:00.000Z'
  - name: broadcastClient resource
    description: API endpoints for managing broadcastClient resources
    x-tag-schema:
      $ref: '#/components/schemas/broadcastClient'
    x-tag-schema-example:
      _id: 64b7f8b6f23a4a4f3d0a9b12
      _createdAt: '2024-01-01T00:00:00.000Z'
  - name: broadcastDiffuser resource
    description: API endpoints for managing broadcastDiffuser resources
    x-tag-schema:
      $ref: '#/components/schemas/broadcastDiffuser'
    x-tag-schema-example:
      type: webSite
      seo:
        title: string
        metaDescription: string
        indexing: true
      _id: 64b7f8b6f23a4a4f3d0a9b12
      _createdAt: '2024-01-01T00:00:00.000Z'
  - name: broadcastCampaign resource
    description: API endpoints for managing broadcastCampaign resources
    x-tag-schema:
      $ref: '#/components/schemas/broadcastCampaign'
    x-tag-schema-example:
      _id: 64b7f8b6f23a4a4f3d0a9b12
      _createdAt: '2024-01-01T00:00:00.000Z'
  - name: broadcastArticle resource
    description: API endpoints for managing broadcastArticle resources
    x-tag-schema:
      $ref: '#/components/schemas/broadcastArticle'
    x-tag-schema-example:
      status: draft
      blocks:
        - type: media
      _id: 64b7f8b6f23a4a4f3d0a9b12
      _createdAt: '2024-01-01T00:00:00.000Z'
  - name: broadcast resource
    description: API endpoints for managing broadcast resources
    x-tag-schema:
      $ref: '#/components/schemas/broadcast'
    x-tag-schema-example:
      name: x
      _id: 64b7f8b6f23a4a4f3d0a9b12
      _createdAt: '2024-01-01T00:00:00.000Z'
  - name: broadcastHost resource
    description: API endpoints for managing broadcastHost resources
    x-tag-schema:
      $ref: '#/components/schemas/broadcastHost'
    x-tag-schema-example:
      name: x
      status: draft
      _id: 64b7f8b6f23a4a4f3d0a9b12
      _createdAt: '2024-01-01T00:00:00.000Z'
  - name: broadcastInterestPoint resource
    description: API endpoints for managing broadcastInterestPoint resources
    x-tag-schema:
      $ref: '#/components/schemas/broadcastInterestPoint'
    x-tag-schema-example:
      mapId: 64b7f8b6f23a4a4f3d0a9b12
      status: draft
      _id: 64b7f8b6f23a4a4f3d0a9b12
      _createdAt: '2024-01-01T00:00:00.000Z'
  - name: broadcastMap resource
    description: API endpoints for managing broadcastMap resources
    x-tag-schema:
      $ref: '#/components/schemas/broadcastMap'
    x-tag-schema-example:
      type: image
      status: draft
      metadata: {}
  - name: broadcastMember resource
    description: API endpoints for managing broadcastMember resources
    x-tag-schema:
      $ref: '#/components/schemas/broadcastMember'
    x-tag-schema-example:
      email: user@example.com
      _id: 64b7f8b6f23a4a4f3d0a9b12
      _createdAt: '2024-01-01T00:00:00.000Z'
  - name: broadcastPage resource
    description: API endpoints for managing broadcastPage resources
    x-tag-schema:
      $ref: '#/components/schemas/broadcastPage'
    x-tag-schema-example:
      status: draft
      blocks:
        - type: media
      _id: 64b7f8b6f23a4a4f3d0a9b12
      _createdAt: '2024-01-01T00:00:00.000Z'
  - name: revision resource
    description: API endpoints for managing revision resources
    x-tag-schema:
      $ref: '#/components/schemas/revision'
    x-tag-schema-example:
      tos:
        accepted: true
      _id: 64b7f8b6f23a4a4f3d0a9b12
      _createdAt: '2024-01-01T00:00:00.000Z'
  - name: broadcastSession resource
    description: API endpoints for managing broadcastSession resources
    x-tag-schema:
      $ref: '#/components/schemas/broadcastSession'
    x-tag-schema-example:
      status: draft
      time: {}
      blocks:
        - type: media
      _id: 64b7f8b6f23a4a4f3d0a9b12
      _createdAt: '2024-01-01T00:00:00.000Z'
  - name: workflow resource
    description: API endpoints for managing workflow resources
    x-tag-schema:
      $ref: '#/components/schemas/workflow'
    x-tag-schema-example:
      entryNodeId: x
      nodes:
        - id: x
          position:
            - 0
            - 0
          type: amply
          config:
            operation:
              type: string
              value: string
            resource:
              type: string
              value: string
      name: x
      _id: 64b7f8b6f23a4a4f3d0a9b12
      _createdAt: '2024-01-01T00:00:00.000Z'
  - name: workflowRun resource
    description: API endpoints for managing workflowRun resources
    x-tag-schema:
      $ref: '#/components/schemas/workflowRun'
    x-tag-schema-example:
      status: running
      durationMs: 0
      invokedNodeCount: 0
      context: {}
      nodeResults:
        - executionId: x
          index: 0
          nodeId: x
          nodeType: amply
          routeTaken: onSuccess
          durationMs: 0
      _id: 64b7f8b6f23a4a4f3d0a9b12
      _createdAt: '2024-01-01T00:00:00.000Z'
  - name: font resource
    description: API endpoints for managing font resources
    x-tag-schema:
      $ref: '#/components/schemas/font'
    x-tag-schema-example:
      fontFamily: string
      weights:
        - weight: 0
          url: https://example.com
      _id: 64b7f8b6f23a4a4f3d0a9b12
      _createdAt: '2024-01-01T00:00:00.000Z'
paths:
  /v1/users/{userId}/broadcasts/{broadcastId}/workflows/{workflowId}/workflowRuns:
    get:
      tags:
        - workflowRun resource
      summary: List workflowRun resource
      parameters:
        - name: userId
          in: path
          required: true
          description: Resource identifier.
          schema:
            type: string
            format: objectId
          example: 64b7f8b6f23a4a4f3d0a9b12
        - name: broadcastId
          in: path
          required: true
          description: Resource identifier.
          schema:
            type: string
            format: objectId
          example: 64b7f8b6f23a4a4f3d0a9b12
        - name: workflowId
          in: path
          required: true
          description: Resource identifier.
          schema:
            type: string
            format: objectId
          example: 64b7f8b6f23a4a4f3d0a9b12
        - name: filters
          in: query
          required: false
          description: 'JSON array of filter objects. Example: [{"status":"active"}]'
          schema:
            type: string
          example: '[{"status":"active"}]'
        - name: filtersLogical
          in: query
          required: false
          description: Logical operator applied to filters.
          schema:
            type: string
            enum:
              - $and
              - $or
              - $nor
          example: $and
        - name: limit
          in: query
          required: false
          description: Maximum number of items to return.
          schema:
            type: integer
            minimum: 0
          example: 25
        - name: skip
          in: query
          required: false
          description: Number of items to skip.
          schema:
            type: integer
            minimum: 0
          example: 0
        - name: startId
          in: query
          required: false
          description: Start listing after this object id.
          schema:
            type: string
            format: objectId
          example: 64b7f8b6f23a4a4f3d0a9b12
        - name: sort
          in: query
          required: false
          description: 'Sort spec as JSON string. Example: {"_createdAt":"desc"}.'
          schema:
            type: string
          example: '{"_createdAt":"desc"}'
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/workflowRun'
                  metadata:
                    type: object
                  _type:
                    type: string
                    example: workflowRun
components:
  schemas:
    workflowRun:
      type: object
      properties:
        status:
          type: string
          enum:
            - running
            - success
            - error
          description: Final or current workflow run status.
          example: running
        startedAt:
          description: Workflow run start timestamp.
        endedAt:
          description: Workflow run end timestamp.
        durationMs:
          type: number
          minimum: 0
          description: Total workflow run duration in milliseconds.
          example: 0
        invokedNodeCount:
          type: integer
          minimum: 0
          maximum: 9007199254740991
          description: Total number of node execution events recorded for this run.
          example: 0
        targetNodeId:
          description: Optional stop target used for partial executions.
          type: string
          minLength: 1
          example: x
        context:
          type: object
          additionalProperties: {}
          description: Immutable execution context snapshot stored at run start.
        nodeResults:
          type: array
          items:
            type: object
            properties:
              executionId:
                type: string
                minLength: 1
                description: Unique identifier for this node execution.
                example: x
              index:
                type: integer
                minimum: 0
                maximum: 9007199254740991
                description: Monotonic execution index inside the workflow run.
                example: 0
              nodeId:
                type: string
                minLength: 1
                description: Workflow node identifier.
                example: x
              nodeType:
                type: string
                enum:
                  - amply
                  - http
                  - foreach
                  - auth
                  - if
                  - code
                description: Executed workflow node type.
                example: amply
              routeTaken:
                nullable: true
                description: Outgoing route selected after node execution.
                type: string
                enum:
                  - onSuccess
                  - onError
                  - onLoop
                example: onSuccess
              input:
                description: Resolved input passed to the node at execution time.
              output:
                description: Output returned by the node.
              durationMs:
                type: number
                minimum: 0
                description: Node execution duration in milliseconds.
                example: 0
              error:
                description: Serialized node execution error when the node fails.
            required:
              - executionId
              - index
              - nodeId
              - nodeType
              - routeTaken
              - durationMs
            additionalProperties: false
            description: Trace entry for one workflow node execution.
          description: Ordered execution trace for the workflow run.
        error:
          description: Serialized workflow-level error when the run fails.
          type: object
          additionalProperties: {}
        _id:
          type: string
          format: objectId
          example: 64b7f8b6f23a4a4f3d0a9b12
        _createdAt:
          type: string
          format: date-time
          example: '2024-01-01T00:00:00.000Z'
        _updatedAt:
          type: string
          format: date-time
          nullable: true
          example: '2024-01-01T00:00:00.000Z'
        _reference:
          nullable: true
          type: string
          example: string
      required:
        - status
        - startedAt
        - endedAt
        - durationMs
        - invokedNodeCount
        - context
        - nodeResults
        - _id
        - _createdAt
      additionalProperties: false
      description: Stored execution record for a workflow run.
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      in: header
      name: X-API-KEY
      description: >-
        Use the format `X-API-KEY YOUR_API_KEY`. Each key is tied to a single
        broadcast.

````

## Related topics

- [Get workflowRun resource](/api-reference/workflowrun-resource/get-workflowrun-resource.md)
- [List workflow resource](/api-reference/workflow-resource/list-workflow-resource.md)
- [Get workflow resource](/api-reference/workflow-resource/get-workflow-resource.md)
- [Update workflow resource](/api-reference/workflow-resource/update-workflow-resource.md)
- [Create workflow resource](/api-reference/workflow-resource/create-workflow-resource.md)


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