No results
Search failed
No results
Narrow your search with type:list, type:token, #tag…↑↓ to move · Enter to open · Esc to close

Fetch all items

Fetch a page of items in a list.

GET https://api.jsonpad.io/lists/{listId}/items

Example

cURL
12curl https://api.jsonpad.io/lists/23c44126-7ebf-441d-8ae1-beac6f14e3f3/items \ -H "x-api-token: <YOUR TOKEN>"

Parameters

  • required
    listIdstringA list id or path name.
  • optional
    pagenumberhttps://api.jsonpad.io/lists/ac59ef47-1588-4071-bf9c-798b406568d7/items?page=1The page number to fetch. Defaults to 1.
  • optional
    limitnumberhttps://api.jsonpad.io/lists/aac842bf-7ac8-4426-ab08-ba48e062a2a7/items?limit=20The number of items to fetch per page. Defaults to 20.
  • optional
    orderstringhttps://api.jsonpad.io/lists/d075db1b-90d2-4c2d-b766-29a050a46661/items?order=createdAt

    The field to order the items by. Defaults to createdAt.

    Ordering by an index that is still being built is refused with INDEX_BUILDING. The same applies when filtering by an index.

    Valid values are:

    • createdAt
    • updatedAt
    • alias
    • readonly
    • activated
    • identityId
    • {index.pathName}The path name of a sortable index in the specified list.
  • optional
    directionstringhttps://api.jsonpad.io/lists/1d578ac4-8d68-4376-8169-a2172a3c4be9/items?direction=asc

    The direction to order the items by.

    Valid values are:

    • asc
    • desc
  • optional
    aliasstringhttps://api.jsonpad.io/lists/3af3d614-651c-4181-83d3-86359cd2d91d/items?alias=sampleFilter items by their alias-indexed value (partial match, only applies if the list has an alias index).
  • optional
    readonlybooleanhttps://api.jsonpad.io/lists/756aad70-2ede-41b0-b596-6960c164cddf/items?readonly=true

    Filter for readonly items. Can be true or false.

    This uses each item's own readonly setting. Items in a readonly list can't be modified either, but they aren't treated as readonly by this filter.

  • optional
    identityIdstringhttps://api.jsonpad.io/lists/fce479eb-93c9-4994-a8df-b7926c0d8125/items?identityId=3a509798-3e12-4e88-876c-90a7662ac38d

    Filter for items owned by the specified identity.

    This parameter is ignored when using an identity token, since only items owned by that identity will be visible.

  • optional
    includeDatabooleanhttps://api.jsonpad.io/lists/ba749e63-94aa-44da-8a7e-49acff6d566b/items?includeData=true

    Whether to include the item data in the response or not. Can be true or false.

    Defaults to false.

  • optional
    pathstringhttps://api.jsonpad.io/lists/2790092b-2a36-4e7f-a7f4-fe080b5b3057/items?includeData=true&path=%24.locations%5B%2A%5D.state

    Fetch only the specified path from each item's data.

    This parameter uses JSON path syntax to specify the data to fetch.

  • optional
    {index.pathName}string | numberhttps://api.jsonpad.io/lists/13f7d599-fc63-4e60-afff-ca5f86cadad0/items?index-name=sampleFilter items by an indexed value.
    Examples
    • ?index-name=lt:10 will filter items using the index-name index where the indexed value is a number less than 10.
    • ?index-name=lte:10 will filter items using the index-name index where the indexed value is a number less than or equal to 10.
    • ?index-name=gt:10 will filter items using the index-name index where the indexed value is a number greater than 10.
    • ?index-name=gte:10 will filter items using the index-name index where the indexed value is a number greater than or equal to 10.
    • ?index-name=before:2026-09-23 will filter items using the index-name index where the indexed value is a date before (or exactly equal to) 23rd September 2026.
    • ?index-name=after:2026-09-23 will filter items using the index-name index where the indexed value is a date after (or exactly equal to) 23rd September 2026.
  • optional
    includeGuardedboolean?includeGuarded=true

    Include values hidden by guard indexes in the response. Can be true or false.

    This only applies when the request is authenticated as an identity, and only to the items that identity owns. Without an identity, guarded values stay hidden.

    Defaults to false.

  • optional
    taggedstringhttps://api.jsonpad.io/lists/7244a6d1-f24b-4ab8-a507-e291d79709e0/items?tagged=recipe-app

    Only fetch items with a tag.

    Separate tags with commas to fetch items with any of the tags (?tagged=recipe-app,cookbook-app), or repeat the parameter to fetch items with all of them (?tagged=recipe-app&tagged=production).

Request headers

  • required
    x-api-tokenstringYour API token.
  • optional
    x-identity-tokenstringAn identity token.
  • optional
    x-identity-groupstringAn identity group.

Request body

No request body

Response body

200 OK
{
page: 1
limit: 20
total: 1
data: [
0: {
id: "d5060bee-fe5a-4d61-8424-c8818e1b5048"
createdAt: "2026-09-23T21:08:16.542Z"
updatedAt: "2026-09-23T21:08:16.542Z"
data: {
name: "John Doe"
age: 30
locations: [
0: {
city: "New York"
state: "NY"
}
1: {
city: "Los Angeles"
state: "CA"
}
]
}
version: "1"
readonly: false
activated: true
description: "This is a sample item"
tags: [
0: "my-app"
]
size: 111
locked: false
identity: {
id: "68a84ba1-306f-4b04-ae6c-028ad43e438e"
displayName: "Sample Display Name"
}
}
]
}

Response headers

  • x-total1The total number of results available.
  • x-pages1The total number of pages available.
2026-09-13