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

# Search and list Estimation Methods

`POST /app/v1/estimation_methods/search`

## Query parameters

- `period` string

## Request body

- object
  - `page` number — Which page to return
  - `page_size` number — How many items to list in a page
  - `sort_by` 'name' | 'entity_id' | 'entity_type' | 'analytics_library_id' | 'analytics_calculator_id' | 'created_at' | 'updated_at'
  - `sort_direction` 'asc' | 'desc' — Sort direction
  - `filter` object — A filter object for Estimation Methods 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.
    - `equipment.custom_attributes` object
    - `equipment.id` string
    - `equipment.name` string
    - `equipment.status` 'active' | 'inactive' | 'deprecated'
    - `equipment.type.id` string
    - `equipment.type.name` 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
    - `equipment.facility.custom_attributes` object
    - `equipment.facility.id` string
    - `equipment.facility.name` string
    - `equipment.facility.status` string
    - `flow.facility.custom_attributes` object
    - `flow.facility.id` string
    - `flow.facility.name` string
    - `flow.facility.status` string
    - `flow.equipment.custom_attributes` object
    - `flow.equipment.id` string
    - `flow.equipment.name` string
    - `flow.equipment.status` 'active' | 'inactive' | 'deprecated'
    - `flow.equipment.type.id` string
    - `id` string
    - `name` string
    - `entity_id` string
    - `entity_type` 'equipment' | 'flow' | 'asset_group'
    - `analytics_library_id` string
    - `analytics_calculator_id` string
    - `status` string
    - `created_at` string
    - `created_by` string
    - `updated_at` string
    - `updated_by` string
    - `reporting_group_id` string

## Response `200`

Successfully something

- PagedEstimationMethodList
  - `page_number` number
  - `page_size` number
  - `total_entries` number
  - `total_pages` number
  - `data` EstimationMethodSearchResponse[]
    - `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
    - `entity_type` 'equipment' | 'flow' | 'asset_group', required
    - `entity_id` string, uuid, required
    - `reporting_groups` object[], required
      - `name` string, required
      - `description` string, required
      - `priority` number, required
      - `id` string, required
    - `flow` object, required
      - `id` string, uuid, required
      - `company_id` string, uuid, required
      - `name` string, required
      - `status` string, required
      - `type` string, required
      - `product_category` string, required
      - `product_type` string, required
      - `custom_attributes` object, required
      - `upstream_flow_ids` string[], required
      - `downstream_flow_ids` string[], required
      - `upstream_flows_count` number, required
      - `downstream_flows_count` number, required
      - `upstream_facility_id` string, uuid, required
      - `downstream_facility_id` string, uuid, required
      - `upstream_equipment_id` string, uuid, required
      - `downstream_equipment_id` string, uuid, required
      - `associated_facility_id` string, uuid, required
      - `associated_equipment_id` string, uuid, required
      - `associated_facility` object, required
        - `id` string, uuid, required
        - `company_id` string, uuid, required
        - `name` string, required
        - `status` string, required
        - `type` string, required
        - `latitude` number, required
        - `longitude` number, required
        - `custom_attributes` 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
      - `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
    - `equipment` object, required
      - `id` string, uuid, required
      - `company_id` string, uuid, required
      - `name` string, required
      - `status` string, required
      - `type` object, required
        - `id` string, required
        - `name` string, required
      - `effective_date` string, required
      - `latitude` number, required
      - `longitude` number, required
      - `custom_attributes` 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
      - `facility` object, required
        - `id` string, uuid, required
        - `name` string, required

---

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