List form submissions

Form submissions for authorized sites

Pagination

Use page[number] and page[size] parameters to paginate results:

Get first page of 10 items

• GET /v1/form_submissions?page[number]=1&page[size]=10

Get second page of 25 items

• GET /v1/form_submissions?page[number]=2&page[size]=25

The response includes pagination links and meta data:

{
  "links": {
    "self": "https://api.kajabi.com/v1/form_submissions?page[number]=2&page[size]=10",
    "first": "https://api.kajabi.com/v1/form_submissions?page[number]=1&page[size]=10",
    "prev": "https://api.kajabi.com/v1/form_submissions?page[number]=1&page[size]=10",
    "next": "https://api.kajabi.com/v1/form_submissions?page[number]=3&page[size]=10",
    "last": "https://api.kajabi.com/v1/form_submissions?page[number]=5&page[size]=10"
  },
  "meta": {
    "total_pages": 5,
    "total_count": 50,
    "current_page": 2
  }
}

Filtering

Use filter parameters to narrow down results:

Filter by site ID

• GET /v1/form_submissions?filter[site_id]=123

Filter by form ID

• GET /v1/form_submissions?filter[form_id]=456

Sorting

Use the sort parameter to sort results:

Sort by creation date (oldest first)

• GET /v1/form_submissions?sort=created_at

Sort by name (alphabetical)

• GET /v1/form_submissions?sort=name

GET /v1/form_submissions

List form submissions

cURL

curl --request GET \
  --url https://api.kajabi.com/v1/form_submissions \
  --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>"
          }
        }
      }
    }
  ],
  "links": {
    "self": "<string>",
    "current": "<string>"
  }
}

Authorizations

Authorization · string · header · required

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

Query Parameters

sort · string

Sort order, use: name, email, created_at. For descending order use '-' e.g. &sort=-name

page[number] · integer

page[size] · integer

Number of documents

filter[site_id] · string

Filter by site ID, example: filter[site_id]=123

filter[form_id] · string

Filter by form ID, example: filter[form_id]=456

Response

200

application/vnd.api+json

Success, filtered by form_id

data · object[]

Show child attributes

links · object

Show child attributes