Organization - Calendar API

Example Request

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

View in API Explorer →

Example Object

{
  "type": "Organization",
  "id": "1",
  "attributes": {
    "calendar_starts_on": "string",
    "date_format": "string",
    "name": "string",
    "onboarding": true,
    "time_zone": "string",
    "twenty_four_hour_time": true
  },
  "relationships": {}
}

Attributes

Name	Type	Description
`calendar_starts_on`	`string`	The day of the week the calendar starts on
`date_format`	`string`	Possible values: - `%d/%m/%Y`: indicates date/month/year formatting - `%m/%d/%Y`: indicates month/date/year formatting
`id`	`primary_key`	Unique identifier for the organization
`name`	`string`	The name of the organization
`onboarding`	`boolean`	Only available when requested with the `?fields` param
`time_zone`	`string`	The time zone of the organization
`twenty_four_hour_time`	`boolean`	`true` indicates hours for times will use a 24-hour clock `false` indicates hours for times will use a 12-hour clock

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`

Reading

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

Associations

HTTP Method	Endpoint	Returns	Filter By
GET	`https://api.planningcenteronline.com/calendar/v2/attachments`	Attachment
GET	`https://api.planningcenteronline.com/calendar/v2/conflicts`	Conflict	`future` `resolved` `unresolved`
GET	`https://api.planningcenteronline.com/calendar/v2/event_instances`	EventInstance	`all` filter to instances you approve, manage, own, or subscribe to; can't be combined with any other user scopes `approved` filter to instances that are approved; can't be combined with any other `approved` scopes `approved_pending` `approved_pending_rejected` `approved_rejected` `approver` filter to instances you approve; can't be combined with any other `approver` scopes `approver_subscriber` `future` `lost` `lost_due_to_blockout` `manager` filter to instances you manage; can't be combined with any other `manager` scopes `manager_approver` `manager_approver_subscriber` `manager_subscriber` `not_pending_event_requests` `owner` filter to instances you own; can't be combined with any other `owner` scopes `owner_approver` `owner_approver_subscriber` `owner_manager` `owner_manager_approver` `owner_manager_approver_subscriber` `owner_manager_subscriber` `owner_subscriber` `pending` filter to instances that are pending; can't be combined with any other `pending` scopes `pending_rejected` `rejected` filter to instances that are rejected; can't be combined with any other `rejected` scopes `shared` `subscriber` filter to instances you subscribe to; can't be combined with any other `subscriber` scopes `unresolved`
GET	`https://api.planningcenteronline.com/calendar/v2/event_resource_requests`	EventResourceRequest
GET	`https://api.planningcenteronline.com/calendar/v2/events`	Event	`future`
GET	`https://api.planningcenteronline.com/calendar/v2/feeds`	Feed
GET	`https://api.planningcenteronline.com/calendar/v2/job_statuses`	JobStatus
GET	`https://api.planningcenteronline.com/calendar/v2/people`	Person	`active` `event_owners`
GET	`https://api.planningcenteronline.com/calendar/v2/report_templates`	ReportTemplate
GET	`https://api.planningcenteronline.com/calendar/v2/resource_approval_groups`	ResourceApprovalGroup
GET	`https://api.planningcenteronline.com/calendar/v2/resource_bookings`	ResourceBooking	`approved` `approved_pending` `approved_pending_rejected` `approved_rejected` `future` `pending` `pending_rejected` `rejected` `resources` `rooms`
GET	`https://api.planningcenteronline.com/calendar/v2/resource_folders`	ResourceFolder	`resources` `rooms`
GET	`https://api.planningcenteronline.com/calendar/v2/resource_questions`	ResourceQuestion
GET	`https://api.planningcenteronline.com/calendar/v2/resources`	Resource	`resources` `rooms`
GET	`https://api.planningcenteronline.com/calendar/v2/room_setups`	RoomSetup	`shared_room_setups`
GET	`https://api.planningcenteronline.com/calendar/v2/tag_groups`	TagGroup	`required`
GET	`https://api.planningcenteronline.com/calendar/v2/tags`	Tag	`individual`

Belongs To

HTTP Method	Endpoint	Association	Details	Filter By
GET	`https://api.planningcenteronline.com/calendar/v2/people/{person_id}/organization`	Person