Event - Groups API - Planning Center

Example Request

curl https://api.planningcenteronline.com/groups/v2/events

View in API Explorer →

Example Object

{
  "type": "Event",
  "id": "1",
  "attributes": {
    "attendance_requests_enabled": true,
    "automated_reminder_enabled": true,
    "canceled": true,
    "canceled_at": "2000-01-01T12:00:00Z",
    "description": "string",
    "ends_at": "2000-01-01T12:00:00Z",
    "image": {},
    "location_type_preference": "string",
    "multi_day": true,
    "name": "string",
    "reminders_sent": true,
    "reminders_sent_at": "2000-01-01T12:00:00Z",
    "repeating": true,
    "starts_at": "2000-01-01T12:00:00Z",
    "virtual_location_url": "string",
    "visitors_count": 1
  },
  "relationships": {
    "attendance_submitter": {
      "data": {
        "type": "Person",
        "id": "1"
      }
    },
    "group": {
      "data": {
        "type": "Group",
        "id": "1"
      }
    },
    "location": {
      "data": {
        "type": "Location",
        "id": "1"
      }
    },
    "repeating_event": {
      "data": {
        "type": "RepeatingEvent",
        "id": "1"
      }
    }
  }
}

Attributes

Name	Type	Description
`attendance_requests_enabled`	`boolean`	This is a group setting that applies to all the events in the group. If selected, an email will be sent to the primary email address of the group leader 60 minutes before the event start time, asking them to report attendance.
`automated_reminder_enabled`	`boolean`	If `true`, we send an event remind some specified time before the event starts to all members in the group.
`canceled`	`boolean`	Whether or not the event has been canceled.
`canceled_at`	`date_time`	The date and time the event was canceled.
`description`	`string`	A longform description of the event. Can contain HTML markup.
`ends_at`	`date_time`	The date and time the event ends.
`id`	`primary_key`
`image`	`hash`	The image for the event.
`location_type_preference`	`string`	Either "physical" or "virtual".
`multi_day`	`boolean`	`true` if the event spans multiple days. Otherwise `false`.
`name`	`string`	The name/title of the event.
`reminders_sent`	`boolean`	`true` if reminders have been sent for this event. Otherwise `false`.
`reminders_sent_at`	`date_time`	The date and time reminders were sent for this event.
`repeating`	`boolean`	`true` if the event is a repeating event. Otherwise `false`.
`starts_at`	`date_time`	The date and time the event starts.
`virtual_location_url`	`string`	The URL for the virtual location. Typically we don't show this URL unless unless the locationtypepreference is "virtual".
`visitors_count`	`integer`	The number of visitors who attended the event. These are people who are not members of the group.

Relationships

Name	Type	Association Type
attendance_submitter	Person	to_one
group	Group	to_one
location	Location	to_one
repeating_event	RepeatingEvent	to_one

Can Include

Parameter	Value	Description	Assignable
include	group	include associated group	create and update
include	location	include associated location	create and update

Order By

Parameter	Value	Type	Description
order	ends_at	string	prefix with a hyphen (-ends_at) to reverse the order
order	name	string	prefix with a hyphen (-name) to reverse the order
order	starts_at	string	prefix with a hyphen (-starts_at) to reverse the order

Query By

Name	Parameter	Type	Description	Example
ends_at	`where[ends_at]`	date_time	Query on a specific ends_at	`?where[ends_at]=2000-01-01T12:00:00Z`
name	`where[name]`	string	Query on a specific name	`?where[name]=string`
starts_at	`where[starts_at]`	date_time	Query on a specific starts_at	`?where[starts_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	`/groups/v2/events`

Reading

HTTP Method	Endpoint
GET	`/groups/v2/events/{id}`

Associations

HTTP Method	Endpoint	Returns	Details	Filter By
GET	`https://api.planningcenteronline.com/groups/v2/events/{event_id}/attendances`	Attendance	attendances recorded for this event	`attended` where `attended` is `true`
GET	`https://api.planningcenteronline.com/groups/v2/events/{event_id}/group`	Group	group which the event belongs to
GET	`https://api.planningcenteronline.com/groups/v2/events/{event_id}/location`	Location	physical location of the event
GET	`https://api.planningcenteronline.com/groups/v2/events/{event_id}/notes`	EventNote	notes added to the event
GET	`https://api.planningcenteronline.com/groups/v2/events/{event_id}/rsvps`	RSVP	RSVP responses for the event

Belongs To

HTTP Method	Endpoint	Association	Details	Filter By
GET	`https://api.planningcenteronline.com/groups/v2/groups/{group_id}/events`	Group	events for this group	`canceled` have a `canceled_at` date and time `not_canceled` do not have a `canceled_at` date and time
GET	`https://api.planningcenteronline.com/groups/v2/group_types/{group_type_id}/events`	GroupType	events of groups with this group type	`canceled` has a `canceled_at` date and time `not_canceled` do not have a `canceled_at` date and time `upcoming` future `starts_at` date and time
GET	`https://api.planningcenteronline.com/groups/v2/events`	Organization	events for all groups in this organization	`campus` from specific campuses; provide an additional `campus_id` param as a comma-separated list of IDs, ex: `?filter=campus&campus_id=1,2,3` `canceled` has a `canceled_at` date and time `group` from specific groups; provide an additional `group_id` param as a comma-separated list of IDs, ex: `?filter=group&group_id=1,2,3` `group_type` from specific group types; provide an additional `group_type_id` param as a comma-separated list of IDs, ex: `?filter=group_type&group_type_id=1,2,3` `my_groups` only group events of which you are a member `not_canceled` does not have a `canceled_at` date and time `upcoming` future `starts_at` date and time
GET	`https://api.planningcenteronline.com/groups/v2/people/{person_id}/events`	Person	events of groups which this person is a member	`canceled` has a `canceled_at` date and time `not_canceled` does not have a `canceled_at` date and time