Transformers

Schemas

Bible

id

integer · readOnly

Bible version identifier

Example: 111

abbreviation

string · readOnly

Bible version abbreviation

Example: NIV

promotional_content

string · readOnly

Longer form of copyright text provided by the publisher for the given Bible version.

Example: "Biblica is the worldwide publisher and translation sponsor of the New International Version—one of the most widely read contemporary English versions of the Bible. At Biblica, we believe that with God, all things are possible. Partnering with other ministries and people like you, we are reaching the world with God’s Word, providing Bibles that are easier to understand and faster to receive. When God’s Word is put into someone’s hands, it has the power to change everything. To learn more, visit <a href="https://www.biblica.com/privacy-policy/">biblica.com</a> and <a href="http://facebook.com/Biblica">facebook.com/Biblica</a>. "

copyright

string · readOnly

Short version of the copyright text provided by the publisher for the given Bible version.

info

string · readOnly

Additional information about the Bible text version. This is commonly displayed in the reader footer for the Bible.

Example: The Holy Bible

publisher_url

string · readOnly

URL to link to publisher page from the reader's footer

Example: https://www.biblica.com/yv-learn-more/

language_tag

string · readOnly

BCP47 canonical language tag for this Bible version

Example: en

localized_abbreviation

string · readOnly

Localized Bible version abbreviation

Example: NIV

localized_title

string · readOnly

Localized title of Bible version

Example: New International Version

title

string · readOnly

English title of Bible version

Example: New International Version 2011

books

string[] · readOnly

youversion_deep_link

string · readOnly

A deep link to this Bible version inside YouVersion

Example: https://www.bible.com/versions/111

organization_id

string | null · uuid

BibleIndex

text_direction

string

object[]

Bibles

object[] · readOnly · required

next_page_token

string · readOnly

Token to send to server when retrieving the next page of results.

Example: eyJzdGFydF9hdCI6IDI2fQ==

total_size

integer · int32

Total number of bibles in collection matching parameters.

Example: 42

Book

id

string

Book identifier

Example: GEN

title

string

Book title

Example: Genesis

full_title

string

Full book title if available

Example: The Book of Genesis

abbreviation

string

Book name abbreviation if provided by the publisher

Example: Gen.

canon

string · enum

Canon identifier

Enum values:

new_testament

old_testament

deuterocanon

Example: old_testament

object[]

Chapters in the book

intro

object | null

Books

object[] · readOnly · required

Chapter

id

string

Chapter identifier

Example: 1

passage_id

string

Passage identifier

Example: GEN.1

title

string

Chapter title

Example: 1

object[]

Verses in the chapter

Chapters

object[] · readOnly · required

Error

message

string · required

Error message

Highlight

bible_id

integer · int32 · required

Bible version identifier

Example: 111

passage_id

string · required

The passage identifier (verse USFM format)

Example: MAT.1.1

color

string · pattern: ^[0-9a-f]{6}$ · required

The highlight color in hex format

Example: 44aa44

Highlights

object[] · readOnly

Language

Region-agnostic language resource keyed by canonical BCP 47 language or language+script. Variants and a simple extensions indicator are included for completeness, but regions and full extension data are excluded.

id

