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

Fetch list events

Fetch a page of events for a list.

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

Example

cURL
12curl https://api.jsonpad.io/lists/79f8b421-4a08-4bb8-afee-17926f167992/events \ -H "x-api-token: <YOUR TOKEN>"

Parameters

  • required
    listIdstringA list id or path name.
  • optional
    pagenumberhttps://api.jsonpad.io/lists/912e53cc-eb2c-4c1d-887a-c2de65228b84/events?page=1The page number to fetch. Defaults to 1.
  • optional
    limitnumberhttps://api.jsonpad.io/lists/fdfd1c27-e4ae-4540-97f3-553fe2f9498f/events?limit=20The number of events to fetch per page. Defaults to 20.
  • optional
    orderstringhttps://api.jsonpad.io/lists/75c8a907-383b-4e93-8a55-e67e2d4191b6/events?order=createdAt

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

    Valid values are:

    • createdAt
    • type
  • optional
    directionstringhttps://api.jsonpad.io/lists/7c9b0af9-fe3c-46c6-b690-7f966ece7a81/events?direction=asc

    The direction to order the events by.

    Valid values are:

    • asc
    • desc
  • optional
    startAtstringhttps://api.jsonpad.io/lists/50603038-f28c-40a9-80b0-7494ca922fa6/events?startAt=2026-09-23Filter for events after the specified date. This should be an ISO 8601 date.
  • optional
    endAtstringhttps://api.jsonpad.io/lists/87f40c31-cfa1-42d2-8233-5e4d6e086d72/events?endAt=2026-09-23Filter for events before the specified date. This should be an ISO 8601 date.
  • optional
    typestringhttps://api.jsonpad.io/lists/40d68d0a-e62e-45ba-a5f6-c3731ad94279/events?type=list-updated

    Filter for events by type.

    Valid types are:

    • list-created
    • list-updated
  • optional
    includeSnapshotbooleanhttps://api.jsonpad.io/lists/43c6394f-05a1-4e1e-9f50-9e5c0ce92d42/events?includeSnapshot=trueInclude each event's snapshot in the response. Defaults to false.
  • optional
    includeAttachmentsbooleanhttps://api.jsonpad.io/lists/ecfbbad3-0fbf-44ab-990b-3d7aea027819/events?includeAttachments=trueInclude each event's attachments in the response. Defaults to false.

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: "c48b6225-340d-4833-a640-7fe3d09544b0"
createdAt: "2026-09-23T21:08:08.034Z"
updatedAt: "2026-09-23T21:08:08.034Z"
user: {
id: "b85371ce-134b-44b0-adee-4724ac59d373"
createdAt: "2026-09-23T21:08:08.034Z"
updatedAt: "2026-09-23T21:08:08.034Z"
lastActiveAt: "2026-09-23T21:08:08.034Z"
activated: true
displayName: "Sample User"
description: "Sample user description"
}
modelId: "2f061fc9-a7ad-43af-a620-2a39fca5c30c"
stream: "list"
type: "list-created"
version: null
}
]
}

Response headers

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