---
title: "List documents in a collection"
method: GET
path: "/list"
---

# List documents in a collection

`GET /list`

## Request

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

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.

## Query parameters

- `type` 'Person' | 'Place' | 'Theme' | 'Lexeme' | 'Commandment' | 'Event' | 'Epoch' | 'Book' | 'Chapter' | 'Source' | 'Dataset' | 'Relation Vocabulary'
- `tag` string
- `folder` string
- `sort` 'title' | 'degree' | 'canonical' | 'chronological'
- `limit` integer
- `offset` integer

## Response `200`

One page of the collection.

- Listing
  - `type` string
  - `collection` string: Site route for the browse page.
  - `tag` string
  - `sort` string
  - `total` integer, required: How many documents matched, before paging.
  - `offset` integer
  - `count` integer, required: How many are in this page.
  - `hasMore` boolean
  - `results` object[], required
    - `id` string, required: Site route, e.g. "/people/moses". Strip the leading slash to use it as a path.
    - `title` string, required
    - `type` 'Person' | 'Place' | 'Theme' | 'Lexeme' | 'Commandment' | 'Event' | 'Epoch' | 'Book' | 'Chapter' | 'Source' | 'Dataset' | 'Relation Vocabulary', required: Which collection the document belongs to.
    - `description` string
    - `degree` integer, required: Number of graph edges touching this document.
    - `lat` number: Places only.
    - `lon` number: Places only.
    - `strongs` string: Lexemes only, e.g. "H430".
    - `osis` string: Scripture documents and commandments only.
    - `shareAlike` boolean: Present, and always true, only on CC BY-SA 4.0 documents. A listing has one licence block for many documents and cannot say which are viral, so it says it here instead. Filtering on the "/sa/" id prefix is NOT equivalent — it misses /sources/theographic.
    - `startYearAH` integer
    - `endYearAH` integer
    - `lengthYears` integer
    - `epochType` string
    - `number` integer: Commandment number.
    - `polarity` 'positive' | 'negative'
    - `verseCount` integer
    - `occurrences` integer
  - `licence` Licence: Carried on every response. The obligation is inherited by anyone who redistributes the data, not discharged by us. `document` is the licence of the specific document fetched, which is CC-BY-SA-4.0 for anything under sa/ and is the value to honour over the blanket statement.
    - `text` string
    - `data` string
    - `document` string: SPDX-style id for this document, e.g. "CC-BY-4.0".
    - `shareAlike` string
    - `reason` string
    - `attribution` string, uri

## Other responses

- `400`: The reference or parameter could not be parsed.
- `429`: Too many requests. Carries Retry-After. See the rate limit note in `info`.

---

[API](https://skmtc.dev/vineverse/apis/vineverse-api.md) · [All operations](https://skmtc.dev/vineverse/apis/vineverse-api/llms.txt) · [OpenAPI document](https://skmtc.dev/vineverse/apis/vineverse-api/revisions/39d053a686bb?raw)