No results

Fetch all items

Fetch a page of items in a list.

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

Example

cURL
123curl https://api.jsonpad.io/lists/d94d8704-fc12-485d-aa54-d269c26725d9/items \
  -H "Content-Type: application/json" \
  -H "x-api-token: <YOUR TOKEN>"

Parameters

  • required
    listIdstringA list id or path name.
  • optional
    pagenumberhttps://api.jsonpad.io/lists/fbb5e537-5cc6-4aa4-9d9b-4e40b08549f8/items?page=1The page number to fetch. Defaults to 1.
  • optional
    limitnumberhttps://api.jsonpad.io/lists/7d51ae61-b6cf-445b-a164-58f8af833719/items?limit=20The number of items to fetch per page. Defaults to 20.
  • optional
    orderstringhttps://api.jsonpad.io/lists/7468d004-71d8-4d24-aaeb-bb7635aae73c/items?order=createdAt

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

    Valid values are:

    • createdAt
    • updatedAt
    • alias
    • readonly
    • activated
    • {index.pathName}The path name of a sortable index in the specified list.
  • optional
    directionstringhttps://api.jsonpad.io/lists/b79079f3-2fff-45d5-947f-956d4cdc6a33/items?direction=asc

    The direction to order the items by.

    Valid values are:

    • asc
    • desc
  • optional
    aliasstringhttps://api.jsonpad.io/lists/51c9f5c8-b146-48c2-8914-0f3fd7ea8776/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/5ca81a02-d1e5-4247-80b9-fca1bbdd117d/items?readonly=trueFilter for readonly items. Can be true or false.
  • optional
    includeDatabooleanhttps://api.jsonpad.io/lists/a335227e-2d70-44bf-83c6-938f961a97df/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/b247a20c-e99a-4f32-9a64-cc26cb9fe259/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/3fea066b-b0d7-4efe-8c6b-34ac86fcc003/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-05 will filter items using the index-name index where the indexed value is a date before (or exactly equal to) 5th September 2026.
    • ?index-name=after:2026-09-05 will filter items using the index-name index where the indexed value is a date after (or exactly equal to) 5th September 2026.

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: "31241dae-98a2-4f3c-b429-9986344b97fe"
createdAt: "2026-09-05T11:29:53.327Z"
updatedAt: "2026-09-05T11:29:53.327Z"
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"
size: 111
locked: false
}
]
}

Response headers

  • x-total1The total number of results available.
  • x-pages1The total number of pages available.
2024-10-29