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/09278850-149d-45d4-90a2-cf0af327ff9b/events \ -H "x-api-token: <YOUR TOKEN>"

Parameters

  • required
    listIdstringA list id or path name.
  • optional
    pagenumberhttps://api.jsonpad.io/lists/ec0a6197-029d-40df-bda4-f75e9d326976/events?page=1The page number to fetch. Defaults to 1.
  • optional
    limitnumberhttps://api.jsonpad.io/lists/ba9649cc-ac65-4010-9b37-43001b65ede7/events?limit=20The number of events to fetch per page. Defaults to 20.
  • optional
    orderstringhttps://api.jsonpad.io/lists/5f1e192d-636d-4fa5-8a03-f5137e1162b3/events?order=createdAt

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

    Valid values are:

    • createdAt
    • type
  • optional
    directionstringhttps://api.jsonpad.io/lists/c11d477e-bb8e-4899-ae98-987b5f10918c/events?direction=asc

    The direction to order the events by.

    Valid values are:

    • asc
    • desc
  • optional
    startAtstringhttps://api.jsonpad.io/lists/97ba7c6b-ee8d-4830-97ea-b44c1d867c98/events?startAt=2026-10-07Filter for events after the specified date. This should be an ISO 8601 date.
  • optional
    endAtstringhttps://api.jsonpad.io/lists/4f502c3d-0f2e-488a-9936-b592e7e66d0b/events?endAt=2026-10-07Filter for events before the specified date. This should be an ISO 8601 date.
  • optional
    typestringhttps://api.jsonpad.io/lists/8f43ec8b-c3a0-42be-9eeb-e36843c1fdac/events?type=list-updated

    Filter for events by type.

    Valid types are:

    • list-created
    • list-updated
  • optional
    includeSnapshotbooleanhttps://api.jsonpad.io/lists/b7487edb-e526-47e6-b004-de8887b446d8/events?includeSnapshot=trueInclude each event's snapshot in the response. Defaults to false.
  • optional
    includeAttachmentsbooleanhttps://api.jsonpad.io/lists/2aa16f3d-39ad-455f-9caf-abc6a4f56bc1/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: "9f1c00b7-3819-4c6a-9325-a5b3cac0258b"
createdAt: "2026-10-07T22:12:03.053Z"
updatedAt: "2026-10-07T22:12:03.053Z"
user: {
id: "b7fcc1f2-d5e9-4cc7-99ea-4081a97e80e0"
createdAt: "2026-10-07T22:12:03.053Z"
updatedAt: "2026-10-07T22:12:03.053Z"
lastActiveAt: "2026-10-07T22:12:03.053Z"
activated: true
displayName: "Sample User"
description: "Sample user description"
}
modelId: "b762aa12-517a-4145-830f-5c4625580b08"
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