List Spaces

Early Access Preview. The spaces API is currently in Alpha. We're actively developing it and seeking early feedback at [email protected]. Expect breaking changes as we refine the design.

• Request Parameters

• Response

Returns a list of all spaces.

JavaScript

Returns a list of all spaces.

Code:

await seam.spaces.list();

Output:

[
  {
    "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"
  }
]

cURL

Returns a list of all spaces.

Code:

curl --include --request POST "https://connect.getseam.com/spaces/list" \
  --header "Authorization: Bearer $SEAM_API_KEY"

Output:

{
  "spaces": [
    {
      "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"
    }
  ]
}

Python

Returns a list of all spaces.

Code:

seam.spaces.list()

Output:

[
    Space(
        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",
    )
]

Ruby

Returns a list of all spaces.

Code:

seam.spaces.list()

Output:

[
  {
    "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",
  },
]

PHP

Returns a list of all spaces.

Code:

$seam->spaces->list();

Output:

[
    [
        "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",
    ],
];

Seam CLI

Returns a list of all spaces.

Code:

seam spaces list

Output:

[
  {
    "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"
  }
]

Authentication Methods

• API key

• Client session token

• Personal access token Must also include the seam-workspace header in the request.

To learn more, see Authentication.

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

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"
}