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

# List the starting points for a new Workflow

> The workflows you can start from in this workspace: published workflows that Widgetic offers or, for one of a
partner's managed users, that the partner offers (a managed user is never shown Widgetic's, and a person is never
shown a partner's). Only what can be started now is listed, in the order the offerer set (smallest `position`
first, then by `key`). Each shows what you would get, and none shows who made it or any id of its own.
Start from one with `createWorkspaceWorkflowFromPreset`.
For personal workspace, use 'personal' as workspaceId.
For organization workspace, use the organization UUID as workspaceId. Any active member can read the list.




## OpenAPI

````yaml /openapi/widgetic-api-public.json get /workspaces/{workspaceId}/workflows/presets
openapi: 3.0.0
info:
  title: Widgetic API Gateway
  version: 1.0.0
  description: API documentation for the Widgetic API Gateway
  license:
    name: Widgetic Integration License
    url: https://docs.widgetic.com/resources/license
servers:
  - url: https://api.widgetic.com/v1
    description: Production server
    variables:
      env:
        default: production
        description: Environment
      apiUrl:
        default: https://api.widgetic.com
        description: API URL
      apiVersion:
        default: /v1
        description: API Version path prefix
security: []
tags: []
paths:
  /workspaces/{workspaceId}/workflows/presets:
    get:
      tags:
        - Workflows
      summary: List the starting points for a new Workflow
      description: >
        The workflows you can start from in this workspace: published workflows
        that Widgetic offers or, for one of a

        partner's managed users, that the partner offers (a managed user is
        never shown Widgetic's, and a person is never

        shown a partner's). Only what can be started now is listed, in the order
        the offerer set (smallest `position`

        first, then by `key`). Each shows what you would get, and none shows who
        made it or any id of its own.

        Start from one with `createWorkspaceWorkflowFromPreset`.

        For personal workspace, use 'personal' as workspaceId.

        For organization workspace, use the organization UUID as workspaceId.
        Any active member can read the list.
      operationId: listWorkspaceWorkflowPresets
      parameters:
        - $ref: '#/components/parameters/WorkflowWorkspaceId'
        - $ref: '#/components/parameters/ManagedUserScopeId'
        - $ref: '#/components/parameters/ManagedUserScopeExternalId'
      responses:
        '200':
          description: The starting points (an empty list when none is offered)
          content:
            application/json:
              schema:
                type: object
                properties:
                  success:
                    type: boolean
                    example: true
                  data:
                    $ref: '#/components/schemas/WorkflowPresetChoices'
                  meta:
                    $ref: '#/components/schemas/ResponseMeta'
                required:
                  - success
                  - data
        '400':
          description: The workspace is neither "personal" nor an organization id
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '403':
          description: >-
            Forbidden - Not a member of this organization, the plan does not
            include workflows (`AUTHZ_PLAN_RESTRICTION`), or the call is made
            for one managed user (`X-Managed-User-Id`) in a workspace other than
            `personal` (`MANAGED_USER_SCOPE_ROUTE_NOT_AVAILABLE`)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '503':
          description: Workflows cannot be used on this server right now
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      security:
        - apiKeyAuth: []
