Transformers

Schemas

AccessRole

An access role for a developer.

role

string

AccessRoles

A collection of access roles.

object[]

App

An App resource.

id

string · uuid · readOnly

developer_id

string · uuid · readOnly

object

callback_uri

string

website_url

string

apple_url

string

play_store_url

string

commercial

string · enum

Enum values:

commercial

non-commercial

description

string

status

string

created_dt

string · date-time · readOnly

updated_dt

string · date-time · readOnly

Apps

A collection of Apps.

object[]

AppKey

An App Key resource.

id

string · uuid · readOnly

app_id

string · uuid · readOnly

public_key

string · readOnly

os

string · readOnly

status

string · enum

Enum values:

accepted

revoked

description

string

created_dt

string · date-time · readOnly

AppKeys

object[]

A collection of App Keys.

An App Key resource.

id

string · uuid · readOnly

app_id

string · uuid · readOnly

public_key

string · readOnly

os

string · readOnly

status

string · enum

Enum values:

accepted

revoked

description

string

created_dt

string · date-time · readOnly

AppKeyCreateResponse

Response for created App Key.

success

boolean

message

string

key_db_details

object

key_apigee_details

object

Developer

A Developer resource.

id

string · uuid · readOnly

The unique identifier of the developer.

name

string

The name of the developer organization.

object

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

profit_designation

string

is_indie

boolean

object[] · readOnly

email

string | null · email · readOnly

status

string · readOnly

report_details

object | null · readOnly

Details about why a developer was reported.

created_dt

string · date-time · readOnly

updated_dt

string · date-time · readOnly

DeveloperMember

A member of a developer organization.

role

string

yvp_id

string

DeveloperReportDetails

DeveloperNotification

A Developer Notification resource.

id

integer · readOnly

developer_id

string · uuid · readOnly

subject

string

message

string

category

string · enum

Enum values:

GOOD

BAD

WARN

INFO

target_url

string | null

read_dt

string | null · date-time · readOnly

created_dt

string · date-time · readOnly

DeveloperNotificationCreateAllResponse

Response for creating notifications for all developers.

success

boolean · required

notifications_created

integer · required

DeveloperNotifications

A collection of Developer Notifications.

object[] · required

object · required

DeveloperReportPayload

Payload to report a developer.

organization_id

string · required

organization_name

string · required

reason

string · required

additional_details

string

revoke_all_licenses

boolean

DeveloperEmailSupportPayload

Payload to send support email.

category

string · required

subject

string · required

body

string · required

reply_to

string · required

DeveloperGrantLicensePayload

Payload to grant a license to a developer.

name

string · required

version

integer · required

yvp_user_id

string · required

DeveloperRevokeLicensePayload

Payload to revoke a license from a developer.

name

string · required

version

integer · required

AppGrantLicensePayload

Payload to grant a license to an app.

name

string · required

version

integer · required

AppRevokeLicensePayload

Payload to revoke a license from an app.

organization_id

string · required

organization_name

string · required

reason

string · required

additional_details

string

AppUnrevokeLicensePayload

Payload to unrevoke a license from an app.

organization_id

string · required

organization_name

string · required

reason

string

Account

app_id

string · uuid · readOnly

yv_user_id

integer · readOnly

The YouVersion User ID

Example: 8981

account_id

string · uuid · readOnly

The YouVersion Platform Account ID for this specific app

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

created_date

string · date-time · readOnly

Iso formatted date and time in UTC when account was created

Example: 2020-09-08T10:00:44.064920+00:00

Accounts

object[] · readOnly

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 accounts for this YouVersion user.

Example: 42

Agreement

license_name

string · required

The name of the license.

license_version

integer · required

The version of the license.

agreed_by_user_id

string · uuid · required

The user ID who accepted the agreement.

developer_id

string · uuid · readOnly

The unique identifier of the developer.

license_id

integer · readOnly

The unique identifier of the license.

agreed_dt

string · date-time · readOnly

The timestamp when the agreement was made.

Agreements

object[] · required

total_size

integer · required

The total number of agreements.

Bible

id

integer · readOnly

Bible version identifier

Example: 3034

abbreviation

string · readOnly

Bible version abbreviation

Example: BSB

promotional_content

string · readOnly

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

Example: "https://berean.bible/"

copyright

string · readOnly

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

Example: "The Holy Bible, Berean Standard Bible, BSB is produced in cooperation with Bible Hub, Discovery Bible, OpenBible.com, and the Berean Bible Translation Committee. This text of God's Word has been dedicated to the public domain."

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:

