No results

Fetch all item data

Fetch a page of items in a list.

This route only returns the data from each item.

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

Example

cURL
123curl https://api.jsonpad.io/lists/f5827a59-617c-4222-8ef5-6a9a78421493/items/data \
  -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/8341357a-cfd7-4e64-8776-0ff0cebd6732/items/data?page=1The page number to fetch. Defaults to 1.
  • optional
    limitnumberhttps://api.jsonpad.io/lists/2a7845fc-898a-4568-9f4c-0f054108ff8e/items/data?limit=20The number of items to fetch per page. Defaults to 20.
  • optional
    orderstringhttps://api.jsonpad.io/lists/10e1e6c1-c285-4b60-ae19-e865b89a3339/items/data?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/6d5f6844-1435-48c6-9ae9-58b04b894d57/items/data?direction=asc

    The direction to order the items by.

    Valid values are:

    • asc
    • desc
  • optional
    pathstringhttps://api.jsonpad.io/lists/e5125878-fc99-45a3-a3fe-79f8b636901a/items/data?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.

    Example

    Given the JSON path: $.locations[*].state, and 2 items containing the following data:

    Item #1:
    {
    name: "John Doe"
    age: 30
    locations: [
    0: {
    city: "New York"
    state: "NY"
    }
    1: {
    city: "Los Angeles"
    state: "CA"
    }
    ]
    }
    Item #2:
    {
    name: "Jane Doe"
    age: 40
    locations: [
    0: {
    city: "Chicago"
    state: "IL"
    }
    1: {
    city: "Houston"
    state: "TX"
    }
    ]
    }

    The JSON path will be applied to each item's data, resulting in:

    [
    0: [
    0: "NY"
    1: "CA"
    ]
    1: [
    0: "IL"
    1: "TX"
    ]
    ]
  • optional
    aliasstringhttps://api.jsonpad.io/lists/d1ec5184-e76c-46ca-be1b-240a56bfd37e/items/data?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/4c02aff2-e35c-49f5-8104-e63fcdd57418/items/data?readonly=trueFilter for readonly items. Can be true or false.
  • optional
    {index.pathName}string | numberhttps://api.jsonpad.io/lists/b91093d2-c170-4741-a3e5-a819ced4de47/items/data?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: {
name: "John Doe"
age: 30
locations: [
0: {
city: "New York"
state: "NY"
}
1: {
city: "Los Angeles"
state: "CA"
}
]
}
]
}

Response headers

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