Fetch identity events

Fetch a page of events for an identity.

GET https://api.jsonpad.io/identities/{identityId}/events

Example

cURL
12curl https://api.jsonpad.io/identities/f999e677-e505-4039-be2f-632de3024754/events \ -H "x-api-token: <YOUR TOKEN>"

Parameters

  • required
    identityIdstringAn identity id.
  • optional
    pagenumberhttps://api.jsonpad.io/identities/39d60771-eda5-473a-bbe3-c592720ee689/events?page=1The page number to fetch. Defaults to 1.
  • optional
    limitnumberhttps://api.jsonpad.io/identities/4d12cc2e-581d-4b77-beda-2b00575e89cf/events?limit=20The number of events to fetch per page. Defaults to 20.
  • optional
    orderstringhttps://api.jsonpad.io/identities/bf814f43-2a45-4fa6-ba2f-0b656782db41/events?order=createdAt

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

    Valid values are:

    • createdAt
    • type
  • optional
    directionstringhttps://api.jsonpad.io/identities/f900e5d7-5c12-479e-8b59-3da9be09978f/events?direction=asc

    The direction to order the events by.

    Valid values are:

    • asc
    • desc
  • optional
    startAtstringhttps://api.jsonpad.io/identities/d940e750-d50b-4210-a746-895218161f7d/events?startAt=2026-11-02Filter for events after the specified date. This should be an ISO 8601 date.
  • optional
    endAtstringhttps://api.jsonpad.io/identities/184fcc74-ef17-49bb-a6d3-413e99ab10d1/events?endAt=2026-11-02Filter for events before the specified date. This should be an ISO 8601 date.
  • optional
    typestringhttps://api.jsonpad.io/identities/e1360686-dea8-4b06-b3dc-d7a68826d76d/events?type=identity-updated

    Filter for events by type.

    Valid types are:

    • identity-created
    • identity-updated
    • identity-updated-self
    • identity-registered
    • identity-logged-in
    • identity-logged-out
    • identity-sessions-revoked
    • identity-password-reset-requested
    • identity-password-reset
    • identity-email-verification-requested
    • identity-email-verified
    • identity-provider-linked
    • identity-provider-unlinked

    identity-created, identity-updated and the password reset and email verification events happen when you or your server act on an identity; identity-registered, identity-logged-in, identity-logged-out, identity-updated-self and the provider events happen when the identity acts for itself. See the event log.

  • optional
    includeSnapshotbooleanhttps://api.jsonpad.io/identities/21febc86-b0af-43cd-b780-f1838ffc28b7/events?includeSnapshot=trueInclude each event's snapshot in the response. Defaults to false.
  • optional
    includeAttachmentsbooleanhttps://api.jsonpad.io/identities/db3cca30-c184-466c-b7d4-e8da6b1651df/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: "e512d1e4-284a-4269-9506-5db0d29b35aa"
createdAt: "2026-11-02T13:23:37.316Z"
updatedAt: "2026-11-02T13:23:37.316Z"
user: {
id: "4871132d-37ad-4c9e-9443-de0fb2f7980f"
createdAt: "2026-11-02T13:23:37.316Z"
updatedAt: "2026-11-02T13:23:37.316Z"
lastActiveAt: "2026-11-02T13:23:37.316Z"
activated: true
displayName: "Sample User"
description: "Sample user description"
}
modelId: "400ddd51-3e9c-4c31-9d30-bfa984484d95"
stream: "identity"
type: "identity-created"
version: null
}
]
}

Response headers

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