API
⌘K
My Developer Account

Attendance Collection Only

Individual event attendance for a person.

Example Request 

curl https://api.planningcenteronline.com/groups/v2/events/{event_id}/attendances

View in API Explorer →

Example Object 

{
  "type": "Attendance",
  "id": "1",
  "attributes": {
    "attended": true,
    "role": "value"
  },
  "relationships": {
    "person": {
      "data": {
        "type": "Person",
        "id": "1"
      }
    },
    "event": {
      "data": {
        "type": "Event",
        "id": "1"
      }
    }
  }
}

Attributes

Name Type Description
attended boolean

Whether or not the person attended the event.
id primary_key
role string

The role of the person at the time of event.

Possible values: member, leader, visitor, or applicant

Relationships

Name Type Association Type Note
person Person to_one
event Event to_one

Can Include

Parameter Value Description Assignable
include person

include associated person

 create and update

Order By

Parameter Value Type Description
order first_name string

prefix with a hyphen (-first_name) to reverse the order
order last_name string

prefix with a hyphen (-last_name) to reverse the order
order role string

prefix with a hyphen (-role) to reverse the order

Query By

Name Parameter Type Description Example
role where[role] string

Query on a specific role

Possible values: member, leader, visitor, or applicant

 ?where[role]=value

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/{event_id}/attendances

Associations

HTTP Method Endpoint Returns Details Filter By
GET https://api.planningcenteronline.com/groups/v2/events/{event_id}/attendances/{attendance_id}/person Person

person belonging to this attendance

Belongs To

HTTP Method Endpoint Association Details Filter By
GET https://api.planningcenteronline.com/groups/v2/events/{event_id}/attendances Event

attendances recorded for this event
  • attended

    where attended is true