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

Fetch index events

Fetch a page of events for an index.

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

Example

cURL
12curl https://api.jsonpad.io/lists/42a091be-afd2-4ce0-be5f-f0346fe40221/indexes/431c9d65-8e6e-4c51-9e44-fedc43186bd0/events \ -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/8f8c97df-2e1f-4076-9c11-e7c7bbf0f68c/indexes/$7961517f-43b8-4b27-8107-95924d76f80b/events?page=1The page number to fetch. Defaults to 1.
  • optional
    limitnumberhttps://api.jsonpad.io/lists/e4a309bd-d889-4580-b182-2e70a545f520/indexes/$b4a29def-f554-4a82-85cf-dbf016bf59a7/events?limit=20The number of events to fetch per page. Defaults to 20.
  • optional
    orderstringhttps://api.jsonpad.io/lists/12a3b3a5-3cf4-4f92-a28c-1c160480ae5e/indexes/$7a9d15e4-a03c-4d9b-8f44-4948ae71948b/events?order=createdAt

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

    Valid values are:

    • createdAt
    • type
  • optional
    directionstringhttps://api.jsonpad.io/lists/19402af3-bf45-4e26-b38b-411d3cc1e2cc/indexes/$45ea3a4d-bf55-429a-ae22-070728b4c083/events?direction=asc

    The direction to order the events by.

    Valid values are:

    • asc
    • desc
  • optional
    startAtstringhttps://api.jsonpad.io/lists/17687a71-5cb3-406c-a2bc-2fe7cc04b5ad/indexes/40043e0b-f339-4f51-beb9-357d40e70e2a/events?startAt=2026-10-07Filter for events after the specified date. This should be an ISO 8601 date.
  • optional
    endAtstringhttps://api.jsonpad.io/lists/e9163f21-bce4-4c57-9a2b-c9642ff68526/indexes/03cd49bf-e207-4c22-add7-d5496bbf14f7/events?endAt=2026-10-07Filter for events before the specified date. This should be an ISO 8601 date.
  • optional
    typestringhttps://api.jsonpad.io/lists/adcb99fa-2484-4da8-a73d-368adc751de5/indexes/$971902ba-d015-4c13-86bc-fc7a44f02901/events?type=index-updated

    Filter for events by type.

    Valid types are:

    • index-created
    • index-updated
    • index-build-requested
    • index-built
    • index-build-failed

    The build events record when an index was rebuilt, and whether it worked.

  • optional
    includeSnapshotbooleanhttps://api.jsonpad.io/lists/3b7af78b-c539-4ba5-bb6e-a56147d5fb84/indexes/96b32f1f-9f59-427c-83bd-95fe920bba34/events?includeSnapshot=trueInclude each event's snapshot in the response. Defaults to false.
  • optional
    includeAttachmentsbooleanhttps://api.jsonpad.io/lists/9507cd37-f242-42db-91f8-c49cc557518c/indexes/2df7c04f-c072-425a-8504-efffa50a2c16/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: "65e6c5f6-43e3-430b-af53-af1a3655a396"
createdAt: "2026-10-07T22:12:31.635Z"
updatedAt: "2026-10-07T22:12:31.635Z"
user: {
id: "b20d5598-bbbb-4ac6-8e21-f862358b9fe7"
createdAt: "2026-10-07T22:12:31.635Z"
updatedAt: "2026-10-07T22:12:31.635Z"
lastActiveAt: "2026-10-07T22:12:31.635Z"
activated: true
displayName: "Sample User"
description: "Sample user description"
}
modelId: "905f731b-04c5-40b4-926e-8375aa276b14"
stream: "index"
type: "index-created"
version: null
}
]
}

Response headers

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