Search connections

get

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

Retrieve a list of connections matching the given filters. Also supports filtering by custom fields.

Required permission: Full Read Connections

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Query Params

status

string

Comma-delimited list of connection status ids. Values come from /api/property_values/connection_statuses/values.

type

string

Comma-delimited list of connection type ids. Values come from /api/property_values/connection_types/values.

person

int32

≥ 1

The id of the person the connection is about.

name

string

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

string

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

phone

string

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

assignee

int32

≥ 1

The id of the person the connection is assigned to.

assigneeName

string

Text matched against the assignee's name and aliases. When multiple words are given, every word must match.

age.start

double

Return connections for people at least this old.

age.end

double

Return connections for people at most this old.

gender

string

Comma-delimited list of gender ids matched against the person. Use -1 to include people with no gender.

maritalStatus

string

Comma-delimited list of marital status ids matched against the person. Use -1 to include people with no marital status.

birthday.month

int32

Match dates falling in this month (1-12).

birthday.day

int32

Match dates falling on this day of the month (1-31).

birthday.year

int32

Match dates falling in this year.

birthday.start

date-time

Match dates falling within a window starting at this date.

birthday.end

date-time

Match dates falling within a window ending at this date.

family.start

double

Return connections whose person's family id is at least this value.

family.end

double

Return connections whose person's family id is at most this value.

campus

string

Comma-delimited list of campus (location) ids. Use -1 to include connections with no campus.

date.start

date-time

Return connections dated on or after this date.

date.end

date-time

Return connections dated on or before this date.

due.start

date-time

Return connections due on or after this date.

due.end

date-time

Return connections due on or before this date.

completed.start

date-time

Return connections completed on or after this date.

completed.end

date-time

Return connections completed on or before this date.

notes

string

Return connections whose initial notes contain the given text.

outcome

string

Return connections whose outcome notes contain the given text.

createdBy

string

Return connections created by the given user name.

code

string

Return the connection with the given code (exact match).

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.

Language

Credentials

Header

URL

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

text/plain

application/json

text/json

200OK