TeamPosition - Services API

Example Request

curl https://api.planningcenteronline.com/services/v2/service_types/{service_type_id}/team_positions

View in API Explorer →

Example Object

{
  "type": "TeamPosition",
  "id": "1",
  "attributes": {
    "name": "string",
    "negative_tag_groups": [],
    "sequence": 1,
    "tag_groups": [],
    "tags": []
  },
  "relationships": {
    "team": {
      "data": {
        "type": "Team",
        "id": "1"
      }
    },
    "attachment_types": {
      "data": [
        {
          "type": "AttachmentType",
          "id": "1"
        }
      ]
    },
    "tags": {
      "data": [
        {
          "type": "Tag",
          "id": "1"
        }
      ]
    }
  }
}

Attributes

Name	Type	Description
`id`	`primary_key`
`name`	`string`
`negative_tag_groups`	`array`	If the Team is assigned via tags, these are Tags where the option "None" is specified.
`sequence`	`integer`
`tag_groups`	`array`	If the Team is assigned via tags, these are Tags where the option "Any" is specified.
`tags`	`array`	If the Team is assigned via tags, these are specific Tags that are specified.

Relationships

Name	Type	Association Type
team	Team	to_one
attachment_types	AttachmentType	to_many
tags	Tag	to_many

Can Include

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

Order By

Parameter	Value	Type	Description
order	name	string	prefix with a hyphen (-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/service_types/{service_type_id}/team_positions`

Reading

HTTP Method	Endpoint
GET	`/services/v2/service_types/{service_type_id}/team_positions/{id}`

Associations

HTTP Method	Endpoint	Returns	Filter By
GET	`https://api.planningcenteronline.com/services/v2/service_types/{service_type_id}/team_positions/{team_position_id}/person_team_position_assignments`	PersonTeamPositionAssignment	`time_preference_options` pass an additional array of `time_preference_option_ids` as a param to filter to people who prefer those times. use id `none` to filter people who have no preferred times
GET	`https://api.planningcenteronline.com/services/v2/service_types/{service_type_id}/team_positions/{team_position_id}/tags`	Tag
GET	`https://api.planningcenteronline.com/services/v2/service_types/{service_type_id}/team_positions/{team_position_id}/team`	Team

Belongs To

HTTP Method	Endpoint	Association
GET	`https://api.planningcenteronline.com/services/v2/service_types/{service_type_id}/team_positions/{team_position_id}/person_team_position_assignments/{person_team_position_assignment_id}/team_position`	PersonTeamPositionAssignment
GET	`https://api.planningcenteronline.com/services/v2/service_types/{service_type_id}/team_positions`	ServiceType
GET	`https://api.planningcenteronline.com/services/v2/teams/{team_id}/team_positions`	Team