---
title: "Export equipment"
method: POST
path: "/app/v1/equipment/export"
tags: ["equipment"]
---

# Export equipment

`POST /app/v1/equipment/export`

## Query parameters

- `period` string

## Request body

- object
  - `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

- ReportWithS3Url
  - `id` string, uuid, required
  - `name` string, required
  - `company_id` string, uuid, required
  - `status` 'exporting' | 'failed' | 'success', required
  - `templated_report_name` string
  - `input` object — User input for a templated report based on the input schema for the desired templated report.
  - `s3_object_id` string
  - `report_version` string
  - `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
  - `templated_report` object
    - `name` string, required
    - `display_name` string, required
    - `status` 'active' | 'archived'
    - `input_schema` object
    - `is_embedded` boolean
    - `use_data_layer_v2` boolean
    - `description` string
    - `deduplication_columns` object
    - `row_styling_headers` object
    - `created_at` union, required
      - string, date-time
      - string, nullable
      - unknown
    - `updated_at` union, required
      - string, date-time
      - string, nullable
      - unknown
  - `s3_download_link` 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)