AttendanceType - Check-Ins API

Example Request

curl https://api.planningcenteronline.com/check-ins/v2/events/{event_id}/attendance_types

View in API Explorer →

Example Object

{
  "type": "AttendanceType",
  "id": "1",
  "attributes": {
    "color": "string",
    "created_at": "2000-01-01T12:00:00Z",
    "limit": 1,
    "name": "string",
    "updated_at": "2000-01-01T12:00:00Z"
  },
  "relationships": {
    "event": {
      "data": {
        "type": "Event",
        "id": "1"
      }
    }
  }
}

Attributes

Name	Type	Description
`color`	`string`
`created_at`	`date_time`
`id`	`primary_key`
`limit`	`integer`
`name`	`string`
`updated_at`	`date_time`

Relationships

Name	Type	Association Type	Note
event	Event	to_one

Can Include

Parameter	Value	Description	Assignable
include	event	include associated event	create and update

Query By

Name	Parameter	Type	Description	Example
id	`where[id]`	primary_key	Query on a specific id	`?where[id]=primary_key`
name	`where[name]`	string	Query on a specific name	`?where[name]=string`

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/events/{event_id}/attendance_types`

Reading

HTTP Method	Endpoint
GET	`/check-ins/v2/events/{event_id}/attendance_types/{id}`

Associations

HTTP Method	Endpoint	Returns	Details	Filter By
GET	`https://api.planningcenteronline.com/check-ins/v2/events/{event_id}/attendance_types/{attendance_type_id}/event`	Event
GET	`https://api.planningcenteronline.com/check-ins/v2/events/{event_id}/attendance_types/{attendance_type_id}/headcounts`	Headcount

Belongs To

HTTP Method	Endpoint	Association	Details	Filter By
GET	`https://api.planningcenteronline.com/check-ins/v2/events/{event_id}/attendance_types`	Event
GET	`https://api.planningcenteronline.com/check-ins/v2/headcounts/{headcount_id}/attendance_type`	Headcount