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

# Search and list equipment

`POST /app/v1/equipment/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` 'facility_name' | 'name'
  - `sort_direction` 'asc' | 'desc' — sort direction
  - `filter` EquipmentFilterFields
    - `id` string
    - `name` string
    - `status` 'active' | 'inactive' | 'deprecated'
    - `type.id` string
    - `type.name` string
    - `custom_attributes` object
    - `created_at` string, date-time
    - `updated_at` string, date-time
    - `facility.custom_attributes` object
    - `facility.id` string
    - `facility.name` string
    - `facility.status` string
    - `event.id` string

## Response `200`

successful operation

- PagedEquipmentList
  - `page_number` number
  - `page_size` number
  - `total_entries` number
  - `total_pages` number
  - `data` EquipmentWithFacility[]
    - `created_at` string, date-time
    - `updated_at` string, date-time
    - `created_by` string, uuid
    - `updated_by` string, uuid
    - `custom_attributes` CustomAttributes
    - `effective_date` string
    - `facility` FacilityNameAndId
      - `custom_attributes` CustomAttributes
      - `id` string, uuid
      - `name` string
    - `id` string
    - `latitude` number, nullable — latitude on the Earth
    - `longitude` number, nullable — longitude on the Earth
    - `name` string
    - `status` 'active' | 'inactive' | 'deprecated'
    - `type` EquipmentTypeShallow
      - `id` string
      - `name` 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)