No results

Fetch index events

Fetch a page of events for an index.

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

Example

cURL
123curl https://api.jsonpad.io/lists/b7085c50-7303-4b6b-847e-41b0e7d31485/indexes/93b2c2ec-f81a-407e-a650-996e4f2c27d9/events \
  -H "Content-Type: application/json" \
  -H "x-api-token: <YOUR TOKEN>"

Parameters

  • required
    listIdstringA list id or path name.
  • required
    indexIdstringAn index id or path name.
  • optional
    pagenumberhttps://api.jsonpad.io/lists/feb8c67f-2c63-4f19-8e1c-3ee1519a1587/indexes/$c2fbddff-2f38-4ebb-877e-5a58f1263f56/events?page=1The page number to fetch. Defaults to 1.
  • optional
    limitnumberhttps://api.jsonpad.io/lists/e912dc06-c4a5-44d2-9611-93d314c63f3e/indexes/$0f98fe34-3989-4d80-ad6a-42420b98b854/events?limit=20The number of events to fetch per page. Defaults to 20.
  • optional
    orderstringhttps://api.jsonpad.io/lists/c04768af-16b0-4f47-9ee0-a4d032ef5b5b/indexes/$aa6f2ab9-8100-4b71-9fb3-48624bd2df3a/events?order=createdAt

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

    Valid values are:

    • createdAt
    • type
  • optional
    directionstringhttps://api.jsonpad.io/lists/defe2b23-cee2-4ef4-992f-977e41c4fe02/indexes/$7b9f9670-5eb4-4e4c-a3ed-6f8929d9de8c/events?direction=asc

    The direction to order the events by.

    Valid values are:

    • asc
    • desc
  • optional
    startAtstringhttps://api.jsonpad.io/lists/bd74ccb5-b919-4517-aa6b-59d56fb83cce/indexes/61e3af07-6244-4cfb-b90a-9df4373a029e/events?startAt=2026-09-05Filter for events after the specified date. This should be an ISO 8601 date.
  • optional
    endAtstringhttps://api.jsonpad.io/lists/d63473d4-7479-4234-92e5-cf31aa8fb1af/indexes/80a9c1f3-a00c-49a1-b1f7-7b7a00af23a0/events?endAt=2026-09-05Filter for events before the specified date. This should be an ISO 8601 date.
  • optional
    typestringhttps://api.jsonpad.io/lists/fae42775-348b-41a9-8ad1-3d8c0e7998e2/indexes/$1ded5547-6229-4ac3-b1c7-7b71fbb00bbc/events?type=index-updated

    Filter for events by type.

    Valid types are:

    • index-created
    • index-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: "25ae2899-5163-48a1-9c92-d850ee16365c"
createdAt: "2026-09-05T11:30:23.370Z"
updatedAt: "2026-09-05T11:30:23.370Z"
user: {
id: "3a6c8e08-ac51-4b38-8c9b-5b6f148f14fb"
createdAt: "2026-09-05T11:30:23.370Z"
updatedAt: "2026-09-05T11:30:23.370Z"
lastActiveAt: "2026-09-05T11:30:23.370Z"
activated: true
displayName: "Sample User"
description: "Sample user description"
}
modelId: "c234c52a-f011-4954-9bb6-fbd830c18885"
stream: "index"
type: "index-created"
version: null
snapshot: {
id: "c234c52a-f011-4954-9bb6-fbd830c18885"
name: "Test Index"
type: "index"
alias: false
listId: "58415700-0c6c-4ded-aaec-8a6bb81d28e7"
locked: false
pointer: "/name"
sorting: true
pathName: "sample-index"
activated: true
createdAt: "2026-09-05T11:30:23.370Z"
filtering: true
searching: true
updatedAt: "2026-09-05T11:30:23.370Z"
valueType: "string"
description: "Sample index description"
defaultOrderDirection: "asc"
}
attachments: {
data: {
list: "sample-list"
name: "Sample Index"
alias: false
pointer: "/name"
sorting: true
pathName: "sample-index"
activated: true
filtering: true
searching: true
valueType: "string"
description: "Sample index description"
defaultOrderDirection: "asc"
}
}
}
]
}

Response headers

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