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/25be1147-b42a-496c-b348-7cb265cf4663/events \ -H "x-api-token: <YOUR TOKEN>"

Parameters

  • required
    listIdstringA list id or path name.
  • optional
    pagenumberhttps://api.jsonpad.io/lists/fdae36a8-1bd3-45c8-a57d-c9f43882debc/events?page=1The page number to fetch. Defaults to 1.
  • optional
    limitnumberhttps://api.jsonpad.io/lists/f4179dd2-3c7d-4704-9215-811661b0a230/events?limit=20The number of events to fetch per page. Defaults to 20.
  • optional
    orderstringhttps://api.jsonpad.io/lists/6e75a2ab-6473-4bfd-88bc-690d28ec2a6b/events?order=createdAt

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

    Valid values are:

    • createdAt
    • type
  • optional
    directionstringhttps://api.jsonpad.io/lists/f3f25014-d4b1-4876-8b8f-d675fffe918b/events?direction=asc

    The direction to order the events by.

    Valid values are:

    • asc
    • desc
  • optional
    startAtstringhttps://api.jsonpad.io/lists/38025e7f-872c-4030-a858-c1269523b2da/events?startAt=2026-11-02Filter for events after the specified date. This should be an ISO 8601 date.
  • optional
    endAtstringhttps://api.jsonpad.io/lists/ee2fea66-173f-4f61-9b8d-2d136575f39d/events?endAt=2026-11-02Filter for events before the specified date. This should be an ISO 8601 date.
  • optional
    typestringhttps://api.jsonpad.io/lists/0d96e950-e089-44ff-97aa-8d762e75a036/events?type=list-updated

    Filter for events by type.

    Valid types are:

    • list-created
    • list-updated
  • optional
    includeSnapshotbooleanhttps://api.jsonpad.io/lists/7c89c894-8e49-4e43-a338-b305136fef97/events?includeSnapshot=trueInclude each event's snapshot in the response. Defaults to false.
  • optional
    includeAttachmentsbooleanhttps://api.jsonpad.io/lists/ba25f08e-cb66-4f3b-ba94-2b0ca02f766c/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: "dc356cab-5db4-4f2a-917d-5b41045ecef4"
createdAt: "2026-11-02T13:22:57.526Z"
updatedAt: "2026-11-02T13:22:57.526Z"
user: {
id: "9101f0b2-5152-4696-a634-c3f3f7fa678c"
createdAt: "2026-11-02T13:22:57.526Z"
updatedAt: "2026-11-02T13:22:57.526Z"
lastActiveAt: "2026-11-02T13:22:57.526Z"
activated: true
displayName: "Sample User"
description: "Sample user description"
}
modelId: "94b0ea17-9388-4135-ae87-d65a6b20c060"
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