*REST API › Objects › Catalog & inventory*

# Space

> Warehouse or rentable space of the account.

A warehouse that manages stock, or a rentable space; `isWarehouse` tells them apart. The holding costs of the space are not part of the public contract. Spaces are bounded to the subscription that owns the key. The detail read, [`GET /api/v1/spaces/{spaceId}`](https://docs.filmo.io/rest-api/endpoint-reference/spaces/get-a-warehouse-or-space), adds the description, capacity, area, dimensions, amenities, equipment, pricing settings, buffers and custom fields.

Schemas: `SpaceDto`, `SpaceDetailDto`

## Attributes

| Name | Type | Description |
| --- | --- | --- |
| `id` | string | Unique space identifier. |
| `name` | string | Space name. |
| `internalReference` | string | Internal reference of the space, useful for matching with external systems; null if it has none. |
| `isWarehouse` | boolean | true if the space is a warehouse that manages stock and can be the main warehouse of an order; false if it is a rentable space. |
| `collectionId` | string | Identifier of the collection it belongs to; null if it is in none. |
| `collectionName` | string | Full collection path, for example "Estudios > Fotografía"; null if not applicable. |
| `building` | string | Building it is located in; null if not applicable. |
| `floor` | number | Floor it is located on; null if not applicable. |
| `location` | object | Physical location of the space. |
| `location.address` | string | Postal address; null if not recorded. |
| `location.city` | string | Municipality; null if not recorded. |
| `location.postalCode` | string | Postal code; null if not recorded. |
| `location.country` | string | Country; null if not recorded. |
| `location.lat` | number | Latitude in decimal degrees; null if not geolocated. |
| `location.lng` | number | Longitude in decimal degrees; null if not geolocated. |
| `createdAt` | string<date-time> | Creation date in ISO 8601 UTC. |
| `updatedAt` | string<date-time> | Last modification date in ISO 8601 UTC. |
| `description` | string | Space description; null if it has none. |
| `capacity` | number | Capacity in people; null if not defined. |
| `area` | number | Area in square metres; null if not defined. |
| `dimensions` | string | Dimensions as free text; null if not defined. |
| `amenities` | string[] | Additional services available (wifi, projector...). |
| `equipments` | string[] | Fixed equipment available in the space. |
| `pricingSettings` | object | Rental pricing of the space; null if not configured. The same fields that PATCH /pricing accepts. |
| `pricingSettings.type` | string | Pricing mode; null if not configured. `periodPrice`, `fixedPrice`, `pricingStructure` |
| `pricingSettings.price` | string | Base rental price as a decimal string; null if not configured. |
| `pricingSettings.period` | string | Period unit of the price; null if not configured. `hour`, `day`, `week`, `month` |
| `insuranceEnabled` | boolean | Whether the space allows insurance. |
| `discountEnabled` | boolean | Whether the space allows a discount. |
| `depositValue` | string | Security deposit amount as a decimal string; null if not set. |
| `bufferBefore` | number | Time buffer reserved BEFORE the rental; null if none. |
| `bufferBeforeUnit` | string | Unit of the preceding buffer; null if none. `hour`, `day` |
| `bufferAfter` | number | Time buffer reserved AFTER the rental; null if none. |
| `bufferAfterUnit` | string | Unit of the following buffer; null if none. `hour`, `day` |
| `customFields` | object<string, any> | Custom field values by custom field identifier; the definitions are in `/api/v1/custom-fields`. |

## Values

| Field | Values |
| --- | --- |
| `bufferBeforeUnit` | `hour`, `day` |
| `bufferAfterUnit` | `hour`, `day` |

## Example

*Space · Generated from the schema*

```json
{
  "id": "id_8f2a1c",
  "name": "Example",
  "internalReference": "string",
  "isWarehouse": true,
  "collectionId": "string",
  "collectionName": "Example",
  "building": "string",
  "floor": 1,
  "location": {
    "address": "string",
    "city": "string",
    "postalCode": "string",
    "country": "ES",
    "lat": 1,
    "lng": 1
  },
  "createdAt": "2026-09-01T08:00:00Z",
  "updatedAt": "2026-09-01T08:00:00Z",
  "description": "string",
  "capacity": 1,
  "area": 1,
  "dimensions": "string",
  "amenities": [
    "string"
  ],
  "equipments": [
    "string"
  ],
  "pricingSettings": {
    "type": "periodPrice",
    "price": "1234.50",
    "period": "hour"
  },
  "insuranceEnabled": true,
  "discountEnabled": true,
  "depositValue": "1234.50",
  "bufferBefore": 1,
  "bufferBeforeUnit": "hour",
  "bufferAfter": 1,
  "bufferAfterUnit": "hour",
  "customFields": {
    "key": "string"
  }
}
```

## Returned by

- [`GET /api/v1/spaces`](https://docs.filmo.io/rest-api/endpoint-reference/spaces/list-warehouses-and-spaces) — List warehouses and spaces
- [`GET /api/v1/spaces/{spaceId}`](https://docs.filmo.io/rest-api/endpoint-reference/spaces/get-a-warehouse-or-space) — Get a warehouse or space

## Modified by

- [`PATCH /api/v1/spaces/{spaceId}`](https://docs.filmo.io/rest-api/endpoint-reference/spaces/update-a-warehouse-or-space) — Update a warehouse or space
- [`PUT /api/v1/spaces/{spaceId}/amenities`](https://docs.filmo.io/rest-api/endpoint-reference/spaces/replace-the-amenities-and-equipment) — Replace the amenities and equipment
- [`PATCH /api/v1/spaces/{spaceId}/pricing`](https://docs.filmo.io/rest-api/endpoint-reference/spaces/update-the-pricing-of-a-space) — Update the pricing of a space

---

Canonical URL: https://docs.filmo.io/rest-api/objects/space  
Last updated: 2026-10-25