Form details

Shows details of a form

Forms belong to a site and can be associated with:

• Landing pages
• Offers
• Email sequences
• Events
• Newsletters

Form Attributes

• title (string) - A required field that represents the name or heading of the form. This is used to identify and display the form in the user interface. Forms must have a unique title within a site and can be searched and sorted by this attribute.
• default (boolean) - A boolean flag indicating whether this is the default form for the site. Each site can have one default form, which is typically used when no specific form is specified. The default form can be accessed using the special ID "default" in API calls. When true, this form is considered the site's primary contact form.
• webhook_url (string) - An optional URL where form submission data will be sent via webhook. This allows integration with external systems. The URL:
  • Must be a valid URL format
  • Cannot be a redirecting URL
  • Is automatically transformed and validated
  • Can be used to send form submission data to external services
• created_at (string) - Timestamp indicating when the form was created. This is automatically set when the form is first created.
• updated_at (string) - Timestamp indicating when the form was last modified. This is automatically updated whenever the form is changed.

Include Related Resources

Use the include parameter to load related resources:

Include fields, offer, contact_tags

• GET /v1/forms/123?include=fields,offer,contact_tags

Response will include the requested related resources