string · pattern: ^[a-z]{2,3}(?:-[A-Z]… · required

Canonical BCP 47 id limited to language or language+script. Region, variants, and extensions are not allowed.

Example: en

language

string · pattern: ^[a-z]{2,3}$ · required

ISO 639 canonical language subtag

Example: sr

script

string | null · pattern: ^[A-Z][a-z]{3}$

ISO 15924 script code if present in id

Example: Latn

script_name

string | null

The English name for the script

Example: Latin

aliases

string[]

Deprecated or legacy subtags mapped during canonicalization for this language.

Example: []

object

Localized display names for the language/script combination

scripts

string[]

All scripts known for this language (CLDR/ISO-15924)

Example: ["Cyrl","Latn"]

variants

string[]

Variants associated with this language (not part of the id)

Example: ["1996","fonipa"]

countries

string[]

Ids of countries where this language is used or supported. Extended details can be retrieved from the countries API with the provided id.

Example: ["RS","BA","ME"]

text_direction

string · enum

Default text direction for this language. ltr is left to right and rtl is right to left.

Enum values:

ltr

rtl

Example: rtl

writing_population

integer · int32

Estimated number of souls that write in this language.

Example: 1327104050

speaking_population

integer · int32

Estimated number of souls that speak in this language.

Example: 1636485840

default_bible_id

integer · int32

The chosen default Bible version for this language.

Example: 111

Languages

object[] · readOnly · required

next_page_token

string · readOnly

Token to send to server when retrieving the next page of results.

Example: eyJzdGFydF9hdCI6IDI2fQ==

total_size

integer · int32

Total number of languages in collection matching parameters.

Example: 6000

License

id

integer

name

string

version

integer

organization_id

string · uuid

The YouVersion Organization ID that owns this license.

html

string

HTML representation of the license terms.

bible_ids

integer[]

uri

string | null · uri

URI pointing to the license terms.

agreed_dt

string · date-time

The date which the developer id passed agreed to this license or null if not agreed to

yvp_user_id

string · uuid

The YouVersion Platform User id that was logged into the dev portal and agreed to the license

Licenses

object[] · readOnly · required

Organization

The Organization Resource in the Platform.

id

string · uuid · required

The unique identifier of the organization in the Platform.

Example: 550e8400-e29b-41d4-a716-446655440000

parent_organization_id

string | null · uuid

The id of the parent organization if one exists.

Example: 550e8400-e29b-41d4-a716-446655440000

name

string

Publisher's name in the language negotiated by Accept-Language headers. If none match known translations, then the primary language of the publisher is used. Whichever language is chosen will be sent back in the Content-Language header.

Example: Biblica, Inc.

description

string

Description of the organization. It's purpose and goals, values and mission, etc.

Example: This is a lorem ipsum description of the organization and its purpose and goals and what it does and what it does not do.

email

string | null

The contact email address for the organization if provided.

phone

string | null

The contact phone number for the organization if provided.

primary_language

string

The primary language of the organization.

Example: en

website_url

string

The web site for the organization.

Example: https://www.biblica.com

object

The Address Schema belonging to the Organization Resource in the Platform.

Organizations

object[] · readOnly · required

next_page_token

string · readOnly

Token to send to server when retrieving the next page of results.

Example: eyJzdGFydF9hdCI6IDI2fQ==

Passage

id

string · readOnly

A canonical representation of the passage returned

Example: MAT.1.1

content

string · readOnly

The Bible text of the requested passage in either text or html format.

Example: The book of the genealogy of Jesus Christ, the son of David, the son of Abraham.

reference

string · readOnly

A human-readable reference

Example: Matthew 1:1

Ping

down

string[]

List of unavailable services.

Example: []

up

string[]

List of available services.

Example: []

Verse

id

string

Verse identifier

Example: 1

passage_id

string

Passage identifier

Example: GEN.1.1

title

string

Verse title

Example: 1

Verses

object[] · readOnly · required

VerseOfTheDay

day

integer · min: 1 · max: 366 · required

passage_id

string · required

The passage identifier

Example: JHN.3.16

VerseOfTheDays

object[] · required

Bible

id

integer · readOnly

Bible version identifier

Example: 111

abbreviation

string · readOnly

Bible version abbreviation

Example: NIV

promotional_content

string · readOnly

Longer form of copyright text provided by the publisher for the given Bible version.

copyright

string · readOnly

Short version of the copyright text provided by the publisher for the given Bible version.

info

string · readOnly

Additional information about the Bible text version. This is commonly displayed in the reader footer for the Bible.

Example: The Holy Bible

publisher_url

string · readOnly

URL to link to publisher page from the reader's footer

Example: https://www.biblica.com/yv-learn-more/

language_tag

string · readOnly

BCP47 canonical language tag for this Bible version

Example: en

localized_abbreviation

string · readOnly

Localized Bible version abbreviation

Example: NIV

localized_title

string · readOnly

Localized title of Bible version

Example: New International Version

title

string · readOnly

English title of Bible version

Example: New International Version 2011

books

string[] · readOnly

youversion_deep_link

string · readOnly

A deep link to this Bible version inside YouVersion

Example: https://www.bible.com/versions/111

organization_id

string | null · uuid

Book

id

string

Book identifier

Example: GEN

title

string

Book title

Example: Genesis

full_title

string

Full book title if available

Example: The Book of Genesis

abbreviation

string

Book name abbreviation if provided by the publisher

Example: Gen.

canon

string · enum

Canon identifier

Enum values:

new_testament

old_testament

deuterocanon

Example: old_testament

object[]

Chapters in the book

intro

object | null

Language

id

string · pattern: ^[a-z]{2,3}(?:-[A-Z]… · required

Canonical BCP 47 id limited to language or language+script. Region, variants, and extensions are not allowed.

Example: en

language

string · pattern: ^[a-z]{2,3}$ · required

ISO 639 canonical language subtag

Example: sr

script

string | null · pattern: ^[A-Z][a-z]{3}$

ISO 15924 script code if present in id

Example: Latn

script_name

string | null

The English name for the script

Example: Latin

aliases

string[]

Deprecated or legacy subtags mapped during canonicalization for this language.

Example: []

object

Localized display names for the language/script combination

scripts

string[]

All scripts known for this language (CLDR/ISO-15924)

Example: ["Cyrl","Latn"]

variants

string[]

Variants associated with this language (not part of the id)

Example: ["1996","fonipa"]

countries

string[]

Ids of countries where this language is used or supported. Extended details can be retrieved from the countries API with the provided id.

Example: ["RS","BA","ME"]

text_direction

string · enum

Default text direction for this language. ltr is left to right and rtl is right to left.

Enum values:

ltr

rtl

Example: rtl

writing_population

integer · int32

Estimated number of souls that write in this language.

Example: 1327104050

speaking_population

integer · int32

Estimated number of souls that speak in this language.

Example: 1636485840

default_bible_id

integer · int32

The chosen default Bible version for this language.

Example: 111

License

id

integer

name

string

version

integer

organization_id

string · uuid

The YouVersion Organization ID that owns this license.

html

string

HTML representation of the license terms.

bible_ids

integer[]

uri

string | null · uri

URI pointing to the license terms.

agreed_dt

string · date-time

The date which the developer id passed agreed to this license or null if not agreed to

yvp_user_id

string · uuid

The YouVersion Platform User id that was logged into the dev portal and agreed to the license

Organization

The Organization Resource in the Platform.

id

string · uuid · required

The unique identifier of the organization in the Platform.

Example: 550e8400-e29b-41d4-a716-446655440000

parent_organization_id

string | null · uuid

The id of the parent organization if one exists.

Example: 550e8400-e29b-41d4-a716-446655440000

name

string

Example: Biblica, Inc.

description

string

Description of the organization. It's purpose and goals, values and mission, etc.

Example: This is a lorem ipsum description of the organization and its purpose and goals and what it does and what it does not do.

email

string | null

The contact email address for the organization if provided.

phone

string | null

The contact phone number for the organization if provided.

primary_language

string

The primary language of the organization.

Example: en

website_url

string

The web site for the organization.

Example: https://www.biblica.com

object

The Address Schema belonging to the Organization Resource in the Platform.

Passage

id

string · readOnly

A canonical representation of the passage returned

Example: MAT.1.1

content

string · readOnly

The Bible text of the requested passage in either text or html format.

Example: The book of the genealogy of Jesus Christ, the son of David, the son of Abraham.

reference

string · readOnly

A human-readable reference

Example: Matthew 1:1