No results

Fetch partial item data

Fetch a page of items in a list.

Only part of each item's data will be returned.

This route uses JSON pointer syntax to specify the data to return.

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

Example

cURL
123curl https://api.jsonpad.io/lists/04c41b33-a27c-4435-852a-9d941a95716c/items/data/name \
  -H "Content-Type: application/json" \
  -H "x-api-token: <YOUR TOKEN>"

Parameters

  • required
    listIdstringA list id or path name.
  • required
    pointerstringA JSON pointer to the field in each item's data that will be returned.
  • optional
    pagenumberhttps://api.jsonpad.io/lists/292f4d8c-6db6-4b33-bba1-255c977b5ef9/items/data/name?page=1The page number to fetch. Defaults to 1.
  • optional
    limitnumberhttps://api.jsonpad.io/lists/2d5d1aea-b920-474e-97c6-c438d5cc5240/items/data/name?limit=20The number of items to fetch per page. Defaults to 20.
  • optional
    orderstringhttps://api.jsonpad.io/lists/5f33cd3f-2c8c-495a-bbb5-3ce40f8f343a/items/data/name?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/62aa2e37-8b68-4ef6-b1cb-d5447f7f57d3/items/data/name?direction=asc

    The direction to order the items by.

    Valid values are:

    • asc
    • desc
  • optional
    aliasstringhttps://api.jsonpad.io/lists/0d862e92-747f-4946-a7d4-aedd56be009b/items/data/name?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/8000a040-72f8-4ebe-986c-0d9f94d728ce/items/data/name?readonly=trueFilter for readonly items. Can be true or false.
  • optional
    {index.pathName}string | numberhttps://api.jsonpad.io/lists/ab2051f7-9cac-431b-ae6c-1f0f77eb9ce1/items/data/name?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

Given a single item containing following data:

{
name: "John Doe"
age: 30
locations: [
0: {
city: "New York"
state: "NY"
}
1: {
city: "Los Angeles"
state: "CA"
}
]
}

With pointer set to /locations:

{
page: 1
limit: 20
total: 1
data: [
0: [
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