language_tag

string · readOnly

BCP47 canonical language tag for this Bible version

Example: en

localized_abbreviation

string · readOnly

Localized Bible version abbreviation

Example: BSB

localized_title

string · readOnly

Localized title of Bible version

Example: English: Berean Standard Bible

title

string · readOnly

English title of Bible version

Example: Berean Standard Bible

books

string[] · readOnly

youversion_deep_link

string · readOnly

A deep link to this Bible version inside YouVersion

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

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

Font

A font family resource with available variants and CDN-backed source files.

id

integer · int32 · required

Stable integer identifier for the font family.

Example: 1

slug

string · required

Stable URL-safe identifier for the font family.

Example: untitled-serif

family

string · required

Canonical font-family name clients should use.

Example: Untitled Serif

object[] · required

Available faces within this font family.

Fonts

object[] · readOnly · required

FontSource

format

string · enum · required

The file format for this source asset.

Enum values:

woff2

ttf

Example: woff2

url

string · uri · required

Fully qualified CDN URL for this font source file.

Example: https://cdn.youversion.com/fonts/untitled-serif/Untitled%20Serif.woff2

FontVariant

weight

integer · enum · int32 · required

Numeric font weight for this variant.

Enum values:

400

500

700

Example: 400

style

string · enum · required

Font style for this variant.

Enum values:

normal

italic

Example: normal

object[] · required

CDN assets available for this specific weight and style.

Highlight

bible_id

integer · int32 · required

Bible version identifier

Example: 3034

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: 3034

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.

OrganizationLicensee

An organization-scoped licensee row.

developer_id

string · uuid · required

developer_name

string · required

app_id

string · uuid · required

developer_status

string | null

object | null

app_name

string | null

apple_url

string | null

play_store_url

string | null

website_url

string | null

profit_designation

string | null

license_status

string | null

created_dt

string | null · date-time

OrganizationLicenseeExport

An organization-scoped licensee row.

developer_id

string · uuid · required

developer_name

string · required

app_id

string · uuid · required

developer_status

string | null

object | null

app_name

string | null

apple_url

string | null

play_store_url

string | null

website_url

string | null

profit_designation

string | null

license_status

string | null

created_dt

string | null · date-time

email

string | null

report_details

object | null

Details about why a developer was reported.

OrganizationLicensees

object[] · readOnly · required

next_page_token

string · readOnly

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

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

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

Transformers

Schemas

AccessRole

An access role for a developer.

role

string

AccessRoles

A collection of access roles.

object[]

App

An App resource.

id

string · uuid · readOnly

developer_id

string · uuid · readOnly

object

callback_uri

string

website_url

string

apple_url

string

play_store_url

string

commercial

string · enum

Enum values:

commercial

non-commercial

description

string

status

string

created_dt

string · date-time · readOnly

updated_dt

string · date-time · readOnly

Apps

A collection of Apps.

object[]

AppKey

An App Key resource.

id

string · uuid · readOnly

app_id

string · uuid · readOnly

public_key

string · readOnly

os

string · readOnly

status

string · enum

Enum values:

accepted

revoked

description

string

created_dt

string · date-time · readOnly

AppKeys

object[]

A collection of App Keys.

An App Key resource.

id

string · uuid · readOnly

app_id

string · uuid · readOnly

public_key

string · readOnly

os

string · readOnly

status

string · enum

Enum values:

accepted

revoked

description

string

created_dt

string · date-time · readOnly

AppKeyCreateResponse

Response for created App Key.

success

boolean

message

string

key_db_details

object

key_apigee_details

object

Developer

A Developer resource.

id

string · uuid · readOnly

The unique identifier of the developer.

name

string

The name of the developer organization.

object

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

profit_designation

string

is_indie

boolean

object[] · readOnly

email

string | null · email · readOnly

status

string · readOnly

report_details

object | null · readOnly

Details about why a developer was reported.

created_dt

string · date-time · readOnly

updated_dt

string · date-time · readOnly

DeveloperMember

A member of a developer organization.

role

string

yvp_id

string

DeveloperReportDetails

DeveloperNotification

A Developer Notification resource.

id

integer · readOnly

developer_id

string · uuid · readOnly

subject

string

message

string

category

string · enum

Enum values:

GOOD

BAD

WARN

INFO

target_url

string | null

read_dt

string | null · date-time · readOnly

created_dt

string · date-time · readOnly

DeveloperNotificationCreateAllResponse

Response for creating notifications for all developers.

success

boolean · required

notifications_created

integer · required

