Provides data about licenses in the YouVersion platform. Developers use these licenses to get access to types of content, for example Bibles.
Get a collection of licenses
Returns a list of license metadata. By default, the response returns all published licenses. If you pass developer_id in the query, the response includes only the licenses that the developer has agreed to. If you pass bible_id, the response returns only the license that covers that Bible ID.
The license object also has a list of the Bible ids that the license offers. The list has every id, except in the bible_id form. In that form, the list has only the Bible that the request names.
You can combine developer_id with the all_available query parameter. The response then has every license and still shows the agreement metadata of the developer when it exists.
Every form also includes the unpublished licenses that the developer of the calling app holds. A license that someone grants directly to a developer appears for that developer and for no one else. So a bible_id request can return more than one license. A developer_id request can return a held license with no agreed_dt.
In the developer_id form, a license that the developer holds through an operator grant is a non-catalog license that someone provisions outside the Portal. Its agreed_dt is the effective date of that grant, and yvp_user_id is null. The operator grant replaces a Portal acceptance that the developer never makes.
The request must prove that it can read the developer in developer_id. This means the developer of the calling app. When the request has the bearer token of a signed-in user, it also means any developer that the user is a member of. The endpoint rejects any other developer.
Each license reports content_types, the number of items that it offers for each content type. Pass content_type with any form to list only licenses that offer that type. Without it, the response does not list a license that offers only content types other than bible.
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.
content_typeLimits the results to resources that offer this content type. Unknown content types are rejected.
Get a collection of licenses › Responses
Successful request
Get the partner supplied licenses of a developer
Returns the Bibles that a developer holds under partner supplied licenses, with one item for each Bible in each license. When the developer holds a Bible under two licenses, the response lists it twice, with the same bible_id. A partner supplied license is a license that a partner gives to the developer directly. The license catalog does not show it.
An item has the status received until the license takes effect. After that, the status is enabled. The response does not include a license that the partner withdrew, suspended, or let expire.
When the Bible name, abbreviation, or language is not known, the value is null. When the rights holder is not known, rights_holder is null.
The items are in order by license_id and then by bible_id. All parameters except page_size must match the call that produced the page_token.
The request must have the bearer token of a signed-in user who is a member of the developer in developer_id. The app key alone is not enough, even for the developer of the calling app, because the items name restricted Bibles.
path Parameters
developer_idThe unique identifier of the developer.
query Parameters
page_sizeThe number of items to return in the collection. Must be between 1 and 99. Use the next_page_token from the response as page_token to retrieve the following page. Unlike page_size, this parameter has no unbounded * mode — collections using it are always paged.
page_tokenThe page token to retrieve results from.
Get the partner supplied licenses of a developer › Responses
Successful request. The data array is empty when the developer has no partner supplied licenses.
next_page_tokenThe token for the next page, or null on the last page.