---
title: "Retrieve the form templates for a deal"
method: GET
path: "/v2/deals/form-templates"
tags: ["Deals"]
---

# Retrieve the form templates for a deal

`GET /v2/deals/form-templates`

Fetches the specified form templates for a deal.

## Query parameters

- `group_key` string
- `mold_key` string
- `partner_key` string
- `deduplicate` boolean

## Response `200`

Fetches the specified form templates for a deal.

- object
  - `data` object[], required
    - `created_at` integer — Immutable Unix timestamp in milliseconds taken at time of creation
    - `key` string — A unique identifier used to reference the object
    - `updated_at` integer — Unix timestamp in milliseconds taken at time of last update
    - `description` string, nullable — A description for users to better understand the form
    - `fields` object[]
      - `api_name` string — API name of this field. Created by PartnerStack at time of field creation. Used when referencing field in created objects.
      - `default_value` unknown
      - `description` string, nullable — Description of the field to be displayed to the partner
      - `help_text` string, nullable — Helper text on how to use this field
      - `hidden` boolean — Whether or not this field is displayed when filling out its attached form
      - `internal_name` string — API name of this field. Created by PartnerStack at time of field creation. Used when referencing field in created objects. Cannot be edited.
      - `maps_to` unknown[] — If provided, the response to the current field will map to responses of fields within maps_to array
        - unknown
      - `name` string — Name of field that is presented
      - `options` object — Options to select from if this field is a picklist/checkbox
      - `placeholder_text` string, nullable — Text to be used as placeholder when filling out this field
      - `position` integer — The position that this field will be displayed in relation to others on the same form (index starts at 0)
      - `protected` boolean — Boolean that limits values of field that can be edited. If True, this field may not be archived and type as well as required cannot be edited.
      - `required` boolean — Whether or not this field will be required when filling out its attached form
      - `type` string — The type of field that will be presented (input, picklist, number ect.)
    - `groups` object[]
      - `created_at` integer — Immutable Unix timestamp in milliseconds taken at time of creation
      - `key` string — A unique identifier used to reference the object
      - `updated_at` integer — Unix timestamp in milliseconds taken at time of last update
      - `archived` boolean, nullable — Whether or not this group is still active
      - `default` boolean — Whether this is the default Group for partners to join
      - `features` object, nullable — Features that partners within this group have access too
      - `is_widget_group` boolean, nullable — Whether this is the current referral widget group
      - `name` string — The name of this Group as presented to partners
      - `slug` string, nullable — The slugified version of this groups name to be added to routes
    - `name` string, nullable — The presented name of this form
    - `title` string, nullable — A title to display to users when they fill out the form
    - `type` string — The type of object within PartnerStack that this form translates to
  - `message` string, required
  - `status` integer, required

## Other responses

- `400` — Bad Request Error
- `401` — Unauthorized Error
- `403` — Forbidden Error
- `404` — Not Found Error
- `500` — Internal Server Error

---

[API](https://skmtc.net/partnerstack/apis/partnerstack-api.md) · [All operations](https://skmtc.net/partnerstack/apis/partnerstack-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/partnerstack/partnerstack-api/versions/0f35aebe53a9/schema)