Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
78 changes: 78 additions & 0 deletions docs/api/_blueprint.json
Original file line number Diff line number Diff line change
Expand Up @@ -52471,6 +52471,84 @@
],
"workspaceScope": "required",
"codeSamples": []
},
{
"title": "List Spaces",
"name": "list",
"path": "/seam/customer/v1/spaces/list",
"parentPath": "/seam/customer/v1/spaces",
"description": "Returns a list of all spaces.",
"isDeprecated": false,
"deprecationMessage": "",
"isUndocumented": false,
"undocumentedMessage": "",
"isDraft": true,
"draftMessage": "Early access.",
"response": {
"responseType": "resource_list",
"responseKey": "spaces",
"resourceType": "space",
"description": "OK",
"actionAttemptType": null
},
"request": {
"methods": [
"GET",
"POST"
],
"semanticMethod": "GET",
"preferredMethod": "POST",
"parameters": [
{
"name": "connected_account_id",
"description": "Filter spaces to only include those that contain devices or access control systems belonging to the specified connected account.",
"isRequired": false,
"isDeprecated": false,
"deprecationMessage": "",
"isUndocumented": true,
"undocumentedMessage": "Only used internally.",
"isDraft": true,
"draftMessage": "Needs review.",
"hasDefault": false,
"format": "id",
"jsonType": "string"
},
{
"name": "search",
"description": "String for which to search. Filters returned spaces to include all records that satisfy a partial match using `name`.",
"isRequired": false,
"isDeprecated": false,
"deprecationMessage": "",
"isUndocumented": false,
"undocumentedMessage": "",
"isDraft": false,
"draftMessage": "",
"hasDefault": false,
"format": "string",
"jsonType": "string"
},
{
"name": "space_key",
"description": "Filter spaces by space_key.",
"isRequired": false,
"isDeprecated": false,
"deprecationMessage": "",
"isUndocumented": false,
"undocumentedMessage": "",
"isDraft": false,
"draftMessage": "",
"hasDefault": false,
"format": "string",
"jsonType": "string"
}
]
},
"hasPagination": false,
"authMethods": [
"client_session_token"
],
"workspaceScope": "required",
"codeSamples": []
}
],
"parentPath": "/seam/customer/v1",
Expand Down
6 changes: 6 additions & 0 deletions docs/api/_report.md
Original file line number Diff line number Diff line change
Expand Up @@ -159,6 +159,8 @@ These items are intentionally undocumented.
- `is_programmed`: Not sure if this parameter is supported or what it does.
- `/noise_sensors/noise_thresholds/update`
- `sync`: Only used internally.
- `/seam/customer/v1/spaces/list`
- `connected_account_id`: Only used internally.
- `/spaces/list`
- `connected_account_id`: Only used internally.
- `/thermostats/cool`
Expand Down Expand Up @@ -465,6 +467,7 @@ These items have been marked as draft.
- `/access_methods/unmanaged/get`: Early access.
- `/access_methods/unmanaged/list`: Early access.
- `/seam/customer/v1/spaces/create`: Early access.
- `/seam/customer/v1/spaces/list`: Early access.
- `/spaces/add_acs_entrances`: Early access.
- `/spaces/add_devices`: Early access.
- `/spaces/create`: Early access.
Expand All @@ -478,6 +481,8 @@ These items have been marked as draft.

### Endpoint parameters

- `/seam/customer/v1/spaces/list`
- `connected_account_id`: Needs review.
- `/spaces/list`
- `connected_account_id`: Needs review.

Expand Down Expand Up @@ -616,6 +621,7 @@ These items are deprecated.
- `/instant_keys/list`
- `/locks/get`
- `/seam/customer/v1/spaces/create`
- `/seam/customer/v1/spaces/list`
- `/spaces/get_related`
- `/user_identities/unmanaged/get`
- `/user_identities/unmanaged/list`
Expand Down
5 changes: 5 additions & 0 deletions docs/api/seam/customer/v1/spaces/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,3 +8,8 @@
Creates a new space with optional parent space support.


[**`/seam/customer/v1/spaces/list`**](./list.md)

Returns a list of all spaces.


53 changes: 53 additions & 0 deletions docs/api/seam/customer/v1/spaces/list.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,53 @@
# List Spaces

- [Request Parameters](#request-parameters)
- [Response](#response)

Returns a list of all spaces.


<details>

<summary>Authentication Methods</summary>

- Client session token

To learn more, see [Authentication](https://docs.seam.co/latest/api/authentication).
</details>

## Request Parameters

**`search`** *String*

String for which to search. Filters returned spaces to include all records that satisfy a partial match using `name`.

---

**`space_key`** *String*

Filter spaces by space_key.

---


## Response

Array of [spaces](./../../../../spaces)


{% tabs %}
{% tab title="JSON" %}



```json
{
"created_at": "2025-06-16T16:54:17.946600Z",
"display_name": "My Space",
"name": "My Space",
"space_id": "5afeb047-3277-4102-b8c4-99edf05b91d2",
"workspace_id": "96bd12f9-6def-4bf4-b517-760417451ae9"
}
```
{% endtab %}
{% endtabs %}
8 changes: 4 additions & 4 deletions package-lock.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@
"@prettier/plugin-ruby": "^4.0.4",
"@seamapi/blueprint": "^0.51.3",
"@seamapi/smith": "^0.5.2",
"@seamapi/types": "1.592.0",
"@seamapi/types": "1.593.0",
"@types/command-exists": "^1.2.3",
"change-case": "^5.4.4",
"command-exists": "^1.2.9",
Expand Down
Loading