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/fa77b62c-a1ec-442d-89c7-7ca0a5f4c1c8/indexes/60c2254b-3e43-4f90-a9fd-f1981bb576cd/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/9e7673c0-b5bc-4893-94a6-ed12ca55fa48/indexes/$98c69280-cc5d-4b9c-ba3f-4ba9fbfe6f52/events?page=1The page number to fetch. Defaults to 1.
  • optional
    limitnumberhttps://api.jsonpad.io/lists/ad89289f-c760-4617-aecd-849cfc026454/indexes/$1aa6d836-6f6b-49c8-8ede-8e876f8bbfde/events?limit=20The number of events to fetch per page. Defaults to 20.
  • optional
    orderstringhttps://api.jsonpad.io/lists/d29f2d64-4db8-4436-a37c-61b1bd7d006b/indexes/$9d7c6441-598d-4f86-86b0-3ba684bd158b/events?order=createdAt

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

    Valid values are:

    • createdAt
    • type
  • optional
    directionstringhttps://api.jsonpad.io/lists/5d33ba12-749a-4e2c-a94a-a482fee0769b/indexes/$55eef2d1-9b91-4196-8d51-8e3650230dab/events?direction=asc

    The direction to order the events by.

    Valid values are:

    • asc
    • desc
  • optional
    startAtstringhttps://api.jsonpad.io/lists/4a51536b-721b-487b-a2b2-3102ef75b0bb/indexes/cf56fd2a-e96d-42bb-9c96-4481632ee62f/events?startAt=2026-11-02Filter for events after the specified date. This should be an ISO 8601 date.
  • optional
    endAtstringhttps://api.jsonpad.io/lists/4e4d17d2-844e-45c3-8cb8-570915d26425/indexes/b6193c35-5495-4609-a513-3eced3c98245/events?endAt=2026-11-02Filter for events before the specified date. This should be an ISO 8601 date.
  • optional
    typestringhttps://api.jsonpad.io/lists/8db764eb-1260-4830-a1b9-9ee71a6bdabb/indexes/$7647ddf8-5324-4142-9769-57676d232389/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/94b4ecc9-0c9c-41f3-a47a-e9a65dd14235/indexes/ef804b66-de41-452c-a4a1-8ef52a412a54/events?includeSnapshot=trueInclude each event's snapshot in the response. Defaults to false.
  • optional
    includeAttachmentsbooleanhttps://api.jsonpad.io/lists/2c7939a9-e9e5-4091-b73a-f171ae555617/indexes/11dbc9d3-c9a6-4657-a76d-69c171556ccd/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: "61624bab-5de2-4f3e-b426-7bcf70c9ff68"
createdAt: "2026-11-02T13:23:26.568Z"
updatedAt: "2026-11-02T13:23:26.568Z"
user: {
id: "7dcab803-0fc8-4905-929c-479fa679ebcb"
createdAt: "2026-11-02T13:23:26.568Z"
updatedAt: "2026-11-02T13:23:26.568Z"
lastActiveAt: "2026-11-02T13:23:26.568Z"
activated: true
displayName: "Sample User"
description: "Sample user description"
}
modelId: "ac81f6ad-fbe2-471c-badb-64d593c71801"
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