---
title: "Get Foundation Compatibility For Structure With Id"
method: GET
path: "/v1/structures/{structure_id}/foundation/compatibility"
tags: ["structures"]
---

# Get Foundation Compatibility For Structure With Id

`GET /v1/structures/{structure_id}/foundation/compatibility`

## 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/{structure_id}/foundation/compatibility`
- Auth: OAuth 2
  - Password
  - Token URL: `/v1/auth`

This endpoint retrieves the foundation compatibility status for a structure by its ID.
The structure ID should be provided as a path parameter in the URL.

The response is a boolean value that indicates whether the structure is compatible with the foundation analysis tool.

## Path parameters

- `structure_id` string, required

## Response `200`

Returns compatibility information between the foundation and structure.

- FoundationCompatibilityView
  - `isCompatible` boolean, required
  - `cause` 'PAD_WIDTH_TOO_SMALL' | 'PIER_WIDTH_TOO_SMALL' | 'FOUNDATION_TYPE_INCOMPATIBLE_WITH_STRUCTURE_TYPE'

## Other responses

- `404`: Not found
- `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)