@seamapi/http - v2.0.0
    Preparing search index...

    Type Alias Space

    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.

    type Space = {
        acs_entrance_count: number;
        created_at: string;
        customer_data?: {
            address?: string | null;
            default_checkin_time?: string | null;
            default_checkout_time?: string | null;
            time_zone?: string | null;
        };
        customer_key?: string;
        device_count: number;
        display_name: string;
        geolocation?: { latitude: number; longitude: number }
        | null;
        name: string;
        space_id: string;
        space_key?: string;
        workspace_id: string;
    }
    Index
    acs_entrance_count created_at customer_data? customer_key? device_count display_name geolocation? name space_id space_key? workspace_id
    acs_entrance_count: number

    Number of entrances in the space.

    created_at: string

    Date and time at which the space was created.

    customer_data?: {
        address?: string | null;
        default_checkin_time?: string | null;
        default_checkout_time?: string | null;
        time_zone?: string | null;
    }

    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).

    Type Declaration

    • Optionaladdress?: string | null

      Postal address for the space.

    • Optionaldefault_checkin_time?: string | null

      Default check-in time for reservations at the space, as HH:mm or HH:mm:ss.

    • Optionaldefault_checkout_time?: string | null

      Default check-out time for reservations at the space, as HH:mm or HH:mm:ss.

    • Optionaltime_zone?: string | null

      IANA time zone for the space, e.g. America/Los_Angeles.

    customer_key?: string

    Customer key associated with the space.

    device_count: number

    Number of devices in the space.

    display_name: string

    Display name for the space.

    geolocation?: { latitude: number; longitude: number } | null

    Geographic coordinates (latitude and longitude) of the space.

    Type Declaration

    • { latitude: number; longitude: number }
      • latitude: number

        Latitude of the space, in decimal degrees.

      • longitude: number

        Longitude of the space, in decimal degrees.

    • null
    name: string

    Name of the space.

    space_id: string

    ID of the space.

    space_key?: string

    Unique key for the space within the workspace.

    workspace_id: string

    ID of the workspace associated with the space.

    Settings
    Member Visibility

    On This Page
    Properties