elements

Get Multiple Elements

Get Multiple Elements in list. Will return 404 if list cannot be found, OK even if no elements are found.

Required security scopes:

  • api:read
post/lists/{list_id}/elements/find

Request

Path parameters

list_idstring required

The ID of the list to apply the operation on. Can be a to z (both upper/lower case), 0 to 9 or one of these characters _-.

Request body

element_idsinteger[] required

IDs of elements

Example request

{
  "element_ids": [
    120,
    340,
    550
  ]
}

Response

OK

not_foundinteger[]

Elements that wasn't found in the list. Unordered.

Example response

{
  "found": [
    {
      "from_bottom": 4000,
      "from_top": 50,
      "id": 100,
      "list_id": "highscore-list",
      "payload": {
        "country": "dk",
        "name": "Mark Anthony"
      },
      "score": 100,
      "tie_breaker": 2000,
      "updated_at": "1996-11-22T14:02:34Z"
    },
    {
      "from_bottom": 4000,
      "from_top": 50,
      "id": 100,
      "list_id": "highscore-list",
      "payload": {
        "country": "dk",
        "name": "Mark Anthony"
      },
      "score": 100,
      "tie_breaker": 2000,
      "updated_at": "1996-11-22T14:02:34Z"
    }
  ],
  "not_found": [
    5935540881490916000,
    5935540881490916000
  ]
}

Changes

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