Spaces
Get a warehouse or space
Returns the detail of a warehouse or space by its identifier, with its capacity, surface area, amenities and custom fields.
Request examples
curl https://app.filmo.io/api/v1/spaces/spac_8f2a1c \
--header "Authorization: Bearer $FILMO_API_KEY"Generated from the schema
Authorizations
Bearer API key with the scope below. spaces:read
Headers
Conditional read: the ETag of the copy you already have. If the resource has not changed, the response is 304 with no body.
Example:"\"3sT3d9pBvZq4h2N0w8x1YkLmQ7c\""
Path parameters
Space identifier.
Limits: min length 1
Response
Successful response.
Response schema: SpaceDetailDto
Envelope: SpaceDetailResponse. meta. is present only when the operation is deprecated.
Headers: X-Request-Id · RateLimit-Limit · RateLimit-Remaining · RateLimit-Reset · ETag
Detail of a warehouse or rentable space.
Show child attributesHide child attributes
Unique space identifier.
Space name.
Internal reference of the space, useful for matching with external systems; null if it has none.
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.
Identifier of the collection it belongs to; null if it is in none.
Full collection path, for example "Estudios > Fotografía"; null if not applicable.
Building it is located in; null if not applicable.
Floor it is located on; null if not applicable.
Physical location of the space.
Show child attributesHide child attributes
Postal address; null if not recorded.
Municipality; null if not recorded.
Postal code; null if not recorded.
Country; null if not recorded.
Latitude in decimal degrees; null if not geolocated.
Longitude in decimal degrees; null if not geolocated.
Creation date in ISO 8601 UTC.
Last modification date in ISO 8601 UTC.
Space description; null if it has none.
Capacity in people; null if not defined.
Area in square metres; null if not defined.
Dimensions as free text; null if not defined.
Additional services available (wifi, projector...).
Fixed equipment available in the space.
Rental pricing of the space; null if not configured. The same fields that PATCH /pricing accepts.
Show child attributesHide child attributes
Pricing mode; null if not configured.
Available options: periodPrice, fixedPrice, pricingStructure
Base rental price as a decimal string; null if not configured.
Limits: pattern ^-?\d+\.\d{2}$
Period unit of the price; null if not configured.
Available options: hour, day, week, month
Whether the space allows insurance.
Whether the space allows a discount.
Security deposit amount as a decimal string; null if not set.
Limits: pattern ^-?\d+\.\d{2}$
Time buffer reserved BEFORE the rental; null if none.
Unit of the preceding buffer; null if none.
Available options: hour, day
Time buffer reserved AFTER the rental; null if none.
Unit of the following buffer; null if none.
Available options: hour, day
Custom field values by custom field identifier; the definitions are in /api.
Additional information about the response.
Show child attributesHide child attributes
Lifecycle warnings; present only when the operation is deprecated.
Show child attributesHide child attributes
Stable warning code.
Available options: deprecated
For people: what is deprecated, until when, and what to use.
Day (YYYY-MM-DD) the operation stops being served.
operationId of the operation to use instead, or null if there is none.
Where the deprecation is documented (the changelog).
Not modified: the If-None-Match sent matches the current ETag. No body; the copy you have is current.
Headers: ETag
No body.
Authentication failed (unauthorized, api_key_invalid, api_key_revoked, api_key_expired, api_key_owner_inactive, api_key_owner_not_admin).
Headers: X-Request-Id · Content-Language
Not allowed (insufficient_scope: the API key does not have the required scope, named in requiredScope; forbidden: the owner of the key lacks the permission the operation requires). insufficient_scope is answered before the request counts against the rate limit, so it carries no RateLimit-* headers; forbidden does.
Headers: X-Request-Id · Content-Language
Resource not found (not_found): it does not exist or is outside the scope of the API key.
Headers: X-Request-Id · Content-Language · RateLimit-Limit · RateLimit-Remaining · RateLimit-Reset
Rate limit exceeded (rate_limited): retry after Retry-After seconds; RateLimit-* says which quota ran out.
Headers: X-Request-Id · Content-Language · RateLimit-Limit · RateLimit-Remaining · RateLimit-Reset · Retry-After
Internal error (internal_error).
Headers: X-Request-Id · Content-Language · RateLimit-Limit · RateLimit-Remaining · RateLimit-Reset
Errors
Deprecation
This operation is not deprecated. Deprecations are announced with a Deprecation header and a sunset date. Versioning policy
Related
Related pages
Link to this section: Related pagesCatalog & inventory
Space
Warehouse or rentable space of the account.
Was this page helpful?