---
title: "List Spaces"
method: POST
path: "/spaces/list"
---

# List Spaces

`POST /spaces/list`

Returns a list of all spaces.

## Request body

- object
  - `customer_key` string — Customer key for which you want to list spaces.
  - `limit` number, float — Maximum number of records to return per page.
  - `page_cursor` string, nullable — Identifies the specific page of results to return, obtained from the previous page's `next_page_cursor`.
  - `search` string — String for which to search. Filters returned spaces to include all records that satisfy a partial match using `name`, `space_key`, or `customer_key`.
  - `space_key` string — Filter spaces by space_key.

## Response `200`

OK

- object
  - `pagination` Pagination, required — Information about the current page of results.
    - `has_next_page` boolean, required — Indicates whether there is another page of results after this one.
    - `next_page_cursor` string, nullable, required — Opaque value that can be used to select the next page of results via the `page_cursor` parameter.
    - `next_page_url` string, uri, nullable, required — URL to get the next page of results.
  - `spaces` Space[], required
    - `acs_entrance_count` number, float, required — Number of entrances in the space.
    - `created_at` string, date-time, required — Date and time at which the space was created.
    - `customer_data` object — Reservation/stay-related defaults for the space. Also carries the provider/PMS-supplied name under a `<connector_type>_name` key (e.g. `guesty_name`), which Seam preserves when you rename the space (read-only — managed by Seam).
      - `address` string, nullable — Postal address for the space.
      - `default_checkin_time` string, nullable — Default check-in time for reservations at the space, as HH:mm or HH:mm:ss.
      - `default_checkout_time` string, nullable — Default check-out time for reservations at the space, as HH:mm or HH:mm:ss.
      - `time_zone` string, nullable — IANA time zone for the space, e.g. America/Los_Angeles.
    - `customer_key` string — Customer key associated with the space.
    - `device_count` number, float, required — Number of devices in the space.
    - `display_name` string, required — Display name for the space.
    - `geolocation` object, nullable — Geographic coordinates (latitude and longitude) of the space.
      - `latitude` number, float, required — Latitude of the space, in decimal degrees.
      - `longitude` number, float, required — Longitude of the space, in decimal degrees.
    - `name` string, required — Name of the space.
    - `space_id` string, uuid, required — ID of the space.
    - `space_key` string — Unique key for the space within the workspace.
    - `workspace_id` string, uuid, required — ID of the workspace associated with the space.

## Other responses

- `400` — Bad Request
- `401` — Unauthorized

---

[API](https://skmtc.net/seam/apis/seam-connect.md) · [All operations](https://skmtc.net/seam/apis/seam-connect/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/seam/seam-connect/versions/00c35395ce12/schema)