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

# Search and list records

`POST /app/v1/records/search`

## Query parameters

- `asset_detail` string

## Request body

- object
  - `page` number — Which page to return
  - `page_size` number — How many items to list in a page
  - `sort_by` string — any field from group_by param
  - `sort_direction` 'asc' | 'desc' — sort direction
  - `filter` RecordFilterFields
    - `facility.custom_attributes` object
    - `facility.id` string
    - `facility.name` string
    - `facility.status` string
    - `equipment.custom_attributes` object
    - `equipment.id` string
    - `equipment.name` string
    - `equipment.status` 'active' | 'inactive' | 'deprecated'
    - `equipment.type.id` string
    - `equipment.type.name` string
    - `equipment.facility.custom_attributes` object
    - `equipment.facility.id` string
    - `equipment.facility.name` string
    - `equipment.facility.status` string
    - `device.attributes` object
    - `device.custom_attributes` object
    - `device.id` string
    - `device.measurement_types` string
    - `device.name` string
    - `device.status` string
    - `device.type_id` string
    - `flow.id` string
    - `flow.name` string
    - `flow.status` 'active' | 'inactive'
    - `flow.type` string — Use `id` value of any index in `GET /v1/flow_types`
    - `flow.product_type` string — Use `id` value of any index in `GET /v1/product_types`
    - `flow.product_category` string — Use `id` value of any index in `GET /v1/product_categories`
    - `flow.custom_attributes` CustomAttributes
    - `flow.associated_facility_id` string, uuid
    - `flow.associated_equipment_id` string, uuid
    - `id` string, uuid — record ID
    - `asset_type` 'equipment' | 'device' | 'facility' | 'flow' | 'asset_group'
    - `asset_id` string, uuid
    - `reporting_group_id` string
    - `year_month` string
    - `measurement_type` string
    - `record_value.id` string, uuid — record value ID
    - `flow.associated_facility.custom_attributes` object
    - `flow.associated_equipment.custom_attributes` object
  - `group_by` string[]

## Response `200`

A successful operation

- PagedAggregatedRecordValues
  - `page_number` number
  - `page_size` number
  - `total_entries` number
  - `total_pages` number
  - `data` object[]
    - `id` string, uuid
    - `reporting_group_id` string
    - `year_month` string
    - `values` object[] — Record value configurations are included when grouping by record or record value id
      - `measurement_type` string
      - `measurement_unit` string
      - `value` number
      - `configuration` union
        - object
          - `configuration_type` 'manual'
          - `value` number
          - `sources` object[]
        - object
          - `configuration_type` 'form_measurement'
          - `aggregate_function` 'avg' | 'sum'
          - `form_category_id` string, uuid
          - `measurement_ids` string[]
          - `sources` object[]
        - object
          - `configuration_type` 'calculator_result'
          - `aggregate_function` 'avg' | 'sum'
          - `calculator_result_ids` string[]
          - `sources` object[]
        - object
          - `configuration_type` 'measurement_series'
          - `aggregate_function` 'avg' | 'sum'
          - `measurement_series_id` string, uuid
          - `start` string, date-time
          - `end` string, date-time
          - `Interval` '1minute' | '15minute' | '1hour' | '1day'
          - `sources` object[]

---

[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)