> ## Documentation Index > Fetch the complete documentation index at: https://www.seam.co/docs/llms.txt > Use this file to discover all available pages before exploring further. # Get a Space > Gets a space. You must include at least one request parameter. ## OpenAPI ````yaml /openapi.json get /spaces/get openapi: 3.0.0 info: description: >- Programmable API to control locks, thermostats, noise sensors, cameras, access control systems, and other IoT devices. Prefer the official Seam SDKs over hand-written HTTP calls: they handle authentication, request serialization, pagination, and error handling for you. The official SDKs are listed in this document under `info.x-seam-sdks`. If you call the HTTP API directly, your query parameters must be serialized compatibly with the Seam API. There is no universal convention for serializing arrays, booleans, or nested objects in a query string, so use @seamapi/url-search-params-serializer, the language specific serializer module provided by each Seam SDK, or follow its specification: https://github.com/seamapi/url-search-params-serializer title: Seam Connect version: 1.0.0 x-seam-query-serializer: description: >- Reference implementation and specification for query parameter serialization compatible with the Seam API. url: https://github.com/seamapi/url-search-params-serializer x-seam-sdks: - language: javascript url: https://github.com/seamapi/javascript - language: python url: https://github.com/seamapi/python - language: ruby url: https://github.com/seamapi/ruby - language: php url: https://github.com/seamapi/php - language: csharp url: https://github.com/seamapi/csharp servers: - url: https://connect.getseam.com security: [] tags: - description: access_codes name: /access_codes - description: acs name: /acs - description: action_attempts name: /action_attempts - description: client_sessions name: /client_sessions - description: connected_accounts name: /connected_accounts - description: connect_webviews name: /connect_webviews - description: devices name: /devices - description: events name: /events - description: health name: /health - description: locks name: /locks - description: networks name: /networks - description: noise_sensors name: /noise_sensors - description: phones name: /phones - description: thermostats name: /thermostats - description: user_identities name: /user_identities - description: webhooks name: /webhooks - description: workspaces name: /workspaces paths: /spaces/get: get: tags: [] summary: Get a Space description: |- Gets a space. You must include at least one request parameter. operationId: spacesGetGet parameters: - in: query name: space_id schema: description: ID of the space that you want to get. format: uuid type: string - in: query name: space_key schema: description: Unique key of the space that you want to get. minLength: 1 type: string responses: '200': content: application/json: schema: properties: space: $ref: '#/components/schemas/space' required: - space type: object description: OK '400': description: Bad Request '401': description: Unauthorized security: - pat_with_workspace: [] - console_session_with_workspace: [] - api_key: [] - client_session_with_customer: [] - client_session_with_customer_ro: [] - support_read_only_token: [] x-codeSamples: - lang: javascript label: Seam SDK source: >- await seam.spaces.get({ space_id: "5f30970d-6ef5-4618-9e91-e701fbca6b63" }); /* { "created_at": "2025-06-16T16:54:17.946600Z", "display_name": "My Space", "name": "My Space", "space_id": "5f30970d-6ef5-4618-9e91-e701fbca6b63", "workspace_id": "96bd12f9-6def-4bf4-b517-760417451ae9" } */ - lang: bash label: cURL source: >- curl --include --request POST "https://connect.getseam.com/spaces/get" \ --header "Authorization: Bearer $SEAM_API_KEY" \ --json @- < { "created_at" => "2025-06-16T16:54:17.946600Z", "display_name" => "My Space", "name" => "My Space", "space_id" => "5f30970d-6ef5-4618-9e91-e701fbca6b63", "workspace_id" => "96bd12f9-6def-4bf4-b517-760417451ae9", } - lang: php label: Seam SDK source: >- $seam->spaces->get(space_id: "5f30970d-6ef5-4618-9e91-e701fbca6b63"); // [ "created_at" => "2025-06-16T16:54:17.946600Z", "display_name" => "My Space", "name" => "My Space", "space_id" => "5f30970d-6ef5-4618-9e91-e701fbca6b63", "workspace_id" => "96bd12f9-6def-4bf4-b517-760417451ae9", ]; - lang: bash label: Seam CLI source: |- seam spaces get --space_id "5f30970d-6ef5-4618-9e91-e701fbca6b63" # { # "created_at": "2025-06-16T16:54:17.946600Z", # "display_name": "My Space", # "name": "My Space", # "space_id": "5f30970d-6ef5-4618-9e91-e701fbca6b63", # "workspace_id": "96bd12f9-6def-4bf4-b517-760417451ae9" # } components: schemas: space: description: >- Represents a space that is a logical grouping of devices and entrances. You can assign access to an entire space, thereby making granting access more efficient. See the [space object](/api/spaces/object). properties: acs_entrance_count: description: Number of entrances in the space. format: float type: number created_at: description: Date and time at which the space was created. format: date-time type: string customer_data: additionalProperties: nullable: true type: string description: >- Reservation/stay-related defaults for the space. Also carries the provider/PMS-supplied name under a `_name` key (e.g. `guesty_name`), which Seam preserves when you rename the space (read-only — managed by Seam). properties: address: description: Postal address for the space. nullable: true type: string default_checkin_time: description: >- Default check-in time for reservations at the space, as HH:mm or HH:mm:ss. nullable: true pattern: ^([01]\d|2[0-3]):[0-5]\d(:[0-5]\d)?$ type: string default_checkout_time: description: >- Default check-out time for reservations at the space, as HH:mm or HH:mm:ss. nullable: true pattern: ^([01]\d|2[0-3]):[0-5]\d(:[0-5]\d)?$ type: string time_zone: description: IANA time zone for the space, e.g. America/Los_Angeles. nullable: true type: string type: object customer_key: description: Customer key associated with the space. type: string device_count: description: Number of devices in the space. format: float type: number display_name: description: Display name for the space. type: string geolocation: description: Geographic coordinates (latitude and longitude) of the space. nullable: true properties: latitude: description: Latitude of the space, in decimal degrees. format: float type: number longitude: description: Longitude of the space, in decimal degrees. format: float type: number required: - latitude - longitude type: object name: description: Name of the space. type: string space_id: description: ID of the space. format: uuid type: string space_key: description: Unique key for the space within the workspace. type: string workspace_id: description: ID of the workspace associated with the space. format: uuid type: string required: - space_id - workspace_id - name - display_name - created_at - device_count - acs_entrance_count type: object x-route-path: /spaces securitySchemes: pat_with_workspace: bearerFormat: API Token scheme: bearer type: http console_session_with_workspace: bearerFormat: Console Session Token scheme: bearer type: http api_key: bearerFormat: API Key scheme: bearer type: http client_session_with_customer: bearerFormat: Customer Client Session Token scheme: bearer type: http client_session_with_customer_ro: bearerFormat: Customer Client Session Token (Read-Only) scheme: bearer type: http support_read_only_token: bearerFormat: Support Read-Only Token scheme: bearer type: http ````