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.