Provides data about licenses in the YouVersion platform. These licenses are used by developers to get access to various types of content, e.g. Bibles.
Get a collection of licenses
Returns a list of license metadata. By default, the response returns all published
licenses. In the case that developer_id is passed in the query, it filters to only
include licenses the developer has agreed to. In the case that bible_id is passed it
only returns the license under which that Bible ID is currently licensed. The license
object also contains a list of the Bible ids offered under that license — every one of
them, except in the bible_id form, where it narrows to the Bible that was asked about.
Optionally combine developer_id with the all_available query parameter to receive
every license while still surfacing the developer's agreement metadata when present.
Every one of those forms also includes the licenses the calling app's developer holds
that are not published, so a license granted directly to a developer is listed for that
developer and for no one else. A bible_id request may therefore return more than one
license, and a developer_id request may return a held license with no agreed_dt.
developer_id is only honored for a developer the request proves it may read: the
developer the calling app belongs to, or — when a signed-in user's bearer token is sent —
any developer that user is a member of. Naming any other developer is rejected.
query Parameters
bible_idThe Bible version identifier
developer_idThe Developer's unique ID in the Platform.
all_availableThis parameter is used on some collections to modify the resources returned. For example, it modifies whether all Bibles in the Platform should be included in the Bibles collection regardless of licensing of the provided app key. It modified the Licenses collection so that the response will include every license, regardless of whether the developer has agreed to it yet. The default for this field in all cases is false. If a developer wants to include all resources for a collection that implements this query parameter, the client must specifically pass it as true.
Get a collection of licenses › Responses
Successful request