Skip to content

TeamLeader (Services)

A leader of a specific Team in a Service Type.

A leader of a specific Team in a Service Type.

Property Value
Product Services (pco.services, API version 2018-11-01)
Resource type TeamLeader
TypeScript Services.TeamLeader, attributes Services.TeamLeaderAttributes, schema Services.TeamLeaderSchema
Planning Center path /services/v2/people/{person_id}/team_leaders
Planning Center docs TeamLeader

How to reach it

Client path Returns Filters Create
pco.services.people.id(personId).team_leaders Collection not_archived, not_deleted No
pco.services.teams.id(teamId).team_leaders Collection No

From a collection, .id(teamLeaderId) addresses one TeamLeader: pco.services.people.id(personId).team_leaders.id(teamLeaderId). Collections support where, include, order, and pagination; single resources have get().

Attributes

On Services.TeamLeaderAttributes. Every resource also has id and type ('TeamLeader') next to its attributes.

Name Type Description
send_responses_for_accepts boolean | null
send_responses_for_blockouts boolean | null
send_responses_for_declines boolean | null

Relationships and includes

Side-load with include() (or get({ include })) and read with related(resource, name): people, team.

Relationship Type To Includable
person To one Person No
team To one Team Yes

Querying

No documented where fields.

Order

order(...) accepts these fields, ascending, or descending with a - prefix: first_name, last_name.

Filters

filter(...) names depend on the edge you query through:

Edge Filters
team_leaders on Person not_archived, not_deleted

Edges

Follow these from one TeamLeader, ref = pco.services.people.id(personId).team_leaders.id(teamLeaderId):

Edge Leads to Returns Filters Create
ref.people Person Collection No
ref.team Team Collection No

Writing

Property Value
Create No
Update No
Delete No

Example

import type { Services } from '@mackenly/planningcenterkit';

const personId = '1'; // Person id

const page = await pco.services.people.id(personId).team_leaders.order('first_name').perPage(25).list();
const items: Services.TeamLeader[] = page.data;

Type to search…

↑↓ navigate↵ selectEsc close