API
⌘K
My Developer Account

Report

A report is editable liquid syntax that provides a powerful tool for presenting your Lists however you want.

Example Request 

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

View in API Explorer →

Example Object 

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

Attributes

Name Type Description
body string
created_at date_time
id primary_key
name string
updated_at date_time

Can Include

Parameter Value Description Assignable
include created_by

include associated created_by
include updated_by

include associated updated_by

Order By

Parameter Value Type Description
order body string

prefix with a hyphen (-body) to reverse the order
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
body where[body] string

Query on a specific body

 ?where[body]=string
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/reports

Reading

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

Creating

HTTP Method Endpoint Assignable Attributes
POST /people/v2/reports
  • name
  • body

Updating

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

Deleting

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

Associations

HTTP Method Endpoint Returns Details Filter By
GET https://api.planningcenteronline.com/people/v2/reports/{report_id}/created_by Person
GET https://api.planningcenteronline.com/people/v2/reports/{report_id}/updated_by Person

Belongs To

HTTP Method Endpoint Association Details Filter By
GET https://api.planningcenteronline.com/people/v2/reports Organization