> ## Documentation Index > Fetch the complete documentation index at: https://docs.kodelabs.com/llms.txt > Use this file to discover all available pages before exploring further. # List spaces > Returns the levels and space units of a building, one page at a time. Use the filters to narrow the list. A space must match every filter you send. A filter value that matches nothing returns an empty page, not an error. `category` must be one of the listed values, in the exact letter case. `q` searches the space name. The match is not case-sensitive and can start anywhere in the name. An empty `q` returns every space. ## OpenAPI ````yaml /openapi/kode-api.yaml get /api/v1/buildings/{buildingId}/spaces openapi: 3.1.0 info: title: KODE API version: 1.0.0 summary: Programmatic access to KODE OS resources and operations. description: > Use the KODE API to work with buildings, data sources, connectors, devices, points, virtual devices, timeseries data, schedules, the ontology, templating, mass writes, spaces, space assignments, tenants, meters, users, actions, and AssetOps work orders. license: name: Proprietary identifier: LicenseRef-Proprietary servers: - url: https://api.kodelabs.com/kodeos description: KODE API security: - bearerAuth: [] tags: - name: Authentication description: OAuth 2.0 discovery, token, and revocation endpoints. - name: Buildings description: Buildings and their areas. - name: Data sources description: Data sources connected to a building. - name: Devices description: Devices and their points. - name: Points description: Point queries and point writes. - name: Timeseries description: Current and historical point values. - name: Actions description: Actions exposed by building data sources. - name: Work orders description: AssetOps work orders, lookups, comments, and attachments. - name: Connectors description: KODE API connectors and the devices and points ingested through them. - name: Schedules description: Schedules discovered on building data sources. - name: Templating description: Apply ontology templates to groups of points. - name: Virtual devices description: Virtual devices that group points from other devices. - name: Ontology description: Canonical types, fields, units, and connections of the KODE ontology. - name: Users description: Users of the organization and their app access. - name: Mass write description: Write values to many points across buildings, and follow each run. - name: Spaces description: Levels and space units of a building, and the meters located in them. - name: Space assignments description: Assign tenants to leasable spaces of a building for a period. - name: Tenants description: Tenants of a building, the people or companies that lease its spaces. - name: Meters description: >- Meters of a building, their space assignments, parent and child links, and readings. paths: /api/v1/buildings/{buildingId}/spaces: get: tags: - Spaces summary: List spaces description: Returns the levels and space units of a building, one page at a time. operationId: listSpaces parameters: - $ref: '#/components/parameters/BuildingId' - name: asc in: query schema: type: string description: Field to sort by, lowest first, for example `name`. - name: category in: query schema: type: string enum: - Level - SpaceUnit - Zone description: Return only spaces of this category. - name: dsc in: query schema: type: string default: _id description: Field to sort by, highest first. Defaults to `_id`. - name: identifier in: query schema: type: string description: Return only the space with this identifier. - name: leasable in: query schema: type: string description: >- Return only spaces where `leasable` is `true`, or only spaces where it is `false`. - name: limit in: query schema: type: integer format: int32 maximum: 200 minimum: 1 default: 50 description: Number of items per page, from `1` to `200`. The default is `50`. - name: operationalStatus in: query schema: type: string description: Return only spaces with this operational status. - name: page in: query schema: type: integer format: int32 minimum: 1 default: 1 description: Page number to return. The first page is `1`. - name: parentSpaceId in: query schema: type: string description: Return only spaces inside this level or space. - name: q in: query schema: type: string description: Search text. Matches the space name. - name: tenantUnit in: query schema: type: string description: >- Return only spaces where `tenantUnit` is `true`, or only spaces where it is `false`. - name: type in: query schema: type: string description: Return only spaces of this type. - name: usage in: query schema: type: string description: Return only spaces with this usage. responses: '200': description: >- A page of spaces. `itemCount` is the total number of spaces that match the filters. content: application/json: schema: $ref: '#/components/schemas/PaginatedEntitySpacePublic' '400': description: >- A query parameter is invalid. For example, `category` is not `Level`, `SpaceUnit`, or `Zone`, `limit` is above `200`, `page` is below `1`, or `buildingId` is blank. '401': $ref: '#/components/responses/Unauthorized' '403': description: >- The building does not exist or is not assigned to the service account. KODE API answers `403` in both cases so that building ids cannot be probed. '429': $ref: '#/components/responses/TooManyRequests' components: parameters: BuildingId: name: buildingId in: path required: true description: Building identifier from List buildings. schema: type: string example: 67c960faffaa42223163099e schemas: PaginatedEntitySpacePublic: type: object properties: data: type: array items: $ref: '#/components/schemas/SpacePublic' page: type: integer format: int32 limit: type: integer format: int32 pageCount: type: integer format: int32 itemCount: type: integer format: int32 SpacePublic: type: object properties: _id: description: Space identifier. type: string organizationId: type: string createdAt: $ref: '#/components/schemas/Date' type: string readOnly: true updatedAt: $ref: '#/components/schemas/Date' type: string readOnly: true name: type: string description: type: string displayName: type: string category: description: '`Level`, `SpaceUnit`, or `Zone`.' type: string partOf: $ref: '#/components/schemas/SpaceRef2' description: The level or space this space belongs to. inZone: description: Zones the space is in. type: array items: $ref: '#/components/schemas/SpaceRef2' area: $ref: '#/components/schemas/DoubleMeasurement2' netArea: $ref: '#/components/schemas/DoubleMeasurement2' height: $ref: '#/components/schemas/DoubleMeasurement2' capacity: type: integer format: int32 seatingCapacity: type: integer format: int32 headcount: type: integer format: int32 allocated: type: boolean baseTemperature: $ref: '#/components/schemas/DoubleMeasurement2' baseHumidity: $ref: '#/components/schemas/DoubleMeasurement2' baseAirQuality: $ref: '#/components/schemas/DoubleMeasurement2' baseNoiseLevel: $ref: '#/components/schemas/DoubleMeasurement2' targetUtilization: $ref: '#/components/schemas/DoubleMeasurement2' building: $ref: '#/components/schemas/PublicBuildingRef' description: The building of the space. devicesCount: description: Number of devices in the space. type: integer format: int32 identifier: type: string operationalStatus: description: Operational status of the space. type: string usage: type: string type: type: string tenantUnit: type: boolean leasable: type: boolean shared: type: boolean bookable: type: boolean workpoint: type: string assignmentCapacity: type: integer format: int32 seatingModel: type: string Date: type: string description: >- Date and time in UTC, with a numeric offset and no colon, for example `2026-10-28T13:51:31+0000`. examples: - 2026-10-28T13:51:31+0000 SpaceRef2: type: object properties: id: type: string name: type: string category: type: string DoubleMeasurement2: type: object properties: value: type: number format: double unit: $ref: '#/components/schemas/PublicUnit' PublicBuildingRef: type: object properties: _id: type: string name: type: string PublicUnit: type: object properties: _id: type: string category: type: string baseSymbol: type: string symbol: type: string responses: Unauthorized: description: The access token is missing, invalid, or expired. Request a new token. TooManyRequests: description: >- A rate-limit window is exhausted. Wait, then retry with increasing delays. securitySchemes: bearerAuth: type: http scheme: bearer bearerFormat: JWT description: > Paste an access token from [Create an access token](/products/kode-api/api-reference/authentication/create-an-access-token). Tokens expire, so request a new one if you receive `401`. ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.