Provides information about our publishing partners in the YouVersion platform. Use these to get information about the organizations which provide Bible versions.
Get a collection of organizations in the Platform.
Returns a paginated list of Organization objects. Use bible_ids[] to filter to organizations associated with the given Bible version(s); when omitted, all organizations are returned.
query Parameters
bible_ids[]Filter organizations to those associated with the given Bible version(s). Use bracket notation: bible_ids[]=111&bible_ids[]=206. When omitted, returns all organizations.
page_sizeThe number of items to return in the collection. Numeric values must be between 1 and 99.
Special value "" is supported only when used in combination with the fields parameter and
when the client requests three or fewer fields (see fields parameter). When "" is used the
server will return all matching items for the requested resource (no numeric page limit).
fields[]A list of top-level fields to include in each resource object. Use bracket notation to pass
multiple values, for example: fields[]=id&fields[]=name&fields[]=language.
When provided, page_size=* is allowed only if the number of fields requested is three (3) or fewer.
page_tokenThe page token to retrieve results from.
Headers
Accept-LanguageThe localization preferred as a response to the request. See RFC 2616 section 14.4 for further details.
Get a collection of organizations in the Platform. › Responses
Successful request
next_page_tokenToken to send to server when retrieving the next page of results.
Get details about a specific organization in the Platform.
Get a single organization resource by its id.
path Parameters
organization_idThe Organization unique ID provided in the Platform.
Headers
Accept-LanguageThe localization preferred as a response to the request. See RFC 2616 section 14.4 for further details.
Get details about a specific organization in the Platform. › Responses
Successful request
idThe unique identifier of the organization in the Platform.
parent_organization_idThe id of the parent organization if one exists.
namePublisher'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.
descriptionDescription of the organization. It's purpose and goals, values and mission, etc.
emailThe contact email address for the organization if provided.
phoneThe contact phone number for the organization if provided.
primary_languageThe primary language of the organization.
website_urlThe web site for the organization.
The Address Schema belonging to the Organization Resource in the Platform.
Get bibles associated with a specific organization in the Platform.
Get bibles associated with a specific organization by its id.
path Parameters
organization_idThe Organization unique ID provided in the Platform.
query Parameters
page_sizeThe number of items to return in the collection. Numeric values must be between 1 and 99.
Special value "" is supported only when used in combination with the fields parameter and
when the client requests three or fewer fields (see fields parameter). When "" is used the
server will return all matching items for the requested resource (no numeric page limit).
fields[]A list of top-level fields to include in each resource object. Use bracket notation to pass
multiple values, for example: fields[]=id&fields[]=name&fields[]=language.
When provided, page_size=* is allowed only if the number of fields requested is three (3) or fewer.
page_tokenThe page token to retrieve results from.
Get bibles associated with a specific organization in the Platform. › Responses
Successful request
next_page_tokenToken to send to server when retrieving the next page of results.
total_sizeTotal number of bibles in collection matching parameters.
Get video playlists associated with a specific organization in the Platform.
Get dark-launched video playlists associated with a specific organization by its id.
path Parameters
organization_idThe Organization unique ID provided in the Platform.
query Parameters
page_sizeThe number of items to return in the collection. Numeric values must be between 1 and 99.
Special value "" is supported only when used in combination with the fields parameter and
when the client requests three or fewer fields (see fields parameter). When "" is used the
server will return all matching items for the requested resource (no numeric page limit).
page_tokenThe page token to retrieve results from.
Headers
Accept-LanguageThe localization preferred as a response to the request. See RFC 2616 section 14.4 for further details.
Get video playlists associated with a specific organization in the Platform. › Responses
Successful request
next_page_tokenToken to send to server when retrieving the next page of results.
Get an organization video playlist by id.
Get a dark-launched video playlist in its organization context.
path Parameters
organization_idThe Organization unique ID provided in the Platform.
playlist_idThe unique playlist ID provided in the Platform.
Headers
Accept-LanguageThe localization preferred as a response to the request. See RFC 2616 section 14.4 for further details.
Get an organization video playlist by id. › Responses
Successful request
idPlaylist identifier.
titlePlaylist title.
typePlaylist type mapped from upstream playlist_type.
totalTotal number of items in the playlist.
videosOrdered video ids in the playlist.