Team - Services API - Planning Center

Example Request

curl https://api.planningcenteronline.com/services/v2/teams

View in API Explorer →

Example Object

{
  "type": "Team",
  "id": "1",
  "attributes": {
    "archived_at": "2000-01-01T12:00:00Z",
    "assigned_directly": true,
    "created_at": "2000-01-01T12:00:00Z",
    "default_prepare_notifications": true,
    "default_status": "string",
    "deleted_at": "2000-01-01T12:00:00Z",
    "last_plan_from": "string",
    "name": "string",
    "rehearsal_team": true,
    "schedule_to": "string",
    "secure_team": true,
    "sequence": 1,
    "stage_color": "string",
    "stage_variant": "string",
    "updated_at": "2000-01-01T12:00:00Z",
    "viewers_see": 1
  },
  "relationships": {
    "service_type": {
      "data": {
        "type": "ServiceType",
        "id": "1"
      }
    },
    "default_responds_to": {
      "data": {
        "type": "Person",
        "id": "1"
      }
    },
    "service_types": {
      "data": [
        {
          "type": "ServiceType",
          "id": "1"
        }
      ]
    }
  }
}

Attributes

Name	Type	Description
`archived_at`	`date_time`
`assigned_directly`	`boolean`
`created_at`	`date_time`
`default_prepare_notifications`	`boolean`
`default_status`	`string`
`deleted_at`	`date_time`
`id`	`primary_key`
`last_plan_from`	`string`
`name`	`string`
`rehearsal_team`	`boolean`
`schedule_to`	`string`	This determines whether a team is a split team or not.Accepted values: 1. "plan" (default) 2. "time" (designates as a split team)
`secure_team`	`boolean`
`sequence`	`integer`
`stage_color`	`string`
`stage_variant`	`string`
`updated_at`	`date_time`
`viewers_see`	`integer`

Relationships

Name	Type	Association Type	Note
service_type	ServiceType	to_one
default_responds_to	Person	to_one	A relationship with id 0 will be returned when "All Team Leaders" is the default.
service_types	ServiceType	to_many

Can Include

Parameter	Value	Description	Assignable
include	people	include associated people
include	person_team_position_assignments	include associated person_team_position_assignments
include	service_types	include associated service_types	create and update
include	team_leaders	include associated team_leaders
include	team_positions	include associated team_positions

Order By

Parameter	Value	Type	Description
order	created_at	string	prefix with a hyphen (-created_at) to reverse the order
order	name	string	prefix with a hyphen (-name) to reverse the order
order	updated_at	string	prefix with a hyphen (-updated_at) to reverse the order

Query By

Name	Parameter	Type	Description	Example
name	`where[name]`	string	Query on a specific name	`?where[name]=string`

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/teams`

Reading

HTTP Method	Endpoint
GET	`/services/v2/teams/{id}`

Creating

HTTP Method	Endpoint	Assignable Attributes
POST	`/services/v2/service_types/{service_type_id}/teams`	name archived_at assigned_directly deleted_at rehearsal_team secure_team schedule_to stage_color stage_variant service_type_ids

Associations

HTTP Method	Endpoint	Returns
GET	`https://api.planningcenteronline.com/services/v2/teams/{team_id}/people`	Person
GET	`https://api.planningcenteronline.com/services/v2/teams/{team_id}/person_team_position_assignments`	PersonTeamPositionAssignment
GET	`https://api.planningcenteronline.com/services/v2/teams/{team_id}/service_types`	ServiceType
GET	`https://api.planningcenteronline.com/services/v2/teams/{team_id}/team_leaders`	TeamLeader
GET	`https://api.planningcenteronline.com/services/v2/teams/{team_id}/team_positions`	TeamPosition

Belongs To

HTTP Method	Endpoint	Association	Filter By
GET	`https://api.planningcenteronline.com/services/v2/series/{series_id}/plans/{plan_id}/needed_positions/{needed_position_id}/team`	NeededPosition
GET	`https://api.planningcenteronline.com/services/v2/teams`	Organization	`editable` `service_types`
GET	`https://api.planningcenteronline.com/services/v2/people/{person_id}/plan_people/{plan_person_id}/team`	PlanPerson
GET	`https://api.planningcenteronline.com/services/v2/service_types/{service_type_id}/plans/{plan_id}/signup_teams`	Plan
GET	`https://api.planningcenteronline.com/services/v2/people/{person_id}/schedules/{schedule_id}/team`	Schedule
GET	`https://api.planningcenteronline.com/services/v2/service_types/{service_type_id}/teams`	ServiceType
GET	`https://api.planningcenteronline.com/services/v2/service_types/{service_type_id}/plan_times/{plan_time_id}/split_team_rehearsal_assignments/{split_team_rehearsal_assignment_id}/team`	SplitTeamRehearsalAssignment
GET	`https://api.planningcenteronline.com/services/v2/people/{person_id}/team_leaders/{team_leader_id}/team`	TeamLeader
GET	`https://api.planningcenteronline.com/services/v2/service_types/{service_type_id}/team_positions/{team_position_id}/team`	TeamPosition