---
title: "Download Template File"
method: GET
path: "/v1/product/onboarding-file-template/download"
tags: ["products"]
---

# Download Template File

`GET /v1/product/onboarding-file-template/download`

## 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/onboarding-file-template/download`
- Auth: OAuth 2
  - Password
  - Token URL: `/v1/auth`

This endpoint downloads the structure family template file 'onboarding_template.xlsx' which is used to submit structure families for onboarding.

## Response `200`

Successful Response

- StructureFamilyOnboardingView
  - `productId` string, required
  - `state` 'IN_PROGRESS' | 'COMPLETED' | 'FAILED', required
  - `fileName` string, required

---

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