Transformers
integer · int32 · requiredstring · required
string · uuid · requiredinteger · int32 · requiredstring · requiredstring · pattern: string
Endpoints for managing user highlights on scripture passages. Use these to list existing highlights, create new ones, update highlights, or clear highlights for verse ranges.
Get a collection of highlights for a user.
GET
https://api.youversion.com
/v1/highlights
The response will return a color per verse without ranges.
query Parameters
bible_idThe Bible version identifier
Example: 3034
passage_idThe passage identifier (verse or chapter USFM format)
Example: MAT.1.1
Get a collection of highlights for a user. › Responses
Successful request
object[] · readOnly
Create or update a highlight on a passage.
POST
https://api.youversion.com
/v1/highlights
Verse ranges may be used in the POST body passage_id attribute.
Create or update a highlight on a passage. › Request Body
request_idRequest UUID for idempotent create retries.
Example: 2f8c5d2e-6f6c-4b4f-9b36-8c1b5a17d3f9
object · required
Create or update a highlight on a passage. › Responses
Highlight(s) created successfully
bible_idBible version identifier
Example: 3034
passage_idThe passage identifier (verse USFM format)
Example: MAT.1.1
color^[0-9a-f]{6}$ · requiredThe highlight color in hex format
Example: 44aa44
idThe Highlight resource identifier
Example: ZXlKaUlqb3hNVEVzSW1NaU9pSmhZV0ZoWVdFaWZR