API
⌘K
My Developer Account

FormFieldOption

A field option on a custom form field.

Example Request

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

View in API Explorer →

Example Object

{
  "type": "FormFieldOption",
  "id": "1",
  "attributes": {
    "created_at": "2000-01-01T12:00:00Z",
    "label": "string",
    "sequence": 1,
    "updated_at": "2000-01-01T12:00:00Z"
  },
  "relationships": {
    "form_field": {
      "data": {
        "type": "FormField",
        "id": "1"
      }
    },
    "optionable": {
      "data": {
        "type": "Optionable",
        "id": "1"
      }
    }
  }
}

Attributes

Name Type Description
created_at date_time
id primary_key
label string
sequence integer
updated_at date_time

Relationships

Name Type Association Type Note
form_field FormField to_one
optionable Optionable to_one

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/{field_id}/options

Reading

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

Belongs To

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