DeveloperNotifications

A collection of Developer Notifications.

object[] · required

object · required

DeveloperReportPayload

Payload to report a developer.

organization_id

string · required

organization_name

string · required

reason

string · required

additional_details

string

revoke_all_licenses

boolean

DeveloperEmailSupportPayload

Payload to send support email.

category

string · required

subject

string · required

body

string · required

reply_to

string · required

DeveloperGrantLicensePayload

Payload to grant a license to a developer.

name

string · required

version

integer · required

yvp_user_id

string · required

DeveloperRevokeLicensePayload

Payload to revoke a license from a developer.

name

string · required

version

integer · required

AppGrantLicensePayload

Payload to grant a license to an app.

name

string · required

version

integer · required

AppRevokeLicensePayload

Payload to revoke a license from an app.

organization_id

string · required

organization_name

string · required

reason

string · required

additional_details

string

AppUnrevokeLicensePayload

Payload to unrevoke a license from an app.

organization_id

string · required

organization_name

string · required

reason

string

Account

app_id

string · uuid · readOnly

yv_user_id

integer · readOnly

The YouVersion User ID

Example: 8981

account_id

string · uuid · readOnly

The YouVersion Platform Account ID for this specific app

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

created_date

string · date-time · readOnly

Iso formatted date and time in UTC when account was created

Example: 2020-09-08T10:00:44.064920+00:00

Accounts

object[] · readOnly

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 accounts for this YouVersion user.

Example: 42

Agreement

license_name

string · required

The name of the license.

license_version

integer · required

The version of the license.

agreed_by_user_id

string · uuid · required

The user ID who accepted the agreement.

developer_id

string · uuid · readOnly

The unique identifier of the developer.

license_id

integer · readOnly

The unique identifier of the license.

agreed_dt

string · date-time · readOnly

The timestamp when the agreement was made.

Agreements

object[] · required

total_size

integer · required

The total number of agreements.

Bible

id

integer · readOnly

Bible version identifier

Example: 3034

abbreviation

string · readOnly

Bible version abbreviation

Example: BSB

promotional_content

string · readOnly

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

Example: "https://berean.bible/"

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:

language_tag

string · readOnly

BCP47 canonical language tag for this Bible version

Example: en

localized_abbreviation

string · readOnly

Localized Bible version abbreviation

Example: BSB

localized_title

string · readOnly

Localized title of Bible version

Example: English: Berean Standard Bible

title

string · readOnly

English title of Bible version

Example: Berean Standard Bible

books

string[] · readOnly

youversion_deep_link

string · readOnly

A deep link to this Bible version inside YouVersion

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

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

Font

A font family resource with available variants and CDN-backed source files.

id

integer · int32 · required

Stable integer identifier for the font family.

Example: 1

slug

string · required

Stable URL-safe identifier for the font family.

Example: untitled-serif

family

string · required

Canonical font-family name clients should use.

Example: Untitled Serif

object[] · required

Available faces within this font family.

Fonts

object[] · readOnly · required

FontSource

format

string · enum · required

The file format for this source asset.

Enum values:

woff2

ttf

Example: woff2

url

string · uri · required

Fully qualified CDN URL for this font source file.

Example: https://cdn.youversion.com/fonts/untitled-serif/Untitled%20Serif.woff2

FontVariant

weight

integer · enum · int32 · required

Numeric font weight for this variant.

Enum values:

400

500

700

Example: 400

style

string · enum · required

Font style for this variant.

Enum values:

normal

italic

Example: normal

object[] · required

CDN assets available for this specific weight and style.

Highlight

bible_id

integer · int32 · required

Bible version identifier

Example: 3034

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

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: 3034

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

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.

OrganizationLicensee

An organization-scoped licensee row.

developer_id

string · uuid · required

developer_name

string · required

app_id

string · uuid · required

developer_status

string | null

object | null

app_name

string | null

apple_url

string | null

play_store_url

string | null

website_url

string | null

profit_designation

string | null

license_status

string | null

created_dt

string | null · date-time

OrganizationLicenseeExport

An organization-scoped licensee row.

developer_id

string · uuid · required

developer_name

string · required

app_id

string · uuid · required

developer_status

string | null

object | null

app_name

string | null

apple_url

string | null

play_store_url

string | null

website_url

string | null

profit_designation

string | null

license_status

string | null

created_dt

string | null · date-time

email

string | null

report_details

object | null

Details about why a developer was reported.

OrganizationLicensees

object[] · readOnly · required

next_page_token

string · readOnly

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

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

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