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

# Search and list Asset Groups

`POST /app/v1/asset_groups/search`

## Request body

- object
  - `page` number — Which page to return
  - `page_size` number — How many items to list in a page
  - `sort_by` 'name' | 'status' | 'asset_group_type_id' | 'created_at' | 'updated_at'
  - `sort_direction` 'asc' | 'desc' — Sort direction
  - `filter` object — A filter object for Asset Group 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
    - `status` 'active' | 'inactive'
    - `asset.id` string
    - `created_at` string
    - `created_by` string
    - `updated_at` string
    - `updated_by` string
    - `custom_attributes` object

## Response `200`

Successfully something

- PagedAssetGroupWithAssetsList
  - `page_number` number
  - `page_size` number
  - `total_entries` number
  - `total_pages` number
  - `data` AssetGroupWithAssets[]
    - `name` string
    - `status` 'active' | 'inactive'
    - `asset_group_type_id` 'network'
    - `default_network_reporting_group_id` string
    - `default_network_reporting_group` ReportingGroupInput
      - `name` string
      - `description` string
      - `priority` number — default to 1
      - `id` string
    - `default_estimation_method_id` string, uuid
    - `default_estimation_method` EstimationMethodResponse
      - `id` string, uuid, required
      - `company_id` string, uuid, required
      - `asset_id` string, uuid, required
      - `analytics_library_id` string, required
      - `analytics_calculator_id` string, required
      - `name` string, required
      - `status` 'active' | 'inactive', required
      - `default_values` object, required
      - `default_asset_values` object, required
      - `created_at` union, required
        - string, date-time
        - string, nullable
        - unknown
      - `updated_at` union, required
        - string, date-time
        - string, nullable
        - unknown
      - `created_by` string, uuid, required
      - `updated_by` string, uuid, required
    - `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
    - `custom_attributes` CustomAttributes
    - `assets` Asset[]
      - `id` string, uuid
      - `asset_type` 'equipment' | 'device' | 'facility' | 'flow'
    - `network_inlet_ids` string[]

---

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