Get individuals

get

https://api.ccbchurch.com/individuals

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Query Params

name

string

Partial search of names, phone numbers, and email addresses

include_inactive

boolean

Include inactive individuals in the results

exclude_limited_access_user

boolean

Defaults to false

Exclude limited access users in the results

include_deceased

boolean

Defaults to false

Include deceased individuals in the results. When true, the response will include a deceased date field for matching individuals.

include_unlisted

boolean

Defaults to false

Whether or not to include unlisted individuals in the results. Not available to all users.

campus_scope

string

enum

Defaults to all

Filter individuals by campus scope. all returns individuals from all campuses, current returns only individuals at the caller's campus, other returns individuals at campuses other than the caller's.

Allowed:

per_page

integer

enum

Defaults to 25

The size of a page

Allowed:

page

integer

Defaults to 1

The page number to return

Responses

401

You are not authenticated

403

Do not have the permission to access

412

The request failed validation

200List of Individuals