---
title: "List mockup templates"
method: GET
path: "/mockup-templates"
tags: ["Surveys"]
---

# List mockup templates

`GET /mockup-templates`

## Request

- Base URL: `https://api.pickfu.com/v1`
- URL: `https://api.pickfu.com/v1/mockup-templates`
- Auth: HTTP bearer

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.

## Query parameters

- `page` integer
- `limit` integer
- `lookupKey` string

## Response `200`

Default Response

- object
  - `templates` object[], required
    - `lookupKey` string, required: The template's key; send it as an option's `mockup.template`.
    - `name` string, required: What the template shows
    - `category` string, nullable, required: The store the template looks like, such as `apple`
    - `displayField` object, nullable, required: The field an option's `value` fills, such as the app name; leave it out of `values`.
      - `name` string
      - `label` string
      - `maxLength` integer, nullable
    - `valuesSchema` object, required: 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` object, required: Example values the template renders well
    - `importSources` string[], required: 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` object, required
    - `page` integer, required
    - `limit` integer, required
    - `total` integer, required
    - `totalPages` integer, required
    - `hasMore` boolean, required

## Other responses

- `401`: Default Response
- `403`: Default Response

---

[API](https://skmtc.dev/pickfu/apis/pickfu-api.md) · [All operations](https://skmtc.dev/pickfu/apis/pickfu-api/llms.txt) · [OpenAPI document](https://skmtc.dev/pickfu/apis/pickfu-api/revisions/919fc58413ea?raw)