lists

Get Multiple Lists

Get multiple lists. Lists are sorted lexicographically. See https://golang.org/pkg/strings/#Compare

Required security scopes:

api:manage

get/lists

Request

The document declares no server URL.
Auth
API key in header Authorization
TypeScript
https://skmtc.dev/vivino/apis/the-rankdb-api/docs/lists/get.ts
A function with typed inputs. Its response is checked against the schema.

Query parameters

after_idstring

Start with element following this ID. Empty will return from start.

before_idstring

Return elements preceding this ID.

limitinteger

Maximum Number of results

Response

lists_afterinteger required

The number of lists after the last element

lists_beforeinteger required

The number of lists before the first element

Example response

{
  "lists": [
    {
      "id": "highscore-list",
      "load_index": false,
      "merge_size": 500,
      "metadata": {
        "country": "dk",
        "game": "2"
      },
      "set": "storage-set",
      "split_size": 2000
    },
    {
      "id": "highscore-list",
      "load_index": false,
      "merge_size": 500,
      "metadata": {
        "country": "dk",
        "game": "2"
      },
      "set": "storage-set",
      "split_size": 2000
    },
    {
      "id": "highscore-list",
      "load_index": false,
      "merge_size": 500,
      "metadata": {
        "country": "dk",
        "game": "2"
      },
      "set": "storage-set",
      "split_size": 2000
    }
  ],
  "lists_after": 4923220431896422000,
  "lists_before": 2009714069180827400
}

Changes

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