v1

latestOpenAPI 3.1.1Apache 2.02026-07-26774088.4 KB
Forms

Form submission details

Shows details of a form submission

Form Submission Attributes

  • name (string) - The name of the person who submitted the form
  • email (string) - The email address of the person who submitted the form
  • address_line_1 (string) - First line of address if provided
  • address_line_2 (string) - Second line of address if provided
  • address_city (string) - City if provided
  • address_country (string) - Country if provided
  • address_state (string) - State if provided
  • address_zip (string) - ZIP/postal code if provided
  • phone_number (string) - Phone number if provided
  • business_number (string) - Business number if provided
  • mobile_phone_number (string) - Mobile phone number if provided

Custom Fields

Form submissions may also include custom field values that were collected through the form.

Relationships

Form submissions belong to:

  • A site
  • A form

Include Related Resources

Use the include parameter to load related resources:

Include site and form

  • GET /v1/form_submissions/123?include=site,form
get/v1/form_submissions/{id}

Path parameters

idstring required

Query parameters

includestring

Load the related resources, for example ?include=site,form

Response

Success, shows details of a form submission