API Reference
  1. One Church Software API
  2. Families

Search families

get
https://{tenant}.onechurchsoftware.com/api/families

Retrieve a list of families matching the given filters, including each family's members and shared contact details. Member contact details respect each person's privacy settings.

Required permission: People Directory

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params
string

Filter by family name.

boolean

When false, only families with at least one active (non-archived) member; when true, only families whose members are all archived.

string

Match families whose name contains every given word.

int32
≥ 0

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

int32
≥ 0

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

string

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

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.

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?