API
⌘K
My Developer Account

FormSubmission

A form submission.

Example Request 

curl https://api.planningcenteronline.com/people/v2/forms/{form_id}/form_submissions

View in API Explorer →

Example Object 

{
  "type": "FormSubmission",
  "id": "1",
  "attributes": {
    "created_at": "2000-01-01T12:00:00Z",
    "requires_verification": true,
    "updated_at": "2000-01-01T12:00:00Z",
    "verified": true
  },
  "relationships": {
    "person": {
      "data": {
        "type": "Person",
        "id": "1"
      }
    },
    "form": {
      "data": {
        "type": "Form",
        "id": "1"
      }
    }
  }
}

Attributes

Name Type Description
created_at date_time
id primary_key
requires_verification boolean

Only available when requested with the ?fields param
updated_at date_time
verified boolean

Relationships

Name Type Association Type Note
person Person to_one
form Form to_one

Can Include

Parameter Value Description Assignable
include form

include associated form

 create and update
include form_fields

include associated form_fields
include form_submission_values

include associated formsubmissionvalues
include person

include associated person

 create and update

Order By

Parameter Value Type Description
order created_at string

prefix with a hyphen (-created_at) to reverse the order
order person.first_name string

prefix with a hyphen (-person.first_name) to reverse the order
order person.last_name string

prefix with a hyphen (-person.last_name) to reverse the order
order updated_at string

prefix with a hyphen (-updated_at) to reverse the order

Query By

Name Parameter Type Description Example
created_at where[created_at] date_time

Query on a specific created_at

 ?where[created_at]=2000-01-01T12:00:00Z
updated_at where[updated_at] date_time

Query on a specific updated_at

 ?where[updated_at]=2000-01-01T12:00:00Z

Pagination

Name Parameter Type Description
per_page per_page integer

how many records to return per page (min=1, max=100, default=25)
offset offset integer

get results from given offset

Endpoints

Listing

HTTP Method Endpoint
GET /people/v2/forms/{form_id}/form_submissions

Reading

HTTP Method Endpoint
GET /people/v2/forms/{form_id}/form_submissions/{id}

Associations

HTTP Method Endpoint Returns Details Filter By
GET https://api.planningcenteronline.com/people/v2/forms/{form_id}/form_submissions/{form_submission_id}/form Form
GET https://api.planningcenteronline.com/people/v2/forms/{form_id}/form_submissions/{form_submission_id}/form_fields FormField
GET https://api.planningcenteronline.com/people/v2/forms/{form_id}/form_submissions/{form_submission_id}/form_submission_values FormSubmissionValue
GET https://api.planningcenteronline.com/people/v2/forms/{form_id}/form_submissions/{form_submission_id}/person Person

Belongs To

HTTP Method Endpoint Association Details Filter By
GET https://api.planningcenteronline.com/people/v2/forms/{form_id}/form_submissions Form