Search users

get

https://{tenant}.onechurchsoftware.com/api/people/users

Retrieve a list of people who can sign in to the system. Requires permission to assign permissions.

Custom field filters are also supported as dynamic query parameters: pass the field id as the parameter name (e.g. ?123=value). See filtering by custom fields for how custom field parameters work.

Required permission: Permissions Limited

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Query Params

key

int32

≥ 1

Filter to the person with this id.

name

string

Filter by name. Each word must match part of the user's first name, last name, or nickname.

username

string

Filter by username (contains).

string

Filter by email address (contains). Only applied when the caller has permission to view people.

phone

string

Filter by phone number (contains). Only applied when the caller has permission to view people.

campusAttended

string

Comma-delimited list of campus ids. Filters by the user's primary campus.

accounts

string

Comma-delimited list of linked sign-in account types: local, google, microsoft.

access

string

Comma-delimited list of access levels: 1 = super user, 2 = guest, 3 = custom, 4 = role-based.

permission

string

Comma-delimited list of permission ids. Matches users granted any of the permissions, directly or through a role. Values come from /api/security/permissions.

role

string

Comma-delimited list of role ids. Matches users with any of the roles. Use -1 to also match users with no roles.

date-time

Return users who last signed in on or after this date.

date-time

Return users who last signed in on or before this date.

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

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