Sign in

v1

latestOpenAPI 3.0.22026-07-24800528.1 KB
Form Templates

List all form templates

Returns a list of your form templates. The form templates are returned sorted by creation date, with the most recent form templates appearing first.

get/v2/form-templates

Query parameters

min_createdinteger

Applies a minimum epoch timestamp (ms) filter to the response created_at.

max_createdinteger

Applies a maximum epoch timestamp (ms) filter to the response created_at.

min_updatedinteger

Applies a minimum epoch timestamp (ms) filter to the response updated_at.

max_updatedinteger

Applies a maximum epoch timestamp (ms) filter to the response updated_at.

groupstring

Will filter for partnerships who are in a group with the specified name. Name must have spaces and special characters removed.

limitinteger

A limit on the number of items to be returned. Limits can range between 1 and 250, and the default is 10.

starting_afterstring

A cursor for use in pagination, starting_after takes in an item key and the subsequent call will return the following items in the list. This is mutually exclusive with ending_before.

ending_beforestring

A cursor for use in pagination, ending_before takes in an item key and the subsequent call will return the prior items in the list. This is mutually exclusive with starting_after.

target_type'link' | 'application' | 'application_shared_fields' | 'deal' | 'lead' | 'customer' | 'request' | 'partnership' | 'member_profile' | 'announcement' | 'mdf' | 'partnership_stats_config'

The molds' target type. If empty, filter by all types.

mold_keysstring
Example:['mold_jRq2wKrJyTIEj7', 'mold_svJk6FKsOT6R8Q']

The keys of the molds to filter by. If empty, returns fields for all molds.

Response

Returns a list of your form templates. The form templates are returned sorted by creation date, with the most recent form templates appearing first.

messagestring required
statusinteger required

Example response

{
  "data": {
    "items": [
      {
        "created_at": 1574181282399,
        "key": "co_a80cb515fe",
        "updated_at": 1574181282399,
        "description": "please fill out the entire form to register a deal",
        "fields": [
          {
            "name": "Company Address"
          }
        ],
        "groups": [
          {
            "created_at": 1574181282399,
            "key": "co_a80cb515fe",
            "updated_at": 1574181282399,
            "name": "Resellers",
            "slug": "resellers"
          }
        ],
        "name": "Deal registration form",
        "title": "My Companies Deal Registration Form",
        "type": "deal"
      }
    ]
  }
}