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

View an item

Fetch a specific item with or without its data.

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

Example

cURL
12curl https://api.jsonpad.io/lists/9ebcbc00-389e-4bdd-955c-c6f779ca81a4/items/e17d8332-807b-43a7-a917-00d95cdd21a8 \ -H "x-api-token: <YOUR TOKEN>"

Parameters

  • required
    listIdstringA list id or path name.
  • required
    itemIdstringAn item id or alias. While the list's alias index is being built, only an id can be used.
  • optional
    includeDatabooleanhttps://api.jsonpad.io/lists/f708bfe2-f2c1-40d9-8061-1eb852dc0eff/items/794be551-9faa-4056-a259-dd8657d953cf?includeData=true

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

    Defaults to true.

  • optional
    pathstringhttps://api.jsonpad.io/lists/b85fdfcf-9608-4d01-aa17-d9badbcbb084/items/d8b4f28d-9bcf-41a7-aff6-ab9c85ef208c?includeData=true&path=%24.locations%5B%2A%5D.state

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

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

  • optional
    versionstringhttps://api.jsonpad.io/lists/3d5e6fc0-b151-4d07-9394-6dadabd9a686/items/81c760eb-7aaa-4d18-a57f-ecf321573bbc?version=1Fetch a specific version of the item. If not specified, the latest version will be returned.
  • 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.

Request headers

  • required
    x-api-tokenstringYour API token.
  • optional
    if-modified-since

    An ISO 8601 date.

    If the item hasn't been updated since this date, we return an empty 304 ("Not modified") response, and the request will not be counted towards any active rate limits.

  • optional
    if-none-match

    A SHA-256 hash.

    If this matches the item's ETag hash, we return an empty 304 ("Not modified") response, and the request will not be counted towards any active rate limits.

  • optional
    x-identity-tokenstringAn identity token.
  • optional
    x-identity-groupstringAn identity group.

Request body

No request body

Response body

200 OK
{
id: "04e68978-e470-4e00-95cb-9b39dc54c693"
createdAt: "2026-09-23T21:08:19.460Z"
updatedAt: "2026-09-23T21:08:19.460Z"
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: "1321358c-716d-43d1-b450-121f1e61c782"
displayName: "Sample Display Name"
}
}

Response headers

  • etagaf2bdbe1aa9b6ec1e2ade1d694f41fc71a831d0268e9891562113d8a62add1bfA SHA-256 hash of the item.
  • last-modified2026-09-23T21:08:19.460ZThe date this item was last modified.
2026-09-13