API
⌘K
My Developer Account

Headcount

A tally of attendees for a given event time and attendance type. If one does not exist, the count may have been zero.

Example Request

curl https://api.planningcenteronline.com/check-ins/v2/headcounts

View in API Explorer →

Example Object

{
  "type": "Headcount",
  "id": "1",
  "attributes": {
    "created_at": "2000-01-01T12:00:00Z",
    "total": 1,
    "updated_at": "2000-01-01T12:00:00Z"
  },
  "relationships": {
    "event_time": {
      "data": {
        "type": "EventTime",
        "id": "1"
      }
    },
    "attendance_type": {
      "data": {
        "type": "AttendanceType",
        "id": "1"
      }
    }
  }
}

Attributes

Name Type Description
created_at date_time
id primary_key
total integer
updated_at date_time

Relationships

Name Type Association Type Note
event_time EventTime to_one
attendance_type AttendanceType to_one

Can Include

Parameter Value Description Assignable
include attendance_type include associated attendance_type create and update
include event_time include associated event_time create and update

Order By

Parameter Value Type Description
order created_at string prefix with a hyphen (-created_at) to reverse the order
order total string prefix with a hyphen (-total) 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
created_at where[created_at] date_time Query on a specific created_at ?where[created_at]=2000-01-01T12:00:00Z
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 /check-ins/v2/headcounts

Reading

HTTP Method Endpoint
GET /check-ins/v2/headcounts/{id}

Associations

HTTP Method Endpoint Returns Details Filter By
GET https://api.planningcenteronline.com/check-ins/v2/headcounts/{headcount_id}/attendance_type AttendanceType
GET https://api.planningcenteronline.com/check-ins/v2/headcounts/{headcount_id}/event_time EventTime

Belongs To

HTTP Method Endpoint Association Details Filter By
GET https://api.planningcenteronline.com/check-ins/v2/events/{event_id}/attendance_types/{attendance_type_id}/headcounts AttendanceType
GET https://api.planningcenteronline.com/check-ins/v2/event_times/{event_time_id}/headcounts EventTime
GET https://api.planningcenteronline.com/check-ins/v2/headcounts Organization