API · Create · Sessions
List formation sessions.
List formation sessions for the calling org+mode. Cursor-paginated; pass limit and starting_after to walk pages. Optionally filter by status. See pagination for the envelope shape.
Last updated
Query Parameters
sortstringOptionalComma-separated sort keys. Leading - = descending. Default -created
(reverse chronological).
expandarray<string>OptionalExpand one or more related resources inline. Dot-notation for nested
(cap_table.share_classes). Max depth 4. Only fields marked x-matter-expandable
on their parent schema can be expanded.
fieldsarray<string>OptionalNarrow the response to only the named fields. Shape is preserved (id and object
are always included). Useful for agent runtimes that spend tokens on list responses
— a 500-entity list with fields[]=id&fields[]=status returns ~2 KB instead of
~2 MB. Dot-notation unsupported here; compose with expand[] when nested shape
is needed.
metadataobjectOptionalFilter a list endpoint by exact metadata values. Encode as
?metadata[key]=value. Multiple pairs AND together. Keys missing the supplied
metadata entry are excluded. Prefer sparse metadata keys — every filtered key
incurs an index cost. For boolean composition or substring match, use the search
DSL (POST /<resource>/search).
statusstringOptional"started""entity_created""docs_signed""filing_submitted""ein_received""bank_opened""active""expired"Response Body
application/json
application/problem+json
Request
curl -X GET "https://api.mattermode.com/v1/formation_sessions"fetch("https://api.mattermode.com/v1/formation_sessions", { method: "GET"})package mainimport ( "fmt" "net/http" "io/ioutil")func main() { url := "https://api.mattermode.com/v1/formation_sessions" 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/formation_sessions", 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/formation_sessions")) .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/formation_sessions");var responseBody = await response.Content.ReadAsStringAsync();curl --request GET 'https://api.mattermode.com/v1/formation_sessions' \ --header 'Authorization: Bearer sk_test_4eC39HqLyjWDarjtT1zdp7dc' \ --header 'Matter-Version: 2026-06-10'const response = await fetch("https://api.mattermode.com/v1/formation_sessions", { 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": "fss_b3nkpl5x9q2w7r4t",
"object": "formation_session",
"entity_id": "ent_Nq3KcAbc",
"intent_id": "itt_3sR8wPbX",
"mode": "test",
"status": "started",
"current_step": "intent",
"progress": {},
"started_at": "2026-06-08T12:00:00.000Z",
"completed_at": null,
"version": 0,
"created_at": "2026-06-08T12:00:00.000Z",
"updated_at": "2026-06-08T12:00:00.000Z"
}
],
"has_more": false,
"url": "/v1/formation_sessions",
"next_cursor": null
}{
"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"
}