API
⌘K
My Developer Account

EventTime

A time that someone may check in. Times are copied from session to session.

Example Request

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

View in API Explorer →

Example Object

{
  "type": "EventTime",
  "id": "1",
  "attributes": {
    "created_at": "2000-01-01T12:00:00Z",
    "day_of_week": 1,
    "guest_count": 1,
    "hides_at": "2000-01-01T12:00:00Z",
    "hour": 1,
    "minute": 1,
    "name": "string",
    "regular_count": 1,
    "shows_at": "2000-01-01T12:00:00Z",
    "starts_at": "2000-01-01T12:00:00Z",
    "total_count": 1,
    "updated_at": "2000-01-01T12:00:00Z",
    "volunteer_count": 1
  },
  "relationships": {
    "event": {
      "data": {
        "type": "Event",
        "id": "1"
      }
    },
    "event_period": {
      "data": {
        "type": "EventPeriod",
        "id": "1"
      }
    }
  }
}

Attributes

Name Type Description
created_at date_time
day_of_week integer
guest_count integer
hides_at date_time
hour integer
id primary_key
minute integer
name string
regular_count integer
shows_at date_time
starts_at date_time
total_count integer
updated_at date_time
volunteer_count integer

Relationships

Name Type Association Type Note
event Event to_one
event_period EventPeriod to_one

Can Include

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

Order By

Parameter Value Type Description
order shows_at string prefix with a hyphen (-shows_at) 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
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/event_times

Reading

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

Associations

HTTP Method Endpoint Returns Details Filter By
GET https://api.planningcenteronline.com/check-ins/v2/event_times/{event_time_id}/available_locations Location
  • for_current_station
GET https://api.planningcenteronline.com/check-ins/v2/event_times/{event_time_id}/check_ins CheckIn
  • attendee
  • checked_out
  • first_time
  • guest
  • not_checked_out
  • not_one_time_guest
  • one_time_guest
  • regular
  • volunteer
GET https://api.planningcenteronline.com/check-ins/v2/event_times/{event_time_id}/event Event
GET https://api.planningcenteronline.com/check-ins/v2/event_times/{event_time_id}/event_period EventPeriod
GET https://api.planningcenteronline.com/check-ins/v2/event_times/{event_time_id}/headcounts Headcount
GET https://api.planningcenteronline.com/check-ins/v2/event_times/{event_time_id}/location_event_times LocationEventTime

Belongs To

HTTP Method Endpoint Association Details Filter By
GET https://api.planningcenteronline.com/check-ins/v2/check_ins/{check_in_id}/event_times CheckIn
GET https://api.planningcenteronline.com/check-ins/v2/events/{event_id}/current_event_times Event
GET https://api.planningcenteronline.com/check-ins/v2/check_ins/{check_in_id}/event_period/{event_period_id}/event_times EventPeriod
  • available
GET https://api.planningcenteronline.com/check-ins/v2/headcounts/{headcount_id}/event_time Headcount
GET https://api.planningcenteronline.com/check-ins/v2/event_times/{event_time_id}/location_event_times/{location_event_time_id}/event_time LocationEventTime
GET https://api.planningcenteronline.com/check-ins/v2/event_times Organization