Search rooms

get

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

Retrieve a list of bookable rooms matching the given filters. Custom fields can also be used as filters; see filtering by custom fields.

Required permission: Full Read Facilities

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Query Params

name

string

Return rooms whose name contains the given text.

description

string

Return rooms whose description contains the given text.

location

string

Comma-delimited list of campus ids. Values come from /api/locations.

category

string

Comma-delimited list of room category ids. Values come from /api/property_values/room_categories/values.

occupancy.start

double

Return rooms that hold at least this many people.

occupancy.end

double

Return rooms that hold at most this many people.

active

boolean

Whether to return active or inactive rooms.

createdBy

string

Return rooms created by a user whose name contains the given text.

filter

string

Full-text search text. Matching rooms are returned ranked by relevance.

skip

int32

≥ 0

The number of records to skip before returning results, used for paging.

limit

int32

≥ 0

The maximum number of records to return per page. Defaults to 50.

sort.property

string

The field to sort the results by. The default field depends on the endpoint.

sort.dir

string

enum

The sort direction: "asc" or "desc".

Allowed:

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.

200OK