planning-center-monorepo / planning-center-people-ts/src / getPeopleByHousehold

Function: getPeopleByHousehold()

getPeopleByHousehold(client, householdId): Promise<{ totalCount: number; pagesFetched: number; duration: number; meta?: Meta; links?: TopLevelLinks; data: FlattenedResource<"Person", PersonAttributes, PersonRelationships, PersonRelationshipMap>[]; }>

Defined in: packages/planning-center-people-ts/src/helpers.ts:651

Get people by household

Parameters

client

PcoClient

householdId

string

Returns

Promise<{ totalCount: number; pagesFetched: number; duration: number; meta?: Meta; links?: TopLevelLinks; data: FlattenedResource<"Person", PersonAttributes, PersonRelationships, PersonRelationshipMap>[]; }>