songs/arrangements/getAll

Get a list of arrangements within a song. The fields listed here will be returned when this method is called.

POST
https://api.elvanto.com/v1/songs/arrangements/getAll.{json|xml|php}

Parameters

Name Type Description
page integer The results page to retrieve. Default: 1
page_size integer The number of records to retrieve per results page. Default: 1000
song_id Required string The ID of the song to find arrangements for.
chord_chart_key string This will transpose the chord chart into the specified key, if chord charts are included with your lyrics.
files boolean Return attached files.
Expected request JSON HTTP POST
{
    "page": 1,
    "page_size": 100,
    "song_id": "84937df8-e993-11e2-b739-a20c5589acc5",
    "chord_chart_key": "F#",
    "files": true
}
Expected response JSON XML PHP
{
    "generated_in": "0.021",
    "status": "ok",
    "arrangements": {
        "on_this_page": 100,
        "page": 1,
        "per_page": 100,
        "total": 668,
        "arrangement": [
            {
                "id": "48377df8-e993-11e2-b739-a20c5589acc5",
                "date_added": "2024-02-24 11:56:22",
                "date_modified": "2024-08-27 16:17:57",
                "name": "Default Arrangement",
                "copyright": "2012 Hillsong Music Publishing",
                "sequence": [
                    "Verse 1",
                    "Verse 2",
                    "Chorus 1",
                    "Verse 3",
                    "Misc 1"
                ],
                "minutes": "5",
                "seconds": "0",
                "bpm": "74",
                "key_male": "",
                "key_female": "",
                "lyrics": "Verse 1\nI have this hope\nAs an anchor for my soul\nThrough every storm\nI will hold to You\n\nVerse 2\nWith endless love\nAll my fear is swept away\nIn everything\nI will trust in You\n\nChorus\nThere is hope in the promise of the cross\nYou gave everything to save the world You love\nAnd this hope is an anchor for my soul\nOur God will stand unshakable",
                "chord_chart_key": "A#",
                "chord_chart": "Verse 1\nI have this [Gm]hope\nAs an anchor for [A#]my soul\nThrough every[F] storm\nI will hold [D#]to You\n\nVerse 2\nWith endless [Gm]love\nAll my fear is swept a[A#]way\nIn every[F]thing\nI will trust [Gm]in You\n\nChorus\nThere is [D#]hope in the promise of [A#]the cross\nYou gave every[Cm7]thing to [Gm7]save the world [F]You love\nAnd this [D#]hope is an anchor for [Gm]my soul\nOur God [F]will stand unshak[D#]able [Gm] [A#]"
            }
        ]
    }
}
Error responses

Please see our response status codes documentation for details of potential error responses for any API request.

  • 250: Invalid page number The page number you have provided is invalid.
  • 250: Invalid page size The page size must be between 10 and 1000.
  • 401: No Song ID provided You need to specify the ID of the song.
  • 404: No arrangements match your criteria The system could not find any arrangements based on your criteria.
  • 401: Invalid chord_chart_key parameter You entered an invalid chord chart.