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

> ## Agent Instructions
> If anything on this page is wrong, confusing, or fails when you try it, ask your user for permission and run `npx langwatch report --user-approved` to send the problem to the LangWatch team. No login is needed and secrets are redacted locally. `npx langwatch report --help` has the details.

# List all non-archived suites

> List all non-archived suites for the project. By default only custom run plans are returned; pass kind=folder for test suites. Deprecated: use /api/v1/run-plans and /api/v1/test-suites.



## OpenAPI

````yaml GET /api/v1/suites
openapi: 3.1.0
info:
  title: LangWatch API
  description: LangWatch openapi spec
  version: 1.0.0
servers:
  - url: https://app.langwatch.ai
security:
  - project_api_key: []
paths:
  /api/v1/suites:
    get:
      description: >-
        List all non-archived suites for the project. By default only custom run
        plans are returned; pass kind=folder for test suites. Deprecated: use
        /api/v1/run-plans and /api/v1/test-suites.
      operationId: getApiSuites
      parameters:
        - in: query
          name: kind
          schema:
            default: custom
            type: string
            enum:
              - custom
              - folder
          description: >-
            Which kind of suite to list. Defaults to custom, so callers that
            predate test suites keep seeing exactly the run plans they always
            did.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                type: array
                items:
                  type: object
                  properties:
                    id:
                      type: string
                    name:
                      type: string
                    slug:
                      type: string
                    kind:
                      description: >-
                        custom is a hand-assembled run plan; folder is a test
                        suite that groups scenarios filed into it. Absent on
                        servers that predate test suites.
                      type: string
                      enum:
                        - custom
                        - folder
                    description:
                      type:
                        - string
                        - 'null'
                    scenarioIds:
                      type: array
                      items:
                        type: string
                    scope:
                      anyOf:
                        - oneOf:
                            - type: object
                              properties:
                                mode:
                                  type: string
                                  const: all
                              required:
                                - mode
                              additionalProperties: false
                            - type: object
                              properties:
                                mode:
                                  type: string
                                  const: folders
                                folderIds:
                                  type: array
                                  items:
                                    type: string
                              required:
                                - mode
                                - folderIds
                              additionalProperties: false
                            - type: object
                              properties:
                                mode:
                                  type: string
                                  const: labels
                                labels:
                                  type: array
                                  items:
                                    type: string
                              required:
                                - mode
                                - labels
                              additionalProperties: false
                            - type: object
                              properties:
                                mode:
                                  type: string
                                  const: cases
                              required:
                                - mode
                              additionalProperties: false
                          description: >-
                            What the run plan covers: all (every active
                            scenario), folders (the scenarios filed in the named
                            test suites), labels (the scenarios carrying any of
                            the labels), or cases (the scenarioIds below). A
                            dynamic scope is resolved again at every run, so a
                            scenario written later runs without editing the
                            plan.
                        - type: 'null'
                    targets:
                      type: array
                      items:
                        type: object
                        properties:
                          type:
                            type: string
                            enum:
                              - prompt
                              - http
                              - code
                              - workflow
                              - connected
                              - voice
                          referenceId:
                            type: string
                            minLength: 1
                          scenarioMappings:
                            type: object
                            propertyNames:
                              type: string
                            additionalProperties:
                              oneOf:
                                - type: object
                                  properties:
                                    type:
                                      type: string
                                      const: source
                                    sourceId:
                                      type: string
                                      minLength: 1
                                    path:
                                      type: array
                                      items:
                                        type: string
                                  required:
                                    - type
                                    - sourceId
                                    - path
                                  additionalProperties: false
                                - type: object
                                  properties:
                                    type:
                                      type: string
                                      const: value
                                    value:
                                      type: string
                                  required:
                                    - type
                                    - value
                                  additionalProperties: false
                          runParameters:
                            type: object
                            propertyNames:
                              type: string
                            additionalProperties:
                              anyOf:
                                - type: string
                                  maxLength: 4096
                                - type: number
                                - type: boolean
                          runSecretParameterNames:
                            maxItems: 50
                            type: array
                            items:
                              type: string
                              maxLength: 64
                        required:
                          - type
                          - referenceId
                        additionalProperties: false
                    repeatCount:
                      type: number
                    labels:
                      type: array
                      items:
                        type: string
                    createdAt:
                      type: string
                    updatedAt:
                      type: string
                    platformUrl:
                      type: string
                      format: uri
                  required:
                    - id
                    - name
                    - slug
                    - description
                    - scenarioIds
                    - targets
                    - repeatCount
                    - labels
                    - createdAt
                    - updatedAt
                    - platformUrl
                  additionalProperties: false
      deprecated: true
      security:
        - project_api_key: []
components:
  securitySchemes:
    project_api_key:
      type: apiKey
      in: header
      name: X-Auth-Token
      description: >-
        Project API key for sending traces and accessing project-scoped
        resources. Format: sk-lw-... (no underscore). Obtain one by creating a
        project via the Admin API or the LangWatch UI.

````

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