---
title: "Get Product Overview"
method: GET
path: "/v1/product/{family_uuid}/overview"
tags: ["products"]
---

# Get Product Overview

`GET /v1/product/{family_uuid}/overview`

## 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/product/{family_uuid}/overview`
- Auth: OAuth 2
  - Password
  - Token URL: `/v1/auth`

This endpoint retrieves an overview of a product.
The product ID should be provided as a path parameter in the URL.

## Path parameters

- `family_uuid` string, required

## Response `200`

Successful Response

- StructureFamilyOverviewView
  - `uuid` string, required
  - `productId` string, required
  - `productType` 'tower' | 'guyed_mast' | 'monopole' | 'rooftop' | 'hybrid' | 'mount' | 'unknown', required
  - `numberOfLegs` integer[], required
  - `description` string, required
  - `manufacturer` string, required
  - `state` 'IN_PROGRESS' | 'COMPLETED' | 'FAILED', required
  - `editable` boolean, 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)