components:
  parameters:
    WorkflowWorkspaceId:
      name: workspaceId
      in: path
      required: true
      description: >
        The workspace: 'personal' for your own workspace, or the UUID of an
        organization. A call made for one of your

        managed users (`X-Managed-User-Id`) always uses 'personal': a managed
        user has no other workspace, and a call

        that names an organization is refused with 403.
      schema:
        type: string
      example: personal
    ManagedUserScopeId:
      in: header
      name: X-Managed-User-Id
      required: false
      description: >-
        The id Widgetic gave the managed user (`POST /managed-users`). Makes
        this call for one of your managed users, so that a mistake in your own
        code cannot reach another customer's work. Send this header, or the
        other one, never both. Left out, the call works on your whole account,
        as it always has. With it, the call reaches only that user's
        compositions and workflows: a list shows only theirs, a composition or a
        workflow the call makes is filed under them, and one of another user, or
        one that does not exist, answers `404` (the same answer, so the call
        cannot be used to find out what another customer has). A managed user
        that is not yours answers `404` with `MANAGED_USER_NOT_FOUND`. An empty,
        repeated or malformed header is `400` with `MANAGED_USER_SCOPE_INVALID`;
        an empty header is never read as no header. A call that is about the
        whole account, such as the list of your managed users, is refused with
        `403` and `MANAGED_USER_SCOPE_ROUTE_NOT_AVAILABLE`: send it without the
        header. Only your API key can send it. The header is a limit the call
        asks for: whoever holds the key can leave it out, so for a credential
        that a customer's browser holds, use an editor session. An
        `Idempotency-Key` is kept apart for each managed user.
      schema:
        type: string
        format: uuid
        example: 3f2b8c1e-7a4d-4e0b-9c55-2d1a6b7e8f90
    ManagedUserScopeExternalId:
      in: header
      name: X-Managed-User-External-Id
      required: false
      description: >-
        Your own id for the managed user (its `externalId`), when you do not
        keep Widgetic's. Makes this call for one of your managed users, so that
        a mistake in your own code cannot reach another customer's work. Send
        this header, or the other one, never both. Left out, the call works on
        your whole account, as it always has. With it, the call reaches only
        that user's compositions and workflows: a list shows only theirs, a
        composition or a workflow the call makes is filed under them, and one of
        another user, or one that does not exist, answers `404` (the same
        answer, so the call cannot be used to find out what another customer
        has). A managed user that is not yours answers `404` with
        `MANAGED_USER_NOT_FOUND`. An empty, repeated or malformed header is
        `400` with `MANAGED_USER_SCOPE_INVALID`; an empty header is never read
        as no header. A call that is about the whole account, such as the list
        of your managed users, is refused with `403` and
        `MANAGED_USER_SCOPE_ROUTE_NOT_AVAILABLE`: send it without the header.
        Only your API key can send it. The header is a limit the call asks for:
        whoever holds the key can leave it out, so for a credential that a
        customer's browser holds, use an editor session. An `Idempotency-Key` is
        kept apart for each managed user.
      schema:
        type: string
        minLength: 1
        maxLength: 255
        example: customer-1042
  schemas:
    WorkflowPresetChoices:
      type: object
      required:
        - items
      properties:
        items:
          type: array
          description: >-
            The starting points, in the order the offerer set (smallest position
            first, then by key).
          items:
            $ref: '#/components/schemas/WorkflowPresetChoice'
      example:
        items:
          - Example WorkflowPresetChoice
    ResponseMeta:
      type: object
      description: >-
        Extra information about the answer: where a page sits in a list, the
        cursor of the next page, or warnings about a call that succeeded with a
        caveat.
      additionalProperties: true
      properties:
        page:
          type: integer
          description: The page that was read, counting from 1.
          example: 1
        size:
          type: integer
          description: How many items one page holds.
          example: 20
        total:
          type: integer
          description: How many items the whole list has.
          example: 135
        limit:
          type: integer
          description: The same as `size`.
          example: 20
        offset:
          type: integer
          description: How many items come before this page.
          example: 0
        hasNextPage:
          type: boolean
          example: true
        hasPreviousPage:
          type: boolean
          example: false
        nextCursor:
          type: string
          nullable: true
          description: >-
            Pass this as `cursor` to read the next page of a list that is read
            by cursor. `null` on the last page.
        warnings:
          type: array
          items:
            type: string
          description: >-
            Things the call did not do, though it succeeded (for example a table
            that could not be created just now).
    ErrorResponse:
      type: object
      required:
        - success
        - message
        - error
      additionalProperties: true
      properties:
        success:
          type: boolean
          description: Always `false` on a failure.
          example: false
        message:
          type: string
          description: The same text as `error.message`, for a caller that reads one line.
        error:
          $ref: '#/components/schemas/ErrorDetail'
    WorkflowPresetChoice:
      type: object
      description: >
        A place to start a new workflow: a published workflow that Widgetic
        offers (or, for one of a partner's customers,

        that the partner offers). Starting from it gives you your own copy of
        every widget it chains, a composition of

        your own on each copy, and a draft workflow wired like it.
      required:
        - key
        - title
        - description
        - blockCount
        - widgets
      properties:
        key:
          type: string
          description: >-
            What `createWorkspaceWorkflowFromPreset` takes to say which starting
            point.
          example: welcome-then-offer
        title:
          type: string
          description: >-
            The title the offerer gave it, or the name of the workflow it is
            made from.
        description:
          type: string
          nullable: true
        blockCount:
          type: integer
          description: How many blocks it has (compositions, triggers and conditions).
        widgets:
          type: array
          description: The widgets it shows, once each, in the order they first appear.
          items:
            $ref: '#/components/schemas/WorkflowPresetWidget'
      example:
        key: welcome-then-offer
        title: Example title
        description: Example description
        blockCount: 42
        widgets:
          - Example WorkflowPresetWidget
    ErrorDetail:
      type: object
      required:
        - code
        - message
        - timestamp
      properties:
        code:
          type: string
          description: Machine-readable error code.
          example: RESOURCE_NOT_FOUND
        message:
          type: string
          description: Human-readable explanation.
          example: Composition not found
        param:
          type: string
          description: The field that caused the error, when one did.
          example: name
        docUrl:
          type: string
          description: Where this error is explained.
        suggestedAction:
          type: string
          description: What to do about it.
        retryAfter:
          type: integer
          description: >-
            Seconds to wait before trying again (rate limits). The same number
            is in the `Retry-After` header.
          example: 60
        details:
          type: object
          additionalProperties: true
          description: >-
            More about the error: the fields that failed, a limit that was
            reached.
        correlationId:
          type: string
          description: Quote this when you ask support about the call.
          example: req_123e4567-e89b-12d3-a456-426614174000
        timestamp:
          type: string
          format: date-time
          example: '2026-10-15T10:00:00.000Z'
    WorkflowPresetWidget:
      type: object
      description: A widget a starting point shows.
      required:
        - name
        - thumbnailUrl
      properties:
        name:
          type: string
        thumbnailUrl:
          type: string
          nullable: true
      example:
        name: Example name
        thumbnailUrl: Example thumbnailUrl
  securitySchemes:
    apiKeyAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT

````

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