Search locations

get

https://{tenant}.onechurchsoftware.com/api/locations

Retrieve a list of locations matching the given filters.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Query Params

name

string

Returns locations where the name contains the given search terms.

description

string

Returns locations where the description contains the given text.

type

string

Comma-delimited list of type ids. Use -1 to include locations without a type. Values come from /api/property_values/location_types/values.

active

boolean

Whether the location is active or not. If not provided, returns locations regardless of status.

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:

Response

200OK