TeamLeader - Services API - Planning Center

Example Request

curl https://api.planningcenteronline.com/services/v2/people/{person_id}/team_leaders

View in API Explorer →

Example Object

{
  "type": "TeamLeader",
  "id": "1",
  "attributes": {
    "send_responses_for_accepts": true,
    "send_responses_for_blockouts": true,
    "send_responses_for_declines": true
  },
  "relationships": {
    "person": {
      "data": {
        "type": "Person",
        "id": "1"
      }
    },
    "team": {
      "data": {
        "type": "Team",
        "id": "1"
      }
    }
  }
}

Attributes

Name	Type	Description
`id`	`primary_key`
`send_responses_for_accepts`	`boolean`
`send_responses_for_blockouts`	`boolean`
`send_responses_for_declines`	`boolean`

Relationships

Name	Type	Association Type	Note
person	Person	to_one
team	Team	to_one

Can Include

Parameter	Value	Description	Assignable
include	people	include associated people
include	team	include associated team	create and update

Order By

Parameter	Value	Type	Description
order	first_name	string	prefix with a hyphen (-first_name) to reverse the order
order	last_name	string	prefix with a hyphen (-last_name) to reverse the order

Pagination

Name	Parameter	Type	Description
per_page	per_page	integer	how many records to return per page (min=1, max=100, default=25)
offset	offset	integer	get results from given offset

Endpoints

Listing

HTTP Method	Endpoint
GET	`/services/v2/people/{person_id}/team_leaders`

Reading

HTTP Method	Endpoint
GET	`/services/v2/people/{person_id}/team_leaders/{id}`

Associations

HTTP Method	Endpoint	Returns	Details	Filter By
GET	`https://api.planningcenteronline.com/services/v2/people/{person_id}/team_leaders/{team_leader_id}/people`	Person
GET	`https://api.planningcenteronline.com/services/v2/people/{person_id}/team_leaders/{team_leader_id}/team`	Team

Belongs To

HTTP Method	Endpoint	Association	Details	Filter By
GET	`https://api.planningcenteronline.com/services/v2/people/{person_id}/team_leaders`	Person		`not_archived` `not_deleted`
GET	`https://api.planningcenteronline.com/services/v2/teams/{team_id}/team_leaders`	Team