FloorPlans
Search FloorPlans
Search and list FloorPlan records with filtering, sorting, and pagination.
GET
Search FloorPlans
A FloorPlan is a visual diagram representing a single floor of a location. Floor plans are used by admins and customers to get an overview of the space layout, including rooms, desks, and other areas.
Each floor plan belongs to a location (
Business) and can optionally reference a FloorPlanLayout template. A background/tracing image can be uploaded to overlay the drawn areas, and its position and scale can be adjusted independently from the floor plan’s own scale.
Once created, floor plan units (FloorPlanDesks) are added to the floor plan to represent individual bookable or non-bookable areas such as offices, dedicated desks, hot desks, and meeting rooms.
Authentication
This endpoint requires OAuth2 authentication. Include a valid bearer token in the
Authorization header.
The authenticated user must be a full unrestricted administrator or have the FloorPlan-List role.Query Parameters
Pagination & Sorting
The page number to retrieve.
The number of records per page.
The property name to sort results by (e.g.
Name, CreatedOn).Sort direction.
1 for ascending, -1 for descending.Filters
Filter by iD of the location this floor plan belongs to.
Filter by location name.
Filter by currency code of the location.
Filter by iD of the floor plan layout template to apply to this floor plan.
Filter by floor plan layout name.
Filter by display name of the floor plan (e.g. ‘Ground Floor’, ‘Level 2’).
Filter by filename of the currently stored background/tracing image.
Filter by uRL of a new background/tracing image to upload. The image will be fetched and stored when the floor plan is saved.
Filter by set to true to remove the current background/tracing image from this floor plan.
Filter by whether the background/tracing image is visible when the floor plan is rendered.
Filter by zoom/scale factor applied to the background/tracing image, expressed as a percentage (e.g. 100 = original size).
Filter by horizontal offset (in pixels) of the background image within the floor plan canvas.
Filter by vertical offset (in pixels) of the background image within the floor plan canvas.
Filter by floor number used to order floor plans (e.g. 0 = ground floor, 1 = first floor, -1 = basement).
Filter by real-world scale of the floor plan, representing how many real-world units correspond to one canvas unit.
Filter by maximum number of people this floor can accommodate at the same time.
Filter by unique identifier used to link this floor plan to a corresponding Archilogic 3D model.
Range Filters
Filter by zoom/scale factor applied to the background/tracing image, expressed as a percentage (e.g. 100 = original size) greater than or equal to this value.
Filter by zoom/scale factor applied to the background/tracing image, expressed as a percentage (e.g. 100 = original size) less than or equal to this value.
Filter by horizontal offset (in pixels) of the background image within the floor plan canvas greater than or equal to this value.
Filter by horizontal offset (in pixels) of the background image within the floor plan canvas less than or equal to this value.
Filter by vertical offset (in pixels) of the background image within the floor plan canvas greater than or equal to this value.
Filter by vertical offset (in pixels) of the background image within the floor plan canvas less than or equal to this value.
Filter by floor number used to order floor plans (e.g. 0 = ground floor, 1 = first floor, -1 = basement) greater than or equal to this value.
Filter by floor number used to order floor plans (e.g. 0 = ground floor, 1 = first floor, -1 = basement) less than or equal to this value.
Filter by real-world scale of the floor plan, representing how many real-world units correspond to one canvas unit greater than or equal to this value.
Filter by real-world scale of the floor plan, representing how many real-world units correspond to one canvas unit less than or equal to this value.
Filter by maximum number of people this floor can accommodate at the same time greater than or equal to this value.
Filter by maximum number of people this floor can accommodate at the same time less than or equal to this value.
Filter records created on or after this date. Format:
YYYY-MM-DDTHH:mm.Filter records created on or before this date. Format:
YYYY-MM-DDTHH:mm.Filter records updated on or after this date. Format:
YYYY-MM-DDTHH:mm.Filter records updated on or before this date. Format:
YYYY-MM-DDTHH:mm.Code Examples
Simple listing
Filtering by Name
Range filters
Response
200
The list of FloorPlan records matching the query. See the Get one FloorPlan endpoint for the full list of properties returned for each record.
Current page number.
Number of records per page.
The field used for sorting.
The sort direction (
1 = ascending, -1 = descending).Index of the first item on the current page.
Index of the last item on the current page.
Total number of matching records across all pages.
Total number of pages.
Whether there is a next page of results.
Whether there is a previous page of results.
Example Response
Search FloorPlans