> ## 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 space assignments > Returns the space assignments of a building, one page at a time. Use the filters to narrow the list. An assignment must match every filter you send. `spaceId` and `tenantId` match assignments that include the space or belong to the tenant. Repeat `spaceId` to match any of several spaces. A filter value that matches nothing returns an empty page. Send dates as `YYYY-MM-DD`. Each date filter includes the date you send. ## OpenAPI ````yaml /openapi/kode-api.yaml get /api/v1/buildings/{buildingId}/space-assignments 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}/space-assignments: get: tags: - Space assignments summary: List space assignments description: Returns the space assignments of a building, one page at a time. operationId: listSpaceAssignments parameters: - $ref: '#/components/parameters/BuildingId' - name: activeOnly in: query schema: type: boolean description: >- Send `true` to return only active assignments. Any other value returns all assignments. - name: asc in: query schema: type: string description: Field to sort by, lowest first. - name: dsc in: query schema: type: string default: _id description: Field to sort by, highest first. Defaults to `_id`. - name: endDateFrom in: query schema: type: string format: date examples: - '2022-03-10' description: Return assignments that end on or after this date (`YYYY-MM-DD`). - name: endDateTo in: query schema: type: string format: date examples: - '2022-03-10' description: Return assignments that end on or before this date (`YYYY-MM-DD`). - 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: page in: query schema: type: integer format: int32 minimum: 1 default: 1 description: Page number to return. The first page is `1`. - name: spaceId in: query schema: type: array items: type: string description: >- Return assignments that include this space. Repeat the parameter to match any of several spaces. - name: startDateFrom in: query schema: type: string format: date examples: - '2022-03-10' description: Return assignments that start on or after this date (`YYYY-MM-DD`). - name: startDateTo in: query schema: type: string format: date examples: - '2022-03-10' description: Return assignments that start on or before this date (`YYYY-MM-DD`). - name: tenantId in: query schema: type: string description: Return only assignments of this tenant. - name: type in: query schema: type: array items: type: string description: >- Return only assignments of this type. The only type is `lease`. The value is case-sensitive. Repeat the parameter to match any of several values. responses: '200': description: >- A page of space assignments. `itemCount` is the total number that match the filters. content: application/json: schema: $ref: '#/components/schemas/PaginatedEntitySpaceAssignmentPublic' '400': description: >- A query parameter is invalid. For example, `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: PaginatedEntitySpaceAssignmentPublic: type: object properties: data: type: array items: $ref: '#/components/schemas/SpaceAssignmentPublic' page: type: integer format: int32 limit: type: integer format: int32 pageCount: type: integer format: int32 itemCount: type: integer format: int32 SpaceAssignmentPublic: type: object properties: _id: description: Assignment identifier. type: string organizationId: type: string createdAt: $ref: '#/components/schemas/Date' type: string readOnly: true updatedAt: $ref: '#/components/schemas/Date' type: string readOnly: true tenant: $ref: '#/components/schemas/TenantRef' description: The tenant of the assignment. spaces: description: The spaces of the assignment. type: array items: $ref: '#/components/schemas/SpaceRefPublic1' startDate: $ref: '#/components/schemas/LocalDate' description: First day of the assignment. endDate: $ref: '#/components/schemas/LocalDate' description: Last day of the assignment. type: description: Always `lease`. type: string description: description: Free text about the assignment. type: string isActive: description: >- `true` when the assignment has started and has not ended. An assignment with no start date is not active. type: boolean 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 TenantRef: type: object properties: _id: type: string name: type: string type: type: string SpaceRefPublic1: type: object properties: _id: type: string name: type: string category: type: string LocalDate: type: string format: date examples: - '2022-03-10T00:00:00.000Z' 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.