Get person relationships

get

https://{tenant}.onechurchsoftware.com/api/people/{id}/relationships

Retrieve the people related to the given person, with the label describing each relationship.

Required permission: Limited Read People

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

int32

required

≥ 1

The id of the person.

Query Params

name

string

Text matched against the related person's names, former names and aliases. When multiple words are given, every word must match.

string

Return relationships whose related person's email address contains the given text.

phone

string

Return relationships whose related person's phone number contains the given digits.

label

string

Comma-delimited list of relationship label ids. Values come from /api/property_values/relationship/values.

campus

string

Comma-delimited list of campus (location) ids matched against the related person. Use -1 to include people with no campus.

type

string

Comma-delimited list of record type ids matched against the related person. Values come from /api/property_values/person_record_type/values. Use -1 to include people with no record type.

notes

string

Return relationships whose comments contain the given text.

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