API
⌘K
My Developer Account

FieldOption

A field option represents an individual option for a custom field of type "select" or "checkboxes".

Example Request

curl https://api.planningcenteronline.com/people/v2/field_definitions/{field_definition_id}/field_options

View in API Explorer →

Example Object

{
  "type": "FieldOption",
  "id": "1",
  "attributes": {
    "sequence": 1,
    "value": "string"
  },
  "relationships": {
    "field_definition": {
      "data": {
        "type": "FieldDefinition",
        "id": "1"
      }
    }
  }
}

Attributes

Name Type Description
id primary_key
sequence integer
value string

Relationships

Name Type Association Type Note
field_definition FieldDefinition to_one

Order By

Parameter Value Type Description
order sequence string prefix with a hyphen (-sequence) to reverse the order
order value string prefix with a hyphen (-value) to reverse the order

Query By

Name Parameter Type Description Example
sequence where[sequence] integer Query on a specific sequence ?where[sequence]=1
value where[value] string Query on a specific value ?where[value]=string

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/field_definitions/{field_definition_id}/field_options

Reading

HTTP Method Endpoint
GET /people/v2/field_definitions/{field_definition_id}/field_options/{id}

Creating

HTTP Method Endpoint Assignable Attributes
POST /people/v2/field_definitions/{field_definition_id}/field_options
  • value
  • sequence

Updating

HTTP Method Endpoint Assignable Attributes
PATCH /people/v2/field_definitions/{field_definition_id}/field_options/{id}
  • value
  • sequence

Deleting

HTTP Method Endpoint
DELETE /people/v2/field_definitions/{field_definition_id}/field_options/{id}

Belongs To

HTTP Method Endpoint Association Details Filter By
GET https://api.planningcenteronline.com/people/v2/field_data/{field_datum_id}/field_option FieldDatum
GET https://api.planningcenteronline.com/people/v2/field_definitions/{field_definition_id}/field_options FieldDefinition
GET https://api.planningcenteronline.com/people/v2/tabs/{tab_id}/field_options Tab