Form - People API - Planning Center

Example Request

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

View in API Explorer →

Example Object

{
  "type": "Form",
  "id": "1",
  "attributes": {
    "active": true,
    "archived": true,
    "archived_at": "2000-01-01T12:00:00Z",
    "can_manage": true,
    "created_at": "2000-01-01T12:00:00Z",
    "deleted_at": "2000-01-01T12:00:00Z",
    "description": "string",
    "login_required": true,
    "name": "string",
    "public_url": "string",
    "recently_viewed": true,
    "send_submission_notification_to_submitter": true,
    "submission_count": 1,
    "updated_at": "2000-01-01T12:00:00Z"
  },
  "relationships": {
    "campus": {
      "data": {
        "type": "Campus",
        "id": "1"
      }
    },
    "form_category": {
      "data": {
        "type": "FormCategory",
        "id": "1"
      }
    }
  }
}

Attributes

Name	Type	Description
`active`	`boolean`
`archived`	`boolean`
`archived_at`	`date_time`
`can_manage`	`boolean`
`created_at`	`date_time`
`deleted_at`	`date_time`
`description`	`string`
`id`	`primary_key`
`login_required`	`boolean`
`name`	`string`
`public_url`	`string`
`recently_viewed`	`boolean`
`send_submission_notification_to_submitter`	`boolean`
`submission_count`	`integer`
`updated_at`	`date_time`

Relationships

Name	Type	Association Type	Note
campus	Campus	to_one
form_category	FormCategory	to_one

Can Include

Parameter	Value	Description	Assignable
include	campus	include associated campus	create and update
include	category	include associated category

Order By

Parameter	Value	Type	Description
order	active	string	prefix with a hyphen (-active) to reverse the order
order	archived_at	string	prefix with a hyphen (-archived_at) to reverse the order
order	campus	string	prefix with a hyphen (-campus) to reverse the order
order	category	string	prefix with a hyphen (-category) to reverse the order
order	created_at	string	prefix with a hyphen (-created_at) to reverse the order
order	deleted_at	string	prefix with a hyphen (-deleted_at) to reverse the order
order	description	string	prefix with a hyphen (-description) to reverse the order
order	name	string	prefix with a hyphen (-name) to reverse the order
order	submission_count	string	prefix with a hyphen (-submission_count) 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
active	`where[active]`	boolean	Query on a specific active	`?where[active]=true`
id	`where[id]`	primary_key	Query on a specific id	`?where[id]=primary_key`

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`

Reading

HTTP Method	Endpoint
GET	`/people/v2/forms/{id}`

Associations

HTTP Method	Endpoint	Returns
GET	`https://api.planningcenteronline.com/people/v2/forms/{form_id}/campus`	Campus
GET	`https://api.planningcenteronline.com/people/v2/forms/{form_id}/category`	FormCategory
GET	`https://api.planningcenteronline.com/people/v2/forms/{form_id}/fields`	FormField
GET	`https://api.planningcenteronline.com/people/v2/forms/{form_id}/form_submissions`	FormSubmission

Belongs To

HTTP Method	Endpoint	Association	Details	Filter By
GET	`https://api.planningcenteronline.com/people/v2/forms/{form_id}/form_submissions/{form_submission_id}/form`	FormSubmission
GET	`https://api.planningcenteronline.com/people/v2/forms`	Organization		`archived` `closed` `not_archived` `open` `recently_deleted` `recently_viewed` `with_recoverable`