Skip to content

Instantly share code, notes, and snippets.

@Tschrock
Last active April 11, 2020 01:57
Show Gist options
  • Save Tschrock/c1e67278f9aaa3750feeba241e10e5c9 to your computer and use it in GitHub Desktop.
Save Tschrock/c1e67278f9aaa3750feeba241e10e5c9 to your computer and use it in GitHub Desktop.
API notes for the Church Online Platform (*.churchonline.com)

EDIT: Moved to https://newpointe.github.io/churchonline-api-docs


/api/v1/upcoming_event_times

Gets the times of upcomming events

{  
   "meta":{  
      "status":200
   },
   "response":{  
      "count":2,
      "items":[  
         {  
            "eventTimeId": 123456,
            "eventId": 78910,
            "eventTime": "2017-05-14T13:00:00.000Z",
            "eventEndTime": "2017-05-14T14:47:00.000Z",
            "eventTitle": "Title of Event",
            "eventTimeDoorsOpenOffset": 10
         },
         {  
            "eventTimeId": 654321,
            "eventId": 78910,
            "eventTime": "2017-05-14T15:00:00.000Z",
            "eventEndTime": "2017-05-14T16:47:00.000Z",
            "eventTitle": "Title of Event",
            "eventTimeDoorsOpenOffset": 10
         }
      ]
   }
}

/api/v1/events

Gets a list of all events

{  
   "meta": {  
      "status": 200
   },
   "response": {  
      "count": 1,
      "items": [  
         {  
            "id": 1111,
            "organizationId": 222,
            "description": "Description of the event",
            "duration": 60,
            "enabled": false,
            "speaker": "",
            "title": "Event Title",
            "vrSimulated": null,
            "sphericalVideo": null,
            "eventNotes": "Notes for the event. <b>Wooo!</b>",
            "volunteerNotes": "",
            "facebookMessage": "",
            "twitterMessage": "",
            "emailMessage": "",
            "socialLink": "",
            "slidesPaused": false,
            "enabledFeatures": [  
               "chat",
               "notes"
            ],
            "customTab":{  
               "id": 3333,
               "title": "Tab Title",
               "content": "",
               "sort_order": null,
               "visible": true,
               "permanent": false,
               "created_at": "2014-11-05T19:04:38.534Z",
               "updated_at": "2014-11-14T16:07:14.469Z",
               "organization_id": 222
            },
            "videoProfileStatus": "default"
         }
      ]
   }
}

/api/v1/events/current

Gets if an event is live and when the next one will begin

{
    "meta": {
        "status": 200
    },
    "response": {
        "item": {
            "isLive": false,
            "eventStartTime": "2017-05-14T13:00:00Z"
        }
    }
}

/api/v1/events/{EventId}

Gets the details for an event

{  
   "meta":{  
      "status":200
   },
   "response":{  
      "id": 11111,
      "organizationId": 222,
      "description": "Event Description",
      "duration": 100,
      "enabled": true,
      "speaker": "Event Speaker",
      "title": "Event Title",
      "vrSimulated": null,
      "sphericalVideo": null,
      "eventNotes": "Event Notes!",
      "volunteerNotes": "",
      "facebookMessage": null,
      "twitterMessage": null,
      "emailMessage": null,
      "socialLink": null,
      "slidesPaused": false,
      "enabledFeatures": [  
         "chat",
         "notes"
      ],
      "customTab":{  
         "id": 3333,
         "title": "Tab Title",
         "content": "Tab html content.",
         "sort_order": null,
         "visible": true,
         "permanent": false,
         "created_at": "2014-11-05T19:04:38.534Z",
         "updated_at": "2014-11-14T16:07:14.469Z",
         "organization_id": 222
      },
      "videoProfileStatus": "default"
   }
}

GET /api/v1/events/{EventId}/event_videos

GET /api/v1/events/{EventId}/event_slides

GET /api/v1/channels?event_time={EventTimeId}&token={AccessToken}

GET /api/v1/channels/{Token}

GET /api/v1/channels/{Token}/history

PUT /api/v1/channels/identity/{Token}

POST /api/v1/channels/{Token}/publish

POST /api/v1/channels/{Token}/control

POST /api/v1/channels/push_slide_action

POST /api/v1/channels/push_slide/{SlideId}

PUT /api/v1/live_responses/leave

POST /api/v1/live_responses/transfer

PUT /api/v1/live_responses/acknowledge

GET /api/v1/live_responses/pending_requests

POST /api/v1/users/facebook_login

POST /api/v1/users

POST /api/v1/users/reset_password

PUT /api/v1/users/{Id}

DELETE /api/v1/users/{Id}/destroy_avatar

POST /api/v1/sessions

POST /api/v1/direct_responses/decline

POST /api/v1/reminders/email

POST /api/v1/reminders/sms

POST /api/v1/prayer_requests

POST /api/v1/social/share/twitter

POST /api/v1/polls/vote/{EventTimeId}/{SlideId}

GET /api/v1/polls/{EventTimeId}/{SlideId}

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment