API
⌘K
My Developer Account

FormCategory

A Form Category

Example Request 

curl https://api.planningcenteronline.com/people/v2/form_categories

View in API Explorer →

Example Object 

{
  "type": "FormCategory",
  "id": "1",
  "attributes": {
    "created_at": "2000-01-01T12:00:00Z",
    "name": "string",
    "updated_at": "2000-01-01T12:00:00Z"
  },
  "relationships": {}
}

Attributes

Name Type Description
created_at date_time
id primary_key
name string
updated_at date_time

Order By

Parameter Value Type Description
order created_at string

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

prefix with a hyphen (-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
name where[name] string

Query on a specific name

 ?where[name]=string
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/form_categories

Reading

HTTP Method Endpoint
GET /people/v2/form_categories/{id}

Creating

HTTP Method Endpoint Assignable Attributes
POST /people/v2/form_categories
  • name

Updating

HTTP Method Endpoint Assignable Attributes
PATCH /people/v2/form_categories/{id}
  • name

Deleting

HTTP Method Endpoint
DELETE /people/v2/form_categories/{id}

Belongs To

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