SongSchedule - Services API

Example Request

curl https://api.planningcenteronline.com/services/v2/songs/{song_id}/song_schedules

View in API Explorer →

Example Object

{
  "type": "SongSchedule",
  "id": "1",
  "attributes": {
    "arrangement_name": "string",
    "key_name": "string",
    "plan_dates": "string",
    "plan_sort_date": "string",
    "plan_visible": true,
    "service_type_name": "string"
  },
  "relationships": {
    "arrangement": {
      "data": {
        "type": "Arrangement",
        "id": "1"
      }
    },
    "key": {
      "data": {
        "type": "Key",
        "id": "1"
      }
    },
    "plan": {
      "data": {
        "type": "Plan",
        "id": "1"
      }
    },
    "service_type": {
      "data": {
        "type": "ServiceType",
        "id": "1"
      }
    },
    "item": {
      "data": {
        "type": "Item",
        "id": "1"
      }
    }
  }
}

Attributes

Name	Type	Description
`arrangement_name`	`string`
`id`	`primary_key`
`key_name`	`string`
`plan_dates`	`string`
`plan_sort_date`	`string`
`plan_visible`	`boolean`
`service_type_name`	`string`

Relationships

Name	Type	Association Type
arrangement	Arrangement	to_one
key	Key	to_one
plan	Plan	to_one
service_type	ServiceType	to_one
item	Item	to_one

Order By

Parameter	Value	Type	Description
order	plan_sort_date	string	prefix with a hyphen (-plansortdate) 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/songs/{song_id}/song_schedules`

Reading

HTTP Method	Endpoint
GET	`/services/v2/songs/{song_id}/song_schedules/{id}`

Belongs To

HTTP Method	Endpoint	Association	Details	Filter By
GET	`https://api.planningcenteronline.com/services/v2/songs/{song_id}/song_schedules`	Song		`after` Fetch schedules after the included `after` iso8601 date param. e.g. `?filter=after&after=2020-01-01T00:00:00Z` `before` Fetch schedules before the included `before` iso8601 date param. e.g. `?filter=before&before=2020-01-01T00:00:00Z` `most_recent` Fetch the N most recent schedules by also including an `amount` param. e.g. `?filter=most_recent&amount=3` `most_recent_with_upcoming` Fetch the N most recent schedules by also including an `amount` param. Includes upcoming dates. e.g. `?filter=most_recent_with_upcoming&amount=3` `three_most_recent`