List documents in a collection

Browse or page through any collection. Use this to answer "what exists" — "what events are recorded", "list the epochs in order", "show me the 613 commandments" — rather than to look one thing up.

Epochs and events default to chronological order, so one call answers "what happened, in sequence". Everything else defaults to alphabetical.

get/list

Request

  • Base URL: https://vineverse.bible/api/v1
  • URL: https://vineverse.bible/api/v1/list
  • Auth: none required

Query parameters

type'Person' | 'Place' | 'Theme' | 'Lexeme' | 'Commandment' | 'Event' | 'Epoch' | 'Book' | 'Chapter' | 'Source' | 'Dataset' | 'Relation Vocabulary'

Restrict to one collection. Plurals and folder names also resolve ("themes", "sa/events").

tagstring

Restrict to documents carrying this tag. See GET /tags for the vocabulary.

folderstring

Restrict by bundle folder prefix, e.g. "bible/john".

sort'title' | 'degree' | 'canonical' | 'chronological'

title = alphabetical; degree = most-connected first; canonical = Bible order; chronological = by start year (epochs) or narrative order (events).

limitinteger
offsetinteger

Skip this many results. Compare with total in the response to page.

Response

One page of the collection.

typestring
collectionstring

Site route for the browse page.

tagstring
sortstring
totalinteger required

How many documents matched, before paging.

offsetinteger
countinteger required

How many are in this page.

hasMoreboolean

Changes

No recorded changes to this operation across all 1 revision of this API.