v1

latestOpenAPI 3.0.12026-07-13191560.7 KB
Passages

Get a Passage

Gets a Passage object for a given bibleId and passageId.

A Passage object represents an arbitrary range of verses from the Bible. These ranges are not predefined values, but instead depend on the given input, known as a Passage ID. A Passsage ID consists of two Verse IDs separated by a -. These Verse IDs can span chapters and books, though passages are limited to 200 verses. A few passage examples are:

Verse RangePassage ID
Genesis 1:1 - Genesis 2:3GEN.1.1-GEN.2.3
John 3:1 - John 3:16JHN.3:1-JHN.3.16
1 Corinthians 16:1 - 2 Corinthians 1:231CO.16.1-2CO.1.23

In addition to information about the given passage, this endpoint will also return all verse content included in that passage within the content field.

get/bibles/{bibleId}/passages/{passageId}

Query parameters

content-type'html' | 'json' | 'text'

Determines the structure of returned verse content

include-notesboolean

When true, returns footnotes in verse content

include-titlesboolean

When true, returns section titles in verse content

include-chapter-numbersboolean

When true, returns chapter numbers in verse content

include-verse-numbersboolean

When true, returns verse numbers in verse content

include-verse-spansboolean

When true, returns spans that wrap verse numbers and verse text in content

parallelsstring
Example:78a9f6124f344018-01,a761ca71e0b3ddcf-01

Comma-separated list of Bible IDs. When included, returns parallel verses from the given Bibles

use-org-idboolean

When true, uses the supplied id(s) to match the verse's orgId instead of its id. See More

Response

OK