API
⌘K
My Developer Account

FormField

A field in a custom form.

Example Request 

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

View in API Explorer →

Example Object 

{
  "type": "FormField",
  "id": "1",
  "attributes": {
    "created_at": "2000-01-01T12:00:00Z",
    "description": "string",
    "field_type": "value",
    "label": "string",
    "required": true,
    "sequence": 1,
    "settings": "string",
    "updated_at": "2000-01-01T12:00:00Z"
  },
  "relationships": {
    "form": {
      "data": {
        "type": "Form",
        "id": "1"
      }
    },
    "fieldable": {
      "data": {
        "type": "Fieldable",
        "id": "1"
      }
    },
    "options": {
      "data": {
        "type": "FormFieldOption",
        "id": "1"
      }
    },
    "form_field_conditions": {
      "data": [
        {
          "type": "FormFieldCondition",
          "id": "1"
        }
      ]
    }
  }
}

Attributes

Name Type Description
created_at date_time
description string
field_type string

Possible values: string, text, checkboxes, dropdown, date, phone_number, address, birthday, gender, custom_field, note, workflow, heading, number, boolean, file, medical, workflow_checkbox, workflow_checkboxes, workflow_dropdown, marital_status, anniversary, grade, primary_campus, school, or household
id primary_key
label string
required boolean
sequence integer
settings string
updated_at date_time

Relationships

Name Type Association Type Note
form Form to_one
fieldable Fieldable to_one

Polymorphic. Fieldable can be any of the following: FieldDefinition, NoteCategory, or Workflow.

options FormFieldOption to_one
form_field_conditions FormFieldCondition to_many

Can Include

Parameter Value Description Assignable
include options

include associated options

 create and update

Order By

Parameter Value Type Description
order created_at string

prefix with a hyphen (-created_at) to reverse the order
order sequence string

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

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

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}/fields

Reading

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

Associations

HTTP Method Endpoint Returns Details Filter By
GET https://api.planningcenteronline.com/people/v2/forms/{form_id}/fields/{form_field_id}/options FormFieldOption

Belongs To

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