No results

Fetch list events

Fetch a page of events for a list.

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

Example

cURL
123curl https://api.jsonpad.io/lists/75a53530-2f2a-4e11-9e2f-79f301f723cf/events \
  -H "Content-Type: application/json" \
  -H "x-api-token: <YOUR TOKEN>"

Parameters

  • required
    listIdstringA list id or path name.
  • optional
    pagenumberhttps://api.jsonpad.io/lists/e3d40b85-9048-40b1-9e91-c97ee755f979/events?page=1The page number to fetch. Defaults to 1.
  • optional
    limitnumberhttps://api.jsonpad.io/lists/68ba86d2-5ac8-4b92-88d2-506308080a53/events?limit=20The number of events to fetch per page. Defaults to 20.
  • optional
    orderstringhttps://api.jsonpad.io/lists/8552da69-3937-4253-932c-cd7cd2f86235/events?order=createdAt

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

    Valid values are:

    • createdAt
    • type
  • optional
    directionstringhttps://api.jsonpad.io/lists/aa2a4a9e-2a25-4746-8955-9ee698d71ee4/events?direction=asc

    The direction to order the events by.

    Valid values are:

    • asc
    • desc
  • optional
    startAtstringhttps://api.jsonpad.io/lists/762bbbc2-f2eb-4f0a-81cf-9744472c9f77/events?startAt=2026-09-05Filter for events after the specified date. This should be an ISO 8601 date.
  • optional
    endAtstringhttps://api.jsonpad.io/lists/c49271e6-3d9b-4af3-a372-063f43cb6536/events?endAt=2026-09-05Filter for events before the specified date. This should be an ISO 8601 date.
  • optional
    typestringhttps://api.jsonpad.io/lists/291687b4-ff5b-4dac-a96e-6fc197428ee5/events?type=list-updated

    Filter for events by type.

    Valid types are:

    • list-created
    • list-updated

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: "90ea5108-7428-481e-8ad8-01614039571e"
createdAt: "2026-09-05T11:29:45.385Z"
updatedAt: "2026-09-05T11:29:45.385Z"
user: {
id: "ee37dc41-9341-4bd7-85c6-26a4de9aab17"
createdAt: "2026-09-05T11:29:45.385Z"
updatedAt: "2026-09-05T11:29:45.385Z"
lastActiveAt: "2026-09-05T11:29:45.385Z"
activated: true
displayName: "Sample User"
description: "Sample user description"
}
modelId: "bb8c2e52-1c4d-4367-817c-9c93a274810b"
stream: "list"
type: "list-created"
version: null
snapshot: {
id: "bb8c2e52-1c4d-4367-817c-9c93a274810b"
name: "Sample List"
type: "list"
locked: false
pinned: false
schema: {
type: "object"
}
userId: "4707322d-a926-4158-9c0a-2aa8a2759ad8"
pathName: "sample-list"
createdAt: "2026-09-05T11:29:45.385Z"
updatedAt: "2026-09-05T11:29:45.385Z"
readonly: false
realtime: true
activated: true
indexable: true
protected: false
description: "This is a sample list"
}
attachments: {
data: {
name: "Sample List"
description: "This is a sample list"
pathName: "sample-list"
schema: {
type: "object"
}
pinned: false
readonly: false
realtime: true
activated: true
indexable: true
protected: false
}
}
}
]
}

Response headers

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