No results

Fetch item events

Fetch a page of events for an item.

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

Example

cURL
123curl https://api.jsonpad.io/lists/51814ddd-c458-4266-8a4a-44b7c719ee74/items/b4ecee8b-fba1-410b-a107-2d868a2f6d5e/events \
  -H "Content-Type: application/json" \
  -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/d5b39a7f-35c0-4889-bca4-1162b43c3989/items/$9d748aa4-22cd-405b-b0b2-495bee943014/events?page=1The page number to fetch. Defaults to 1.
  • optional
    limitnumberhttps://api.jsonpad.io/lists/34efb510-7711-4d93-9298-667a4b450bef/items/$b756aed7-deaa-4243-97df-aa12e4bae5c7/events?limit=20The number of events to fetch per page. Defaults to 20.
  • optional
    orderstringhttps://api.jsonpad.io/lists/369faa53-5fc5-4c97-99e8-dff366097051/items/$c684404c-5099-4324-b65d-c76e1bf4f839/events?order=createdAt

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

    Valid values are:

    • createdAt
    • type
  • optional
    directionstringhttps://api.jsonpad.io/lists/827c33cd-0d66-4e1c-9be6-9a40fa1fbaeb/items/$019227cf-e8cc-4cef-a3a2-c648757c3910/events?direction=asc

    The direction to order the events by.

    Valid values are:

    • asc
    • desc
  • optional
    startAtstringhttps://api.jsonpad.io/lists/ba2d0fa7-e113-4ecc-8830-150a7d537ae6/items/55cc4d9f-cc47-4e04-b162-aa8380923afb/events?startAt=2026-09-05Filter for events after the specified date. This should be an ISO 8601 date.
  • optional
    endAtstringhttps://api.jsonpad.io/lists/d2e10554-f410-4fa4-af0c-33ebe8c296f6/items/f535a8b6-6327-4f44-a4ee-6b84e279c4a5/events?endAt=2026-09-05Filter for events before the specified date. This should be an ISO 8601 date.
  • optional
    typestringhttps://api.jsonpad.io/lists/8f3d23eb-50d9-4881-9131-52e6a198326b/items/$069f5c55-c26d-41dd-b7ed-ddd71608fbf1/events?type=item-updated

    Filter for events by type.

    Valid types are:

    • item-created
    • item-updated
    • item-restored

Request headers

  • required
    x-api-tokenstringYour API token.

Request body

No request body

Response body

200 OK
{
page: 1
limit: 20
total: 1
data: [
0: {
id: "4360cfba-f43f-4ffc-83bc-ba08bfe4681c"
createdAt: "2026-09-05T11:30:01.037Z"
updatedAt: "2026-09-05T11:30:01.037Z"
user: {
id: "25fd090c-9f1a-46c7-bd2f-4412a19e7e99"
createdAt: "2026-09-05T11:30:01.037Z"
updatedAt: "2026-09-05T11:30:01.037Z"
lastActiveAt: "2026-09-05T11:30:01.037Z"
activated: true
displayName: "Sample User"
description: "Sample user description"
}
modelId: "0498c562-0a1a-444c-8698-edf1632517f3"
stream: "item"
type: "item-created"
version: null
snapshot: {
id: "0498c562-0a1a-444c-8698-edf1632517f3"
data: {
test: 123
}
type: "item"
listId: "14ac0c06-a9ab-4ecf-880e-861130ec93e2"
locked: false
version: "1"
dataSize: 10
readonly: false
activated: true
createdAt: "2026-09-05T11:30:01.037Z"
updatedAt: "2026-09-05T11:30:01.037Z"
description: "This is a sample item"
}
attachments: {
data: {
data: {
test: 123
}
list: "sample-list"
version: "1"
readonly: false
activated: true
description: "This is a sample item"
}
}
}
]
}

Response headers

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