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

# List workflows for the caller workspace

**Required scope:** `workflows.view`

<Note>Requires workflows enabled for your workspace. Otherwise the request is refused; see [Errors](/concepts/errors).</Note>


## OpenAPI

````yaml /api-reference/openapi.json get /workflows
openapi: 3.0.3
info:
  title: Pineyard API
  version: 1.0.0
  description: >-
    Programmatic access to agents, campaigns, calls, phone numbers, WhatsApp and
    results in your Pineyard workspace.
servers:
  - url: https://api.pineyard.ai
    description: Production
security:
  - bearerAuth: []
paths:
  /workflows:
    get:
      summary: List workflows for the caller workspace
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: array
                items:
                  type: object
                  properties:
                    id:
                      type: string
                    name:
                      type: string
                    status:
                      type: string
                      enum:
                        - DRAFT
                        - ACTIVE
                        - ARCHIVED
                    definition:
                      type: object
                      additionalProperties:
                        nullable: true
                      description: >-
                        Opaque workflow definition JSON object. Graph validation
                        is performed by the workflow validator.
                      example:
                        definitionVersion: 1
                        nodes:
                          - id: start
                            type: start
                            position:
                              x: 0
                              'y': 0
                            data: {}
                          - id: end_ok
                            type: end
                            position:
                              x: 0
                              'y': 1
                            data:
                              label: Done
                        edges:
                          - id: e1
                            source: start
                            target: end_ok
                    definitionVersion:
                      type: number
                    callingTimezone:
                      type: string
                      nullable: true
                    dailyWindowStart:
                      type: string
                      nullable: true
                    dailyWindowEnd:
                      type: string
                      nullable: true
                    dialDays:
                      type: array
                      items:
                        type: integer
                    dailyOutreachCap:
                      type: integer
                      nullable: true
                    createdAt:
                      type: string
                    updatedAt:
                      type: string
                  required:
                    - id
                    - name
                    - status
                    - definition
                    - definitionVersion
                    - callingTimezone
                    - dailyWindowStart
                    - dailyWindowEnd
                    - dialDays
                    - dailyOutreachCap
                    - createdAt
                    - updatedAt
        '400':
          description: >-
            - `internal_error`: An unexpected error. A `400` with this code
            usually means the body is not valid JSON; a `413` means the body is
            larger than 1 MB.

            - `invalid_body`: The request body (or query) failed validation.
            Details are in `issues` (or `detail`). `422` on `POST
            /v1/campaigns/{campaignId}/leads`.
        '401':
          description: >-
            - `invalid_api_key`: The API key is unknown, revoked or expired, or
            its workspace was deleted.

            - `unauthorized`: No `Authorization: Bearer` header, or an empty
            token.
        '403':
          description: >-
            - `api_key_not_scoped`: A key issued without scopes was used outside
            `/v1`.

            - `api_key_owner_inactive`: The member the key acts for was removed
            or suspended.

            - `forbidden`: The key lacks the permission named in
            `requiredPermission`, or the resource belongs to another workspace.

            - `workspace_pending_approval`: The workspace has not been approved
            yet.

            - `workspace_suspended`: The workspace is suspended.
        '404':
          description: >-
            - `not_found`: The resource does not exist in your workspace, or the
            feature is not enabled for it.
        '413':
          description: >-
            - `internal_error`: An unexpected error. A `400` with this code
            usually means the body is not valid JSON; a `413` means the body is
            larger than 1 MB.
        '429':
          description: '- `rate_limited`: Too many requests.'
        '500':
          description: >-
            - `internal_error`: An unexpected error. A `400` with this code
            usually means the body is not valid JSON; a `413` means the body is
            larger than 1 MB.
        '502':
          description: >-
            - `provider_error`: The calling service rejected the request
            (`upstreamStatus` 4xx) or was unavailable (5xx).
        '503':
          description: '- `database_unavailable`: The service is temporarily unavailable.'
components:
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: Your API key, e.g. `pk_live_xxxxxxxxxxxxxxxxxxxxxxxx`.

````

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