ArrangementSections - Services API

Example Request

curl https://api.planningcenteronline.com/services/v2/songs/{song_id}/arrangements/{arrangement_id}/sections

View in API Explorer →

Example Object

{
  "type": "ArrangementSections",
  "id": "1",
  "attributes": {
    "sections": []
  },
  "relationships": {}
}

Attributes

Name Type Description

id primary_key

Name	Type	Description
`id`	`primary_key`
`sections`	`array`	Given an arrangement with the folowing `chord_chart`: `VERSE 1 D Bm G D Be thou my vision O Lord of my heart A Bm G A naught be all else to me save that Thou art` The value will be: `[ { "label": "Verse", "lyrics": "Be thou my vision O Lord of my heart naught be all else to me save that Thou art", "breaks_at": null } ]`

sections

array

Given an arrangement with the folowing chord_chart:

VERSE 1
D          Bm       G          D
Be thou my vision O Lord of my heart
A             Bm         G              A
naught be all else to me save that Thou art

The value will be:

[
  {
    "label": "Verse",
    "lyrics": "Be thou my vision O Lord of my heart

naught be all else to me save that Thou art",
    "breaks_at": null
  }
]

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}/arrangements/{arrangement_id}/sections`

Reading

HTTP Method	Endpoint
GET	`/services/v2/songs/{song_id}/arrangements/{arrangement_id}/sections/{id}`

Belongs To

HTTP Method	Endpoint	Association	Details	Filter By
GET	`https://api.planningcenteronline.com/services/v2/songs/{song_id}/arrangements/{arrangement_id}/sections`	Arrangement