> ## 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 workflows a partner offers as places to start

> The partner's starting points, ordered by `position` and then by `key`: the published workflows it offers its managed
users when they make a new workflow. Each says whether people can start from it now and, when they cannot, why. The
list is the same for every managed user, and a managed user is shown only what is available.

A starting point is one of the partner account's own published workflows, built from compositions the account made
for itself (not for a customer or a team) and from widgets the partner already offers as presets
(`setPartnerPreset`), and it uses at most 10 widgets. A partner offers up to 50.

The caller must be the person who administers the partner (an API key of that account works), or a Widgetic
administrator.




## OpenAPI

````yaml /openapi/widgetic-api-public.json get /partners/{partnerId}/workflow-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:
  /partners/{partnerId}/workflow-presets:
    get:
      tags:
        - Partners
      summary: List the workflows a partner offers as places to start
      description: >
        The partner's starting points, ordered by `position` and then by `key`:
        the published workflows it offers its managed

        users when they make a new workflow. Each says whether people can start
        from it now and, when they cannot, why. The

        list is the same for every managed user, and a managed user is shown
        only what is available.


        A starting point is one of the partner account's own published
        workflows, built from compositions the account made

        for itself (not for a customer or a team) and from widgets the partner
        already offers as presets

        (`setPartnerPreset`), and it uses at most 10 widgets. A partner offers
        up to 50.


        The caller must be the person who administers the partner (an API key of
        that account works), or a Widgetic

        administrator.
      operationId: listPartnerWorkflowPresets
      parameters:
        - in: path
          name: partnerId
          required: true
          schema:
            type: string
            format: uuid
          description: The partner whose starting points to list
      responses:
        '200':
          description: The partner's starting points (an empty list when it offers none)
          content:
            application/json:
              schema:
                type: object
                properties:
                  success:
                    type: boolean
                    example: true
                  data:
                    $ref: '#/components/schemas/OfferedWorkflowPresetList'
                  meta:
                    $ref: '#/components/schemas/ResponseMeta'
                required:
                  - success
                  - data
        '400':
          description: The partner id is not an id
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '401':
          description: The API key is missing or invalid
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '403':
          description: The caller does not administer this partner
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '404':
          description: There is no such partner (reported to administrators only)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '409':
          description: >-
            The partner has no administrator account
            (PARTNER_HAS_NO_ADMINISTRATOR)
          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:
  schemas:
    OfferedWorkflowPresetList:
      type: object
      required:
        - items
      properties:
        items:
          type: array
          items:
            $ref: '#/components/schemas/OfferedWorkflowPreset'
      example:
        items:
          - Example OfferedWorkflowPreset
    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'
    OfferedWorkflowPreset:
      type: object
      description: >
        A workflow you offer as a place to start, and what became of it. People
        start from it with their own copy of every

        widget it chains, a composition of their own on each copy, and a draft
        workflow wired like its live version.
      required:
        - key
        - workflowId
        - title
        - description
        - position
        - available
        - unavailableReason
        - workflowName
        - blockCount
        - widgets
        - createdAt
        - updatedAt
      properties:
        key:
          type: string
          description: The name your code and the picker use for the starting point.
          example: welcome-then-offer
        workflowId:
          type: string
          format: uuid
          description: >-
            The workflow it is made from. What people get is its live version as
            it is when they start.
        title:
          type: string
          nullable: true
          description: What the picker shows. Null means show the workflow's name.
        description:
          type: string
          nullable: true
        position:
          type: integer
          description: The list is ordered by this, smallest first, then by key.
        available:
          type: boolean
          description: >-
            Whether people can start from it now. A starting point that is not
            available is not shown to anyone, and says why.
        unavailableReason:
          type: string
          nullable: true
          enum:
            - workflow_missing
            - workflow_not_own
            - workflow_archived
            - workflow_not_published
            - workflow_empty
            - composition_not_own
            - too_many_widgets
            - widget_not_preset
          description: >
            Why it is not available. `workflow_missing`: the workflow was
            deleted. `workflow_not_own`: it is no longer a

            workflow of your own. `workflow_archived`: unarchive it.
            `workflow_not_published`: it has no live version.

            `workflow_empty`: it shows no composition. `composition_not_own`: a
            block shows a composition made for a

            customer or a team. `too_many_widgets`: it chains more than 10
            widgets. `widget_not_preset`: a widget it

            chains is no longer offered as a preset.
        workflowName:
          type: string
          nullable: true
          description: The workflow's name. Null when the workflow is gone.
        blockCount:
          type: integer
          nullable: true
          description: How many blocks its live version has. Null when it is not available.
        widgets:
          type: array
          description: >-
            The widgets it chains, once each, in the order they first appear.
            Empty when it is not available.
          items:
            $ref: '#/components/schemas/OfferedWorkflowPresetWidget'
        createdAt:
          type: string
          format: date-time
        updatedAt:
          type: string
          format: date-time
      example:
        key: welcome-then-offer
        workflowId: 3fa85f64-5717-4562-b3fc-2c963f66afa6
        title: Example title
        description: Example description
        position: 42
        available: true
        unavailableReason: Example unavailableReason
        workflowName: Example workflowName
        blockCount: 42
        widgets:
          - Example OfferedWorkflowPresetWidget
        createdAt: '2026-01-15T09:30:00.000Z'
        updatedAt: '2026-01-15T09:30:00.000Z'
    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'
    OfferedWorkflowPresetWidget:
      type: object
      description: A widget an offered starting point shows.
      required:
        - id
        - name
        - thumbnailUrl
      properties:
        id:
          type: string
          format: uuid
          description: Your own widget.
        name:
          type: string
        thumbnailUrl:
          type: string
          nullable: true
      example:
        id: 3fa85f64-5717-4562-b3fc-2c963f66afa6
        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.