---
title: "Search templated configuration runs"
method: POST
path: "/app/v1/templated_configurations/runs/search"
tags: ["templated_configurations"]
---

# Search templated configuration runs

`POST /app/v1/templated_configurations/runs/search`

## Request body

- object
  - `page` number — Which page to return
  - `page_size` number — How many items to list in a page
  - `sort_by` 'id' | 'templated_configuration_name' | 'status' | 'created_at' | 'created_by' | 'updated_at' | 'primary_resource.status' | 'primary_resource.type' | 'primary_resource.name' | 'primary_resource.metadata.facility_name' | 'primary_resource.metadata.sub_type'
  - `sort_direction` 'asc' | 'desc' — Sort direction
  - `filter` object — A filter object for Templated Configuration Runs 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.
    - `templated_configuration_name` string
    - `status` string
    - `resources.template_resource_id` string
    - `resources.status` string
    - `resources.name` string
    - `resources.type` string
    - `resources.id` string
    - `resources.is_primary` boolean
    - `primary_resource.template_resource_id` string
    - `primary_resource.status` string
    - `primary_resource.name` string
    - `primary_resource.type` string
    - `primary_resource.id` string
    - `primary_resource.is_primary` boolean
    - `primary_resource.metadata` object — Additional information about the resource, similar to custom attibutes
    - `created_at` string, date-time
    - `updated_at` string, date-time
    - `created_by` string, uuid
    - `updated_by` string, uuid

## Response `200`

successful operation

- PagedTemplatedConfigurationRunList
  - `page_number` number
  - `page_size` number
  - `total_entries` number
  - `total_pages` number
  - `data` TemplatedConfigurationRunResponse[]
    - `id` string, uuid
    - `templated_configuration_name` string
    - `company_id` string, uuid
    - `status` 'submitted' | 'partial' | 'success' | 'failed'
    - `result` object
    - `created_by` string, uuid
    - `created_at` string, date-time
    - `updated_by` string, uuid
    - `updated_at` string, date-time
    - `resources` TemplatedConfigurationRunResource[]
      - `template_resource_id` string
      - `templated_configuration_run_id` string, uuid
      - `status` 'submitted' | 'success' | 'failed'
      - `name` string
      - `type` 'equipment' | 'flow'
      - `id` string, uuid
      - `errors` object
        - `message` string
        - `detail` string
      - `is_primary` boolean
      - `metadata` object — Additional information about the resource, similar to custom attibutes
        - `dependencies` string[]
    - `primary_resource` TemplatedConfigurationRunResource
      - `template_resource_id` string
      - `templated_configuration_run_id` string, uuid
      - `status` 'submitted' | 'success' | 'failed'
      - `name` string
      - `type` 'equipment' | 'flow'
      - `id` string, uuid
      - `errors` object
        - `message` string
        - `detail` string
      - `is_primary` boolean
      - `metadata` object — Additional information about the resource, similar to custom attibutes
        - `dependencies` string[]
    - `templated_configuration` object
      - `name` string
      - `display_name` string
      - `primary_resource_type` 'equipment' | 'flow'
    - `inputs` object — Dictionary of input values for the template
    - `custom_attribute_inputs` object — Dictionary of custom attributes for template assets, keys are the template resource ID
    - `custom_attribute_configuration` CustomAttributeConfigurationInput

---

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