# Get Spaces

## **Explanation**

Before submitting any order, use this API to check the available spaces. The `space_name` field may be mandatory for specific services; if required, set `space_name` based on the uploaded image.

***

<mark style="color:green;">**`GET`**</mark> **`https://api.aihomedesign.com/v1/catalog/spaces`**

***

**Query Parameters:**

* `active` (boolean): Set to `true` to retrieve only active widgets.
* `service_name` (string): Set your desired service name e.g., `service-ai-creative-designer`.

## Response

{% tabs %}
{% tab title="200: OK" %}

```json
{
    "data": [
        {
            "id": string,
            "name": string,
            "title": string,
            "description": string,
            "prompt": string,
            "icon_src": string,
            "is_active": boolean,
            "is_premium": boolean
        }
    ]
}
```

{% endtab %}

{% tab title="400: Bad Request" %}

```json
{
    "error": string,
    "key": string
}
```

{% endtab %}
{% endtabs %}