Search property values

get

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

Retrieve a paged list of property values matching the given filters. When no parent code is given, only the top-level lists are returned.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Query Params

name

string

Only include values whose name contains this text.

description

string

Only include values whose description contains this text.

parent

string

The code of the list whose values to return, e.g. gender, states, countries, languages, speakers. When omitted, only the top-level lists are returned.

active

boolean

Whether the value is active or not.

filter

string

Free text search across the value name and description.

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