API Reference
  1. One Church Software API
  2. Facilities

Get room usage

get
https://{tenant}.onechurchsoftware.com/api/facilities/rooms/usage

Retrieve the approved and pending room bookings in the given date window, optionally including blockout dates.

Required permission: Full Read Facilities

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params
date-time
required

The earliest date to retrieve usage for.

date-time
required

The latest date to retrieve usage for.

string

Comma-delimited list of room ids to return usage for. Values come from /api/facilities/rooms.

string

Comma-delimited list of campus ids to return usage for. Values come from /api/locations.

boolean

Whether to include blockout dates in the results.

string

Set to event to label each entry with its event's name instead of the room's name.

Headers
string
enum
Defaults to application/json

Generated from available response content types

Allowed:
Responses

401

Authentication is required, or the Ocs-Api-Key header is missing or invalid.

Updated about 2 months ago

Did this page help you?
Language
Credentials
Header
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
text/plain
application/json
text/json

Updated about 2 months ago

Did this page help you?