---
title: "Search events"
method: GET
path: "/events/search"
---

# Search events

`GET /events/search`

## Query parameters

- `eventId` string
- `eventName` string
- `userIdentifierType` 'mobile' | 'email' | 'userId'
- `userIdentifierValue` string
- `userIdentifierSource` string
- `userIdentifierAccountId` string
- `userGroupIdentifierType` 'groupId' | 'groupExternalId' | 'mobile' | 'email' | 'userId'
- `userGroupIdentifierValue` string
- `userGroupIdentifierSource` string
- `userGroupIdentifierAccountId` string
- `fromDate` string
- `tillDate` string
- `limit` string
- `offset` string
- `sortOrder` 'ASC' | 'DESC'
- `includeSideEffects` boolean
- `isDuplicate` boolean

## Response `200`

200

- union
  - object
    - `clickEventDataList` object[]
      - `orgId` integer
      - `userId` integer
      - `date` string
      - `eventName` string
      - `eventId` string
      - `source` string
      - `displayName` string
      - `additonalAttributes` object
        - `accountId` unknown
        - `age` string
        - `autoUpdateTimeStamp` integer
        - `customerId` string
        - `displayName` string
        - `eventDateTime` string
        - `eventName` string
        - `external_event_id` string
        - `hotel_name` string
        - `isDuplicate` boolean
        - `orgId` integer
        - `room_nights` string
        - `source` string
        - `source_till_id` unknown
        - `source_user_id` integer
      - `psiAttributes` string[]
    - `totalRecords` integer
    - `warnings` unknown[]
      - unknown
  - object
    - `clickEventDataList` object[]
      - `orgId` integer
      - `userId` integer
      - `date` string
      - `eventName` string
      - `eventId` string
      - `source` string
      - `tillCode` string
      - `displayName` string
      - `additonalAttributes` object
        - `Transaction_ID` string
        - `accountId` unknown
        - `autoUpdateTimeStamp` integer
        - `customerId` string
        - `displayName` string
        - `eventDateTime` string
        - `eventName` string
        - `isDuplicate` boolean
        - `orgId` integer
        - `source` string
        - `source_till_id` integer
        - `source_user_id` integer
      - `psiAttributes` string[]
    - `totalRecords` integer
    - `warnings` unknown[]
      - unknown
  - object
    - `clickEventDataList` object[]
      - `orgId` integer
      - `userId` integer
      - `date` string
      - `eventName` string
      - `eventId` string
      - `source` string
      - `tillCode` string
      - `displayName` string
      - `additonalAttributes` object
        - `Transaction_ID` string
        - `accountId` unknown
        - `autoUpdateTimeStamp` integer
        - `customerId` string
        - `displayName` string
        - `eventDateTime` string
        - `eventName` string
        - `isDuplicate` boolean
        - `orgId` integer
        - `source` string
        - `source_till_id` integer
        - `source_user_id` integer
      - `psiAttributes` string[]
    - `totalRecords` integer
    - `warnings` unknown[]
      - unknown
  - object
    - `clickEventDataList` object[]
      - `orgId` integer
      - `userId` integer
      - `date` string
      - `eventName` string
      - `eventId` string
      - `source` string
      - `tillCode` string
      - `displayName` string
      - `additonalAttributes` object
        - `Transaction_ID` string
        - `accountId` unknown
        - `autoUpdateTimeStamp` integer
        - `customerId` string
        - `displayName` string
        - `eventDateTime` string
        - `eventName` string
        - `isDuplicate` boolean
        - `orgId` integer
        - `source` string
        - `source_till_id` integer
        - `source_user_id` integer
      - `psiAttributes` string[]
      - `clickEventSideEffects` object
        - `requestId` string
        - `sideEffects` unknown[]
          - unknown
    - `totalRecords` integer
    - `warnings` unknown[]
      - unknown

## Other responses

- `400` — 400

---

[API](https://skmtc.net/capillarytech/apis/sample-api.md) · [All operations](https://skmtc.net/capillarytech/apis/sample-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/capillarytech/sample-api/revisions/de241f2ed9b3/schema)