---
title: "Search Facilities"
method: POST
path: "/app/v1/facilities/search"
tags: ["facilities"]
---

# Search Facilities

`POST /app/v1/facilities/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' | 'status'
  - `sort_direction` 'asc' | 'desc' — sort direction
  - `filter` FacilityFilterFields — A filter object for facility 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.
    - `custom_attributes` object
    - `id` string
    - `name` string
    - `status` string
    - `event.id` string
    - `created_at` string, date-time
    - `updated_at` string, date-time

## Response `200`

successful operation

- PagedFacilityList
  - `page_number` number
  - `page_size` number
  - `total_entries` number
  - `total_pages` number
  - `data` Facility[]
    - `created_at` string, date-time
    - `updated_at` string, date-time
    - `created_by` string, uuid
    - `updated_by` string, uuid
    - `custom_attributes` CustomAttributes
    - `latitude` number, nullable — latitude on the Earth
    - `longitude` number, nullable — longitude on the Earth
    - `name` string
    - `status` string — Use `id` value of any index in `GET /v1/facility_statuses`
    - `type` string — Use `id` value of any index in `GET /v1/facility_types`
    - `id` string, uuid

---

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