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 https://api.jsonpad.io/lists/a3dec5a2-db15-4825-8fde-4aadb71a4f0e/items/data/name \
  -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/523581be-396d-4de1-9c1e-58f198beca78/items/data/name?page=1The page number to fetch. Defaults to 1.
optional
limitnumberhttps://api.jsonpad.io/lists/65900149-a1e9-424d-a0c5-8ff786d71d23/items/data/name?limit=20The number of items to fetch per page. Defaults to 20.
optional
orderstringhttps://api.jsonpad.io/lists/54efdc25-7265-4f74-8113-a90faf357c82/items/data/name?order=createdAt
The field to order the items by. Defaults to createdAt.
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/4e2b55c9-7755-4953-a93d-67672433d126/items/data/name?direction=asc
The direction to order the items by.
Valid values are:
- asc
- desc
optional
aliasstringhttps://api.jsonpad.io/lists/ecafd44b-627e-4c1a-bb9c-91be6a500048/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/fe6f25fe-58a8-4963-afb5-893e58a2f7a8/items/data/name?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/3d45b7c7-0bbc-47af-aabd-047d2786d8ef/items/data/name?identityId=ff21d878-a0c3-42db-837b-066e119f3bc9
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
{index.pathName}string | numberhttps://api.jsonpad.io/lists/763baa73-8cfe-4a66-947c-857332246252/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-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/057b7453-35f2-4c1c-af29-f872011a7788/items/data/name?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

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