---
title: "Search Structures"
method: POST
path: "/v1/structures/search"
tags: ["structures"]
---

# Search Structures

`POST /v1/structures/search`

## Request

- Base URL: `https://api.shapemaker.io` (the document declares no server; this is the origin it was published from)
- URL: `https://api.shapemaker.io/v1/structures/search`
- Auth: OAuth 2
  - Password
  - Token URL: `/v1/auth`

This endpoint allows you to search for structures based on the provided search criteria.
It accepts a JSON object with the search parameters and returns a list of structures that match the criteria.

The search parameters should be provided in the request body. The response is a JSON object that contains a list of structures.

## Request body

- StructuresSearchInput
  - `tags` string[], nullable
  - `text` string, nullable
  - `uuids` string[], nullable
  - `sorting` StructuresSearchSortingInput[], nullable
    - `desc` boolean
    - `id` string
  - `limit` integer, nullable
  - `offset` integer, nullable

## Response `200`

Successful Response

- StructuresSearchResultView
  - `structures` StructureView[], required
    - `id` integer, required
    - `uuid` string, uuid4, required
    - `name` string, required
    - `projectId` string, nullable
    - `createdBy` string, required
    - `createdAt` string, date-time, required
    - `designStandardKey` 'EN_01' | 'MSZ_EN_01' | 'NS_EN_01' | 'DIN_EN_01' | 'NF_EN_01' | 'SFS_EN_01' | 'SS_EN_01' | 'BS_EN_01' | 'IS_EN_01' | 'BDS_EN_01' | 'UNI_EN_01' | 'TIA_222_I' | 'TIA_222_H' | 'TIA_222_G' | 'TIA_222_F' | 'PN_EN_01' | 'ASNZS_01', required
    - `sections` string[], nullable, required
    - `tripodParameters` TripodParametersView, required
      - `poleHeightM` number, required
      - `poleDiameterMM` number, required
      - `poleThicknessMM` number, required
      - `diagonalOffsetM` number, required
      - `diagonalAttachmentHeightM` number, required
      - `diagonalDiameterMM` number, required
      - `diagonalThicknessMM` number, required
      - `steelMaterial` string, required
    - `productId` string, nullable, required
    - `sourceMountDesignUuid` string, nullable
    - `mountDesignName` string, nullable
    - `capacityStatus` 'UNKNOWN' | 'OVERLOADED' | 'UNDERLOADED', required
    - `isStaleAnalysis` boolean, required
    - `isInvalidatedAnalysis` boolean
    - `maxUtilizationPercent` number, nullable
    - `productType` 'tower' | 'guyed_mast' | 'monopole' | 'rooftop' | 'hybrid' | 'mount' | 'unknown', required
    - `tags` StructureTagView[], required
      - `value` string, required
      - `color` string, required
    - `organizationId` integer, required
    - `analysisRunId` string, uuid4, nullable
    - `draftCount` integer
    - `versionSeq` integer
    - `role` 'live' | 'draft' | 'snapshot'
  - `totalCount` integer, required

## Other responses

- `422`: Validation Error

---

[API](https://skmtc.dev/shapemaker/apis/shapemaker-api.md) - [All operations](https://skmtc.dev/shapemaker/apis/shapemaker-api/llms.txt) - [OpenAPI document](https://skmtc.dev/shapemaker/apis/shapemaker-api/revisions/b8461cf1236c?raw)