API
⌘K
My Developer Account

PlanTime

A time in a plan.

Example Request

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

View in API Explorer →

Example Object

{
  "type": "PlanTime",
  "id": "1",
  "attributes": {
    "created_at": "2000-01-01T12:00:00Z",
    "ends_at": "2000-01-01T12:00:00Z",
    "live_ends_at": "2000-01-01T12:00:00Z",
    "live_starts_at": "2000-01-01T12:00:00Z",
    "name": "string",
    "recorded": true,
    "starts_at": "2000-01-01T12:00:00Z",
    "team_reminders": [],
    "time_type": "string",
    "updated_at": "2000-01-01T12:00:00Z"
  },
  "relationships": {
    "assigned_teams": {
      "data": [
        {
          "type": "Team",
          "id": "1"
        }
      ]
    },
    "assigned_positions": {
      "data": [
        {
          "type": "TeamPosition",
          "id": "1"
        }
      ]
    }
  }
}

Attributes

Name Type Description
created_at date_time
ends_at date_time Planned end time.
id primary_key
live_ends_at date_time End time as recorded by Services LIVE.
live_starts_at date_time Start time as recorded by Services LIVE.
name string
recorded boolean
starts_at date_time Planned start time.
team_reminders array A Hash that maps a Team ID to a reminder value. If nothing is specified, no reminder is set for that team. A reminder value is an integer (0-7) equal to the number of days before the selected time a reminder should be sent.
time_type string Possible values are: - rehearsal - service - other
updated_at date_time

Relationships

Name Type Association Type Note
assigned_teams Team to_many
assigned_positions TeamPosition to_many

Can Include

Parameter Value Description Assignable
include split_team_rehearsal_assignments include associated split_team_rehearsal_assignments

Order By

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

Query By

Name Parameter Type Description Example
time_type where[time_type] string Query on a specific time_type ?where[time_type]=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/service_types/{service_type_id}/plan_times

Reading

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

Creating

HTTP Method Endpoint Assignable Attributes
POST /services/v2/service_types/{service_type_id}/plans/{plan_id}/plan_times
  • starts_at
  • ends_at
  • name
  • time_type
  • team_reminders

Updating

HTTP Method Endpoint Assignable Attributes
PATCH /services/v2/service_types/{service_type_id}/plan_times/{id}
  • starts_at
  • ends_at
  • name
  • time_type
  • team_reminders

Deleting

HTTP Method Endpoint
DELETE /services/v2/service_types/{service_type_id}/plan_times/{id}

Associations

HTTP Method Endpoint Returns Details Filter By
GET https://api.planningcenteronline.com/services/v2/service_types/{service_type_id}/plan_times/{plan_time_id}/split_team_rehearsal_assignments SplitTeamRehearsalAssignment

Belongs To

HTTP Method Endpoint Association Details Filter By
GET https://api.planningcenteronline.com/services/v2/series/{series_id}/plans/{plan_id}/needed_positions/{needed_position_id}/time NeededPosition
GET https://api.planningcenteronline.com/services/v2/people/{person_id}/plan_people/{plan_person_id}/declined_plan_times PlanPerson
GET https://api.planningcenteronline.com/services/v2/people/{person_id}/plan_people/{plan_person_id}/plan_times PlanPerson
GET https://api.planningcenteronline.com/services/v2/service_types/{service_type_id}/plans/{plan_id}/plan_times Plan
GET https://api.planningcenteronline.com/services/v2/people/{person_id}/schedules/{schedule_id}/declined_plan_times Schedule
GET https://api.planningcenteronline.com/services/v2/people/{person_id}/schedules/{schedule_id}/plan_times Schedule
GET https://api.planningcenteronline.com/services/v2/service_types/{service_type_id}/plan_times ServiceType
  • future
  • named
  • not_deleted
  • past