Find out more about our rebranding

Events

This page describes all the APIs relating to events.

Get all Events

get
Authorizations
Query parameters
from_datestringOptional
to_datestringOptional
pageinteger · min: 1Optional

The page number of results to return.

Default: 1
per_pageinteger · min: 1 · max: 200Optional

Request for how many records to return.

Default: 50
countintegerOptional

Synonym for per_page

Responses
200

events found

application/json
get
GET /api/v3/events HTTP/1.1
Host: api.openapply.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
200

events found

{
  "events": [
    {
      "id": 1,
      "title": "August Open Day",
      "date": "2018-08-28",
      "description": "Join us for the our August Open Day at both campuses!Looking forward to seeing you then! ",
      "started_at": "9:30 AM",
      "ended_at": "11:30 AM",
      "capacity": null,
      "limit_per_registration": null,
      "published": true,
      "repeatable": false,
      "on_landing_page": true,
      "event_type": "OpenDay",
      "duration": 45,
      "allow_parent_to_cancel": true,
      "cancel_deadline": "no_deadline",
      "updated_at": "2024-11-27T11:32:43.000Z",
      "created_at": "2012-07-20T08:53:33.000Z",
      "hours": []
    }
  ],
  "meta": {
    "pages": 1,
    "page": 1,
    "per_page": 50
  }
}

Get an Event

get
Authorizations
Path parameters
idintegerRequired
Responses
200

event found

application/json
get
GET /api/v3/events/{id} HTTP/1.1
Host: api.openapply.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "event": {
    "id": 1,
    "title": "August Open Day",
    "date": "2018-08-28",
    "started_at": "9:30 AM",
    "ended_at": "11:30 AM",
    "capacity": null,
    "limit_per_registration": null,
    "repeatable": false,
    "on_landing_page": true,
    "event_type": "OpenDay",
    "duration": 45,
    "allow_parent_to_cancel": true,
    "cancel_deadline": "no_deadline",
    "updated_at": "2024-11-27T11:32:43.000Z",
    "created_at": "2012-07-20T08:53:33.000Z",
    "registrations": [
      {
        "id": 47,
        "event_id": 1,
        "date": "2016-08-28",
        "time": null,
        "student_ids": [
          8
        ],
        "parent_id": 216,
        "attendees_count": 1,
        "state": "scheduled",
        "note": null,
        "host": "Sharon Arese",
        "campus": "Chatham Campus",
        "created_at": "2015-08-13T09:29:53.000Z",
        "updated_at": "2015-08-13T09:29:53.000Z"
      }
    ],
    "hours": []
  }
}

List event registrations

get
Authorizations
Query parameters
from_datestringOptional
to_datestringOptional
statestringOptional
Responses
200

registrations found

application/json
get
GET /api/v3/events/registrations HTTP/1.1
Host: api.openapply.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
200

registrations found

{
  "registrations": [
    {
      "id": 44,
      "event_id": null,
      "date": "2016-08-20",
      "time": " 10:00 AM",
      "attendees_count": 1,
      "state": "completed",
      "note": "Tour went great!",
      "host": "Sharon Arese",
      "campus": "Chatham Campus",
      "updated_at": "2015-08-13T09:29:52.000Z",
      "created_at": "2013-02-08T17:18:45.000Z"
    },
    {
      "id": 47,
      "event_id": 1,
      "date": "2016-08-28",
      "time": null,
      "attendees_count": 1,
      "state": "scheduled",
      "note": null,
      "host": "Sharon Arese",
      "campus": "Chatham Campus",
      "updated_at": "2015-08-13T09:29:53.000Z",
      "created_at": "2015-08-13T09:29:53.000Z"
    }
  ],
  "meta": {
    "pages": 1,
    "page": 1,
    "per_page": 50
  }
}

Get Attendance Records for an Event

get
Authorizations
Path parameters
idintegerRequired
Query parameters
statestringOptional
campusstringOptional
attendance_statusstringOptional
Responses
200

attendance found

application/json
get
GET /api/v3/events/{id}/attendance HTTP/1.1
Host: api.openapply.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "attendance": [
    {
      "id": 1,
      "status": "attended",
      "created_at": "2015-08-13T09:29:53.000Z",
      "updated_at": "2015-08-13T09:29:53.000Z",
      "student": {
        "id": 8,
        "custom_id": "S12345",
        "serial_number": "SN12345"
      },
      "registration": {
        "id": 1,
        "state": "scheduled",
        "campus": "Chatham Campus",
        "parent": {
          "id": 216
        }
      }
    }
  ]
}
PreviousFilesNextAgents

Was this helpful?