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.
The response will return a color per verse without ranges.
query Parameters
bible_idThe Bible version identifier
passage_idThe passage identifier (verse or chapter USFM format)
Get a collection of highlights for a user. › Responses
Successful request
Create or update a highlight on a passage.
Verse ranges may be used in the POST body passage_id attribute.
Create or update a highlight on a passage. › Request Body
bible_idBible version identifier
passage_idThe passage identifier (verse USFM format)
color^[0-9a-f]{6}$ · requiredThe highlight color in hex format
Create or update a highlight on a passage. › Responses
Highlight(s) created successfully
bible_idBible version identifier
passage_idThe passage identifier (verse USFM format)
color^[0-9a-f]{6}$ · requiredThe highlight color in hex format
Clear highlights for a passage.
Clear highlights for a passage.
path Parameters
passage_id_pathThe passage identifier (verse or chapter USFM format)
query Parameters
bible_idThe Bible version identifier
Clear highlights for a passage. › Responses
Highlights deleted successfully