---
title: "Search and list event schemas"
method: POST
path: "/app/v1/event_schemas/search"
tags: ["event_schemas"]
---

# Search and list event schemas

`POST /app/v1/event_schemas/search`

## Request body

- object
  - `page` number — Which page to return
  - `page_size` number — How many items to list in a page
  - `sort_by` 'name' | 'description' | 'status' | 'version' | 'priority' | 'event_category.id' | 'event_category.name'
  - `sort_direction` 'asc' | 'desc' — Sort direction
  - `filter` object — A filter object for Event Schemas where it can filter based on any of these following fields. No fields are mandatory and the syntax is roughly the same as MongoDB querying.
    - `id` string
    - `name` string
    - `description` string
    - `status` string
    - `version` string
    - `priority` string
    - `event_category.id` string
    - `event_category.name` string
    - `created_at` string, date-time
    - `updated_at` string, date-time

## Response `200`

A successful operation

- object
  - `page_number` number
  - `page_size` number
  - `total_entries` number
  - `total_pages` number
  - `data` EventSchema[]
    - `name` string
    - `version` string
    - `priority` 'high' | 'medium' | 'low'
    - `status` 'active' | 'archived'
    - `description` string
    - `config` EventSchemaConfig
      - `has_due_date` boolean
      - `due_date` object
        - `relative_time` boolean
        - `time_period` string
        - `duration` number
      - `has_forms` boolean
      - `forms` object
        - `required_templates` string[]
        - `suggested_templates` string[]
      - `has_alerts` boolean
      - `has_flows` boolean
      - `has_equipment` boolean
      - `equipment` object
        - `is_mandatory` boolean
        - `has_source` boolean
      - `has_devices` boolean
    - `event_category_id` string, uuid
    - `id` string, uuid
    - `company_id` string, uuid
    - `created_at` string, date-time
    - `created_by` string, uuid
    - `updated_at` string, date-time
    - `updated_by` string, uuid

---

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