API · Create · Workspaces
List workspaces.
List workspaces in the current (orgId, livemode) scope. Cursor-paginated; use ?starting_after=<id> and ?limit=<n> (default 10, max 100). Returns the standard list envelope {object: "list", data, has_more, url, next_cursor?}.
Archived workspaces are excluded by default. Pass ?include_archived=true to widen the list (useful for the Archived workspaces panel), or ?status=archived to filter to archived workspaces specifically.
Last updated
Query Parameters
statusstringOptionalFilter to a single status. Omit to list all non-archived workspaces (the
default). Use ?status=archived to list only archived workspaces, or
?include_archived=true to include archived rows alongside non-archived.
"provisioning""ready""active""archived"include_archivedbooleanOptionalWhen true, include archived workspaces in the result alongside
non-archived. Ignored when ?status= is set explicitly. Default false.
Response Body
application/json
application/problem+json
application/problem+json
Request
curl -X GET "https://api.mattermode.com/v1/workspaces"fetch("https://api.mattermode.com/v1/workspaces", { method: "GET"})package mainimport ( "fmt" "net/http" "io/ioutil")func main() { url := "https://api.mattermode.com/v1/workspaces" req, _ := http.NewRequest("GET", url, nil) res, _ := http.DefaultClient.Do(req) defer res.Body.Close() body, _ := ioutil.ReadAll(res.Body) fmt.Println(res) fmt.Println(string(body))}import requestsheaders = { "Authorization": "Bearer sk_test_4eC39HqLyjWDarjtT1zdp7dc", "Matter-Version": "2026-06-10",}resp = requests.get( "https://api.mattermode.com/v1/workspaces", headers=headers,)resp.raise_for_status()print(resp.json())import java.net.URI;import java.net.http.HttpClient;import java.net.http.HttpRequest;import java.net.http.HttpResponse;import java.net.http.HttpResponse.BodyHandlers;import java.time.Duration;HttpClient client = HttpClient.newBuilder() .connectTimeout(Duration.ofSeconds(10)) .build();HttpRequest.Builder requestBuilder = HttpRequest.newBuilder() .uri(URI.create("https://api.mattermode.com/v1/workspaces")) .GET() .build();try { HttpResponse<String> response = client.send(requestBuilder.build(), BodyHandlers.ofString()); System.out.println("Status code: " + response.statusCode()); System.out.println("Response body: " + response.body());} catch (Exception e) { e.printStackTrace();}using System;using System.Net.Http;using System.Text;var client = new HttpClient();var response = await client.GetAsync("https://api.mattermode.com/v1/workspaces");var responseBody = await response.Content.ReadAsStringAsync();curl --request GET 'https://api.mattermode.com/v1/workspaces' \ --header 'Authorization: Bearer sk_test_4eC39HqLyjWDarjtT1zdp7dc' \ --header 'Matter-Version: 2026-06-10'const response = await fetch("https://api.mattermode.com/v1/workspaces", { method: "GET", headers: { "Authorization": "Bearer sk_test_4eC39HqLyjWDarjtT1zdp7dc", "Matter-Version": "2026-06-10", },});if (!response.ok) { throw new Error(`Matter API ${response.status}: ${await response.text()}`);}const data = await response.json();console.log(data);Response
application/json{
"object": "list",
"data": [
{
"id": "string",
"object": "workspace",
"name": "string",
"status": "provisioning",
"archived_at": 0,
"entity_ids": [
"string"
],
"metadata": {
"customer_id": "cus_7Hpx9WxY",
"portfolio_tag": "y-combinator-w26"
},
"created": 0,
"updated": 0,
"livemode": true
}
],
"has_more": true,
"url": "string",
"next_cursor": "string"
}{
"type": "https://mattermode.com/docs/errors/authentication_required",
"title": "Authentication required",
"status": 401,
"code": "authentication_required",
"detail": "No bearer token was supplied. Pass `Authorization: Bearer sk_live_...` on every request.",
"doc_url": "https://mattermode.com/docs/guides/errors#authentication_required",
"request_id": "req_Qw9xYz8A"
}{
"type": "https://mattermode.com/docs/errors/rate_limit_exceeded",
"title": "Rate limit exceeded",
"status": 429,
"code": "rate_limit_exceeded",
"detail": "Request rate exceeded for this key. Retry after `retry_after` seconds or honor the `Retry-After` header.",
"doc_url": "https://mattermode.com/docs/guides/errors#rate_limit_exceeded",
"request_id": "req_Qw9xYz8A",
"retry_after": 30
}