ReportTemplate - Calendar API

Example Request

curl https://api.planningcenteronline.com/calendar/v2/report_templates

View in API Explorer →

Example Object

{
  "type": "ReportTemplate",
  "id": "1",
  "attributes": {
    "body": "string",
    "created_at": "string",
    "description": "string",
    "title": "string",
    "updated_at": "string"
  },
  "relationships": {}
}

Attributes

Name	Type	Description
`body`	`string`	The contents of the report template
`created_at`	`string`	UTC time at which the report was created
`description`	`string`	A summarization of the report
`id`	`primary_key`	Unique identifier for the report
`title`	`string`	The title of the report
`updated_at`	`string`	UTC time at which the report was updated

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	`/calendar/v2/report_templates`

Reading

HTTP Method	Endpoint
GET	`/calendar/v2/report_templates/{id}`

Creating

HTTP Method	Endpoint	Assignable Attributes
POST	`/calendar/v2/report_templates`	body description title

Updating

HTTP Method	Endpoint	Assignable Attributes
PATCH	`/calendar/v2/report_templates/{id}`	body description title

Deleting

HTTP Method	Endpoint
DELETE	`/calendar/v2/report_templates/{id}`

Belongs To

HTTP Method	Endpoint	Association	Details	Filter By
GET	`https://api.planningcenteronline.com/calendar/v2/report_templates`	Organization