---
title: "List Change Event"
method: POST
path: "/change-events/get-list"
tags: ["Change Event"]
---

# List Change Event

`POST /change-events/get-list`

## Request

- Base URL: `https://oneuptime.com/api`
- URL: `https://oneuptime.com/api/change-events/get-list`
- Auth: API key in header `APIKey`
- TypeScript: <https://skmtc.dev/oneuptime/apis/oneuptime-openapi-specification/docs/change-events/get-list/post.ts> (a function with typed inputs; its response is checked against the schema)

Endpoint to list all Change Event items

## Request body

- object
  - `query` ChangeEventV1QuerySchema: Query schema for ChangeEventV1. A field takes a plain value, which it matches exactly, or an operator its type allows. Telemetry tables are large: bound every query by time.
    - `projectId` union: Query operators for projectId field of type Object ID. Supported operators: EqualTo, NotEqual, IsNull, NotNull, Includes.
      - string
      - object
        - `_type` 'NotEqual', required
        - `value` string, required
      - object
        - `_type` 'IsNull', required
      - object
        - `_type` 'NotNull', required
      - object
        - `_type` 'Includes', required
        - `value` string[], required
    - `primaryEntityId` union: Query operators for primaryEntityId field of type Object ID. Supported operators: EqualTo, NotEqual, IsNull, NotNull, Includes.
      - string
      - object
        - `_type` 'NotEqual', required
        - `value` string, required
      - object
        - `_type` 'IsNull', required
      - object
        - `_type` 'NotNull', required
      - object
        - `_type` 'Includes', required
        - `value` string[], required
    - `primaryEntityType` union: Query operators for primaryEntityType field of type Text. Supported operators: EqualTo, NotEqual, IsNull, NotNull, Includes, EqualToOrNull, Search.
      - string
      - object
        - `_type` 'NotEqual', required
        - `value` string, required
      - object
        - `_type` 'IsNull', required
      - object
        - `_type` 'NotNull', required
      - object
        - `_type` 'Includes', required
        - `value` string[], required
      - object
        - `_type` 'EqualToOrNull', required
        - `value` string, required
      - object
        - `_type` 'Search', required
        - `value` string, required
    - `time` union: Query operators for time field of type DateTime64. Supported operators: EqualTo, NotEqual, IsNull, NotNull, GreaterThan, GreaterThanOrEqual, LessThan, LessThanOrEqual, InBetween. Times are ISO-8601, such as 2026-01-01T00:00:00.000Z.
      - string, date-time
      - object
        - `_type` 'NotEqual', required
        - `value` string, date-time, required
      - object
        - `_type` 'IsNull', required
      - object
        - `_type` 'NotNull', required
      - object
        - `_type` 'GreaterThan', required
        - `value` string, date-time, required
      - object
        - `_type` 'GreaterThanOrEqual', required
        - `value` string, date-time, required
      - object
        - `_type` 'LessThan', required
        - `value` string, date-time, required
      - object
        - `_type` 'LessThanOrEqual', required
        - `value` string, date-time, required
      - object
        - `_type` 'InBetween', required
        - `startValue` string, date-time, required
        - `endValue` string, date-time, required
    - `eventType` union: Query operators for eventType field of type Text. Supported operators: EqualTo, NotEqual, IsNull, NotNull, Includes, EqualToOrNull, Search.
      - string
      - object
        - `_type` 'NotEqual', required
        - `value` string, required
      - object
        - `_type` 'IsNull', required
      - object
        - `_type` 'NotNull', required
      - object
        - `_type` 'Includes', required
        - `value` string[], required
      - object
        - `_type` 'EqualToOrNull', required
        - `value` string, required
      - object
        - `_type` 'Search', required
        - `value` string, required
    - `title` union: Query operators for title field of type Text. Supported operators: EqualTo, NotEqual, IsNull, NotNull, Includes, EqualToOrNull, Search.
      - string
      - object
        - `_type` 'NotEqual', required
        - `value` string, required
      - object
        - `_type` 'IsNull', required
      - object
        - `_type` 'NotNull', required
      - object
        - `_type` 'Includes', required
        - `value` string[], required
      - object
        - `_type` 'EqualToOrNull', required
        - `value` string, required
      - object
        - `_type` 'Search', required
        - `value` string, required
    - `description` union: Query operators for description field of type Text. Supported operators: EqualTo, NotEqual, IsNull, NotNull, Includes, EqualToOrNull, Search.
      - string
      - object
        - `_type` 'NotEqual', required
        - `value` string, required
      - object
        - `_type` 'IsNull', required
      - object
        - `_type` 'NotNull', required
      - object
        - `_type` 'Includes', required
        - `value` string[], required
      - object
        - `_type` 'EqualToOrNull', required
        - `value` string, required
      - object
        - `_type` 'Search', required
        - `value` string, required
    - `attributes` object: Query operators for attributes field of type Map(String, String). Supported operators: EqualTo, NotEqual, IsNull, NotNull, Search. Filtered by key, each key with these operators: {"attributes": {"<key>": <value or operator>}}.
    - `attributeKeys` union: Query operators for attributeKeys field of type Array of Text. Supported operators: EqualTo, NotEqual, IsNull, NotNull, Includes, Search. EqualTo, NotEqual and Search match one element; Includes matches any of several.
      - object
        - `_type` 'EqualTo', required
        - `value` string, required
      - object
        - `_type` 'NotEqual', required
        - `value` string, required
      - object
        - `_type` 'IsNull', required
      - object
        - `_type` 'NotNull', required
      - object
        - `_type` 'Includes', required
        - `value` string[], required
      - object
        - `_type` 'Search', required
        - `value` string, required
    - `_id` union: Query operators for _id field of type Object ID. Supported operators: EqualTo, NotEqual, IsNull, NotNull, Includes.
      - string
      - object
        - `_type` 'NotEqual', required
        - `value` string, required
      - object
        - `_type` 'IsNull', required
      - object
        - `_type` 'NotNull', required
      - object
        - `_type` 'Includes', required
        - `value` string[], required
    - `createdAt` union: Query operators for createdAt field of type Date. Supported operators: EqualTo, NotEqual, IsNull, NotNull, GreaterThan, GreaterThanOrEqual, LessThan, LessThanOrEqual, InBetween. Times are ISO-8601, such as 2026-01-01T00:00:00.000Z.
      - string, date-time
      - object
        - `_type` 'NotEqual', required
        - `value` string, date-time, required
      - object
        - `_type` 'IsNull', required
      - object
        - `_type` 'NotNull', required
      - object
        - `_type` 'GreaterThan', required
        - `value` string, date-time, required
      - object
        - `_type` 'GreaterThanOrEqual', required
        - `value` string, date-time, required
      - object
        - `_type` 'LessThan', required
        - `value` string, date-time, required
      - object
        - `_type` 'LessThanOrEqual', required
        - `value` string, date-time, required
      - object
        - `_type` 'InBetween', required
        - `startValue` string, date-time, required
        - `endValue` string, date-time, required
  - `select` ChangeEventV1SelectSchema: Select schema for ChangeEventV1. Set fields to true to include them in the response.
    - `projectId` boolean
    - `primaryEntityId` boolean
    - `primaryEntityType` boolean
    - `time` boolean
    - `eventType` boolean
    - `title` boolean
    - `description` boolean
    - `attributes` boolean
    - `attributeKeys` boolean
    - `_id` boolean
    - `createdAt` boolean
  - `sort` ChangeEventV1SortSchema: Sort schema for ChangeEventV1. Only sortable fields are included.
    - `projectId` 'ASC' | 'DESC': Sort order for projectId field
    - `primaryEntityId` 'ASC' | 'DESC': Sort order for primaryEntityId field
    - `primaryEntityType` 'ASC' | 'DESC': Sort order for primaryEntityType field
    - `time` 'ASC' | 'DESC': Sort order for time field
    - `eventType` 'ASC' | 'DESC': Sort order for eventType field
    - `title` 'ASC' | 'DESC': Sort order for title field
    - `description` 'ASC' | 'DESC': Sort order for description field
    - `retentionDate` 'ASC' | 'DESC': Sort order for retentionDate field
    - `_id` 'ASC' | 'DESC': Sort order for _id field
    - `createdAt` 'ASC' | 'DESC': Sort order for createdAt field
  - `groupBy` ChangeEventV1GroupBySchema: Group by schema for ChangeEventV1. Only one field can be set to true for grouping.
    - `projectId` boolean: Group by projectId field. Only one field can be selected for grouping.
    - `primaryEntityId` boolean: Group by primaryEntityId field. Only one field can be selected for grouping.
    - `primaryEntityType` boolean: Group by primaryEntityType field. Only one field can be selected for grouping.
    - `eventType` boolean: Group by eventType field. Only one field can be selected for grouping.
    - `title` boolean: Group by title field. Only one field can be selected for grouping.
    - `description` boolean: Group by description field. Only one field can be selected for grouping.
    - `_id` boolean: Group by _id field. Only one field can be selected for grouping.
    - `createdAt` boolean: Group by createdAt field. Only one field can be selected for grouping.
  - `limit` number: Maximum number of items to return. Defaults to 10.
  - `skip` number: Number of items to skip for pagination. Defaults to 0.

## Response `200`

Successful response

- object
  - `data` ChangeEventV1[]
    - `projectId` string, required: Project ID
    - `primaryEntityId` string: Service ID
    - `primaryEntityType` string: Service Type
    - `time` string: Time
    - `eventType` string: Event Type
    - `title` string, required: Title
    - `description` string: Description
    - `attributes` string: Attributes
    - `attributeKeys` string[]: Attribute Keys
  - `count` number

## Other responses

- `400`: Bad request. This response indicates that the request was malformed or contained invalid data.
- `401`: Unauthorized. This response indicates that the request requires user authentication.
- `402`: Payment Required. This response indicates that the request requires payment or a valid subscription.
- `403`: Forbidden. This response indicates that the server understood the request, but refuses to authorize it.
- `405`: Project not found. This response indicates that the requested project does not exist or is not accessible.
- `408`: Request Timeout. This response indicates that the server timed out waiting for the request.
- `415`: Unable to reach server. This response indicates that the server is currently unreachable or down.
- `422`: Not authorized. This response indicates that the user does not have permission to access the requested resource.
- `500`: Internal Server Error. This response indicates that the server encountered an unexpected condition that prevented it from fulfilling the request.

---

[API](https://skmtc.dev/oneuptime/apis/oneuptime-openapi-specification.md) - [All operations](https://skmtc.dev/oneuptime/apis/oneuptime-openapi-specification/llms.txt) - [OpenAPI document](https://skmtc.dev/oneuptime/apis/oneuptime-openapi-specification/revisions/ba3307d00304?raw)