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/40df2822-cd6e-4175-9ef9-5ba1ef5bc131/indexes/1d70e2d1-060f-4f8a-bf06-c362af211f43/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/4eab0016-452e-4c32-bb9a-bdbaa06b388f/indexes/$906dd495-a289-4259-b35c-ca2695eb7201/events?page=1The page number to fetch. Defaults to 1.
  • optional
    limitnumberhttps://api.jsonpad.io/lists/cabb9e33-7318-46f1-a822-a1b4321ba450/indexes/$d10dc916-8158-495a-8826-dfb25f4b8d23/events?limit=20The number of events to fetch per page. Defaults to 20.
  • optional
    orderstringhttps://api.jsonpad.io/lists/f06cb84a-cb9a-4ffb-8c18-ceac061f949c/indexes/$bde04b35-4c11-46d2-a847-c476cac0d344/events?order=createdAt

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

    Valid values are:

    • createdAt
    • type
  • optional
    directionstringhttps://api.jsonpad.io/lists/f45d9315-3a00-4e8a-908e-ed26cfdd70b2/indexes/$8c249a17-74ec-4580-ab00-d45805eaee49/events?direction=asc

    The direction to order the events by.

    Valid values are:

    • asc
    • desc
  • optional
    startAtstringhttps://api.jsonpad.io/lists/1bddbc6c-91cb-47eb-9f37-bfd2a0b51f90/indexes/2858b575-71b2-4c77-9039-6348bb5cc738/events?startAt=2026-09-23Filter for events after the specified date. This should be an ISO 8601 date.
  • optional
    endAtstringhttps://api.jsonpad.io/lists/829b677c-1168-4e74-9b35-b935c3d5a142/indexes/373ff551-561c-44ff-b8b9-ce7a1c701f74/events?endAt=2026-09-23Filter for events before the specified date. This should be an ISO 8601 date.
  • optional
    typestringhttps://api.jsonpad.io/lists/23c84de8-05cb-40cc-91d0-ff51c7dca5bd/indexes/$fbbe6c0e-3d4c-495c-a376-12db15b1d837/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/0c4d6208-65c2-45dc-8ddd-7ab984f7228a/indexes/48109284-9b5a-4859-a2da-2b510a599d76/events?includeSnapshot=trueInclude each event's snapshot in the response. Defaults to false.
  • optional
    includeAttachmentsbooleanhttps://api.jsonpad.io/lists/7354cb99-0f10-4c22-9544-a618b883daef/indexes/462632b5-4324-4f75-b8ee-b7e59283df37/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: "62cc122c-6248-4ea0-b4e8-4417ba4e589f"
createdAt: "2026-09-23T21:08:35.705Z"
updatedAt: "2026-09-23T21:08:35.705Z"
user: {
id: "59cd1d21-f2d9-476a-9bf2-88a994bd5504"
createdAt: "2026-09-23T21:08:35.705Z"
updatedAt: "2026-09-23T21:08:35.705Z"
lastActiveAt: "2026-09-23T21:08:35.705Z"
activated: true
displayName: "Sample User"
description: "Sample user description"
}
modelId: "992b7d8f-1144-414f-b4f5-30226bbf4bc4"
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