API
⌘K
My Developer Account

NeededPosition

An amount of unfilled positions needed within a team in a plan.

Example Request

curl https://api.planningcenteronline.com/services/v2/series/{series_id}/plans/{plan_id}/needed_positions

View in API Explorer →

Example Object

{
  "type": "NeededPosition",
  "id": "1",
  "attributes": {
    "quantity": 1,
    "scheduled_to": "string",
    "team_position_name": "string"
  },
  "relationships": {
    "team": {
      "data": {
        "type": "Team",
        "id": "1"
      }
    },
    "plan": {
      "data": {
        "type": "Plan",
        "id": "1"
      }
    },
    "time": {
      "data": {
        "type": "PlanTime",
        "id": "1"
      }
    },
    "time_preference_option": {
      "data": {
        "type": "TimePreferenceOption",
        "id": "1"
      }
    }
  }
}

Attributes

Name Type Description
id primary_key
quantity integer
scheduled_to string
team_position_name string

Relationships

Name Type Association Type Note
team Team to_one
plan Plan to_one
time PlanTime to_one
time_preference_option TimePreferenceOption to_one

Can Include

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

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/series/{series_id}/plans/{plan_id}/needed_positions

Reading

HTTP Method Endpoint
GET /services/v2/series/{series_id}/plans/{plan_id}/needed_positions/{id}

Creating

HTTP Method Endpoint Assignable Attributes
POST /services/v2/service_types/{service_type_id}/plans/{plan_id}/needed_positions
  • quantity
  • time_id
  • time_preference_option_id

Updating

HTTP Method Endpoint Assignable Attributes
PATCH /services/v2/series/{series_id}/plans/{plan_id}/needed_positions/{id}
  • quantity

Deleting

HTTP Method Endpoint
DELETE /services/v2/series/{series_id}/plans/{plan_id}/needed_positions/{id}

Associations

HTTP Method Endpoint Returns Details Filter By
GET https://api.planningcenteronline.com/services/v2/series/{series_id}/plans/{plan_id}/needed_positions/{needed_position_id}/team Team
GET https://api.planningcenteronline.com/services/v2/series/{series_id}/plans/{plan_id}/needed_positions/{needed_position_id}/time PlanTime

Belongs To

HTTP Method Endpoint Association Details Filter By
GET https://api.planningcenteronline.com/services/v2/service_types/{service_type_id}/plans/{plan_id}/needed_positions Plan