Fetch item events

Fetch a page of events for an item.

Events can also be fetched for an item that has been deleted, as long as the item is referenced by its id.

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

Example

cURL
12curl https://api.jsonpad.io/lists/c7e54653-0f9c-4f26-aae9-c6a364c48463/items/fe53afc4-c41d-46d9-9106-4648ab7ec314/events \ -H "x-api-token: <YOUR TOKEN>"

Parameters

  • required
    listIdstringA list id or path name.
  • required
    itemIdstringAn item id or alias.
  • optional
    pagenumberhttps://api.jsonpad.io/lists/c0612faa-497d-4ab4-bfbf-81945f157a32/items/$83c34348-18b2-4791-8a14-7ec03308f244/events?page=1The page number to fetch. Defaults to 1.
  • optional
    limitnumberhttps://api.jsonpad.io/lists/9e9fd563-c766-41ff-88f6-659ff384646e/items/$48776903-92b8-4582-ac9c-5d06393de0b0/events?limit=20The number of events to fetch per page. Defaults to 20.
  • optional
    orderstringhttps://api.jsonpad.io/lists/9172f034-5657-423c-87e4-4fadcc5a0e12/items/$ea2bc226-6a50-45f0-bf7e-ad78ec174565/events?order=createdAt

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

    Valid values are:

    • createdAt
    • type
  • optional
    directionstringhttps://api.jsonpad.io/lists/eb649a48-9332-446c-b94c-7d65f14e47e5/items/$61febb0f-f586-498b-ae9b-83a7d0726542/events?direction=asc

    The direction to order the events by.

    Valid values are:

    • asc
    • desc
  • optional
    startAtstringhttps://api.jsonpad.io/lists/9e277c01-6410-4dbc-b397-039516c0d3bc/items/6233acf6-4c64-4ef3-8079-de329e067adb/events?startAt=2026-09-23Filter for events after the specified date. This should be an ISO 8601 date.
  • optional
    endAtstringhttps://api.jsonpad.io/lists/184e6177-8e65-4132-a667-c51216617f01/items/7e75e0f5-0947-4716-a011-a98fb892e42d/events?endAt=2026-09-23Filter for events before the specified date. This should be an ISO 8601 date.
  • optional
    typestringhttps://api.jsonpad.io/lists/fc230c8f-535d-4fb7-bd5a-4c7a14d91122/items/$91c8800f-589a-46be-9d7c-357813bf990a/events?type=item-updated

    Filter for events by type.

    Valid types are:

    • item-created
    • item-updated
    • item-restored
    • item-deleted
  • optional
    restorablebooleanhttps://api.jsonpad.io/lists/4cf97d93-6e59-44cc-a5ae-82782cfe4cf8/items/52a800c9-c058-4f3f-b3d2-61c6dcdfa52c/events?restorable=trueOnly return events that the item can be restored from.
  • optional
    includeSnapshotbooleanhttps://api.jsonpad.io/lists/6542b0a8-c04f-4885-b5f8-f36dfdb5329d/items/08cea02d-78f8-41e2-babd-ad974b8af7d5/events?includeSnapshot=trueInclude each event's snapshot in the response. Defaults to false.
  • optional
    includeAttachmentsbooleanhttps://api.jsonpad.io/lists/7ec0487b-5bbf-40dc-87fa-9625f933147e/items/f0c84e24-1c7b-45c1-9a72-23215718c5ce/events?includeAttachments=trueInclude each event's attachments in the response. Defaults to false.
  • 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
    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: "5e3f6825-c836-42b8-b3a0-41cf208ffa87"
createdAt: "2026-09-23T21:08:21.351Z"
updatedAt: "2026-09-23T21:08:21.351Z"
user: {
id: "2ecf7e8c-8bd9-4ee8-b179-ace4ee4f3a4b"
createdAt: "2026-09-23T21:08:21.351Z"
updatedAt: "2026-09-23T21:08:21.351Z"
lastActiveAt: "2026-09-23T21:08:21.351Z"
activated: true
displayName: "Sample User"
description: "Sample user description"
}
modelId: "d9f2a0fd-3175-4c53-9ae6-870ef565e2f2"
stream: "item"
type: "item-created"
version: null
}
]
}

Response headers

  • x-total1The total number of results available.
  • x-pages1The total number of pages available.
2026-09-12