Appearance
Space API - Changelog
November 8th 2024
- New ✨
- Setting custom attribute values via Layout operations
October 3rd 2024
- New ✨
- Deprecation
- DXF GET is deprecated use DXF POST instead
May 23rd 2024
- New ✨
April 22nd 2024
- New ✨
April 2nd 2024
- New ✨
- OpenAPI powered REST endpoint documentation. Example
February 15th 2024
- New ✨
- Coordinates: Address enhanced with bearing
- Floor's source
November 14th 2023
- New ✨
- Webhooks support
September 21st 2023
- New ✨
customAttributes:read
andcustomAttributeValues:readPublic
scopes can now be added to publishable tokens
August 25th 2023
New ✨
- GeoJSON export for floors has now an new parameter
includeAllElements
. When set, the response includes the geometry of all elements on the floor to create a detailed floor plan drawing with style information included. teamId
is returned for floor responses if the User Teams feature is enabled for an organization
- GeoJSON export for floors has now an new parameter
Deprecation
- Custom fields scopes have been removed, API endpoints are deprecated. Please use custom attributes instead
April 21st 2023
- New ✨
- Custom Attributes for Product resources
February 15th 2023
- New ✨
- Custom Attributes for Floor, Space, Asset resources
July 26th 2022
- New ✨
- new property
labels
in Floor object - Floors can be queried by
label
param
- new property
June 15th 2022
- New ✨
- DXF file of floors now available through downloadable URL
- new property
seatCapacity
in Asset object
November 22th 2021
- New ✨
- new properties
createdAt
andfloorNumber
in Floor object
- new properties
October 28th 2021
- New ✨
- Archived floors can be queried with
includeArchived
param
- Archived floors can be queried with
October 6th 2021
- Deprecation
- Space API v1 is no longer available.
August 25th 2021
- New ✨
- new properties
customId
andname
in Space object
- new properties
July 7th 2021
- Fixes
- svg exports for some floor plans in portrait mode had incorrect lat long bounding boxes
March 25th 2021
Space API v2 release
New ✨
- New access token types and introduction of temporary access tokens
- More granular scopes
- New methods to request geo-json geometry for a floor, a space, or an asset
- New method to request scene structure of floors.
- Introduction of rate limits.
BREAKING Changes
- New methods of providing publishable access tokens or secret access tokens in requests.
It is not possible to create v1 tokens anymore. - By default, resource reads return only
type
,resourceType
,id
,properties
,resourceRelations
. Use/v2/<resource-type>/<resource-id/geo-json
to return the above properties plusgeometry
andgeometryOpenings
(latter only for space resources). - By default querying resources will not return the
geometry
andgeometryOpenings
attributes. To include these in the response the additionalgeometry=true
query parameter must be provided. Check query params for floors, spaces or assets - In contrast to Space API v1, resource reads and queries don't return the custom fields associated with the resources by default anymore. To include custom fields, the
includeCustomFields=true
query parameter must be supplied. - In Space API v1, resource queries returned both private and public resources if the
floor:read
scope was present. Since thefloor:read
scope has been deprecated, resource queries in Space API v2 only return both private and public resources if bothfloor:queryPublic
andfloor:queryPrivate
scopes are provided. If just one of the scopes is provided, then Space API v2 only returns resources that fall into that category. - In contrast to Space API v1, in v2, access tokens only allow reading the same organization's public resources.
- New methods of providing publishable access tokens or secret access tokens in requests.
February 5th 2021
- New ✨
- floor archive API
- floor unarchive API
December 3rd 2020
- Changes
- floor 2d-image API uses floor plan engine 2.0
June 6th 2020
- New ✨
- floor 2d image API
May 2nd 2020
- New ✨
- custom fields API
March 25th 2020
- New ✨
- floor resource
- space resource
- asset resource