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}

Form submission details

cURL

curl --request GET \
  --url https://api.kajabi.com/v1/form_submissions/{id} \
  --header 'Authorization: Bearer <token>'

200

{
  "data": {
    "id": "<string>",
    "type": "<string>",
    "attributes": {
      "name": "<string>",
      "email": "<string>",
      "phone_number": "<string>",
      "business_number": "<string>",
      "address_line_1": "<string>",
      "address_line_2": "<string>",
      "address_city": "<string>",
      "address_state": "<string>",
      "address_country": "<string>",
      "address_zip": "<string>",
      "custom_1": "<string>",
      "custom_2": "<string>",
      "custom_3": "<string>"
    },
    "relationships": {
      "site": {
        "data": {
          "id": "<string>",
          "type": "<string>"
        }
      },
      "form": {
        "data": {
          "id": "<string>",
          "type": "<string>"
        }
      }
    }
  }
}

Authorizations

Authorization · string · header · required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

id · string · required

Query Parameters

include · string

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

Response

200

application/vnd.api+json

Success, shows details of a form submission

data · object

Show child attributes