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

# List mockup templates

> Lists the first-party mockup templates an option of a text question can show, such as an App Store product page, with the values each takes as JSON Schema. Name one on every option of a question as `mockup: { template, values }`, beside the option's `value`, which fills the template's display field.



## OpenAPI

````yaml /docs/api-reference/openapi.json get /mockup-templates
openapi: 3.1.0
info:
  title: PickFu API
  version: 1.0.0
  description: >-
    The PickFu API enables programmatic access to create surveys, retrieve
    results, and integrate PickFu into your workflows.


    ## Overview


    PickFu helps you get instant consumer feedback through surveys. With the
    API, you can:


    - Create surveys programmatically

    - Retrieve survey results and respondent data

    - Target specific audiences with demographic traits

    - Integrate PickFu into your product development workflow


    ## Rate Limits


    Selected endpoints (currently the CSV export endpoints) enforce per-caller
    rate limits and return `429 Too Many Requests` when exceeded. See each
    endpoint description for its specific budget.


    ## Authentication


    All API requests require a Bearer token — either an API key or an OAuth 2.0
    access token. See the [Authentication
    guide](https://www.pickfu.com/docs/developers/authentication) for details.
  contact:
    name: PickFu Support
    email: support@pickfu.com
    url: https://www.pickfu.com
servers:
  - url: https://api.pickfu.com/v1
    description: Production
security:
  - bearerAuth: []
tags:
  - name: Surveys
    description: >-
      Create, retrieve, update, and publish surveys. Surveys are the core
      resource — each contains one or more questions with answer options.
  - name: Responses
    description: >-
      Retrieve individual responses (answers) for a survey, with pagination and
      per-question filtering.
  - name: Tags
    description: Organize surveys with tags. Tags are scoped to your team/account.
  - name: Projects
    description: >-
      Organize surveys into projects. Projects group related surveys and can be
      bookmarked or archived.
  - name: Traits
    description: >-
      Audience targeting and reporting traits used to reach specific
      demographics and segment survey results.
  - name: Playbooks
    description: >-
      Discover and retrieve step-by-step research playbooks. Each playbook is a
      structured sequence of polls designed for a specific research goal.
  - name: Help
    description: Search the PickFu help center for articles and guides.
  - name: Media
    description: >-
      Generate images from text prompts and upload media files to the PickFu
      CDN.
  - name: Semantic Search
    description: >-
      Search completed surveys in your enrolled team account by meaning and
      answer evidence.
paths:
  /mockup-templates:
    get:
      tags:
        - Surveys
      summary: List mockup templates
      description: >-
        Lists the first-party mockup templates an option of a text question can
        show, such as an App Store product page, with the values each takes as
        JSON Schema. Name one on every option of a question as `mockup: {
        template, values }`, beside the option's `value`, which fills the
        template's display field.
      operationId: listMockupTemplates
      parameters:
        - schema:
            type: integer
            minimum: 1
            default: 1
          in: query
          name: page
          required: false
        - schema:
            type: integer
            minimum: 1
            maximum: 50
            default: 20
          in: query
          name: limit
          required: false
        - schema:
            type: string
            minLength: 1
            maxLength: 100
          in: query
          name: lookupKey
          required: false
          description: >-
            Return only the template with this key, such as `app-store-page`;
            none when no template has it.
      responses:
        '200':
          description: Default Response
          content:
            application/json:
              schema:
                type: object
                additionalProperties: false
                required:
                  - templates
                  - pagination
                properties:
                  templates:
                    type: array
                    items:
                      type: object
                      additionalProperties: false
                      required:
                        - lookupKey
                        - name
                        - category
                        - questionTypes
                        - displayField
                        - valuesSchema
                        - sampleValues
                        - importSources
                      properties:
                        lookupKey:
                          type: string
                          description: >-
                            The template's key; send it as an option's
                            `mockup.template`.
                        name:
                          type: string
                          description: What the template shows
                        category:
                          type:
                            - string
                            - 'null'
                          description: The store the template looks like, such as `apple`
                        questionTypes:
                          type: array
                          items:
                            type: string
                          description: >-
                            The question `type`s the template goes on, such as
                            `click_test`. An option naming it on a question of
                            any other type is refused with
                            `MOCKUP_TEMPLATE_UNSUPPORTED_QUESTION`. On a
                            `click_test` or `five_second_test` the page's image
                            becomes the option's image.
                        displayField:
                          type:
                            - object
                            - 'null'
                          additionalProperties: false
                          description: >-
                            The field an option's `value` fills, such as the app
                            name; leave it out of `values`.
                          properties:
                            name:
                              type: string
                            label:
                              type: string
                            maxLength:
                              type:
                                - integer
                                - 'null'
                        valuesSchema:
                          type: object
                          additionalProperties: true
                          description: >-
                            JSON Schema for an option's `mockup.values`: one
                            property per field, titled with its label. Images
                            are https URLs; PickFu copies each to its media CDN
                            when the option is saved. A choice field is a string
                            `enum`. A list field is an array of objects one
                            level deep, each object holding one item's fields.
                        sampleValues:
                          type: object
                          additionalProperties: true
                          description: Example values the template renders well
                        importSources:
                          type: array
                          items:
                            type: string
                          description: >-
                            Stores whose listings can fill the template: send
                            `mockup.import: { source, id }` with one of these as
                            `source` instead of typing every value. Empty when
                            it is filled by hand only.
                  pagination:
                    type: object
                    additionalProperties: false
                    required:
                      - page
                      - limit
                      - total
                      - totalPages
                      - hasMore
                    properties:
                      page:
                        type: integer
                      limit:
                        type: integer
                      total:
                        type: integer
                      totalPages:
                        type: integer
                      hasMore:
                        type: boolean
        '401':
          description: Default Response
          content:
            application/json:
              schema:
                type: object
                additionalProperties: false
                properties:
                  error:
                    type: string
                  message:
                    type: string
        '403':
          description: Default Response
          content:
            application/json:
              schema:
                type: object
                additionalProperties: false
                properties:
                  error:
                    type: string
                  message:
                    type: string
components:
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: >-
        OAuth2 access token obtained via the authorization flow. Include in the
        Authorization header as: `Bearer {access_token}`

````

## Related topics

- [Templates](https://www.pickfu.com/docs/api-reference/v2/templates.md)
- [List surveys](https://www.pickfu.com/docs/api-reference/surveys/list-surveys.md)
- [Amazon listing mockup generator](https://www.pickfu.com/help/amazon-listing-mockup-generator.md)
- [Create survey](https://www.pickfu.com/docs/api-reference/surveys/create-survey.md)
- [Pre-launch listing and product mockup](https://www.pickfu.com/help/pre-launch-listing-and-product-mockup.md)


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