API · Create · Portfolios
Create a portfolio.
Group multiple entities under a single management context. Portfolios are the multi-tenancy primitive Matter exposes for venture studios, accelerators, family offices, fund admins, and any operator running > 1 entity — a Y Combinator running 200 of its companies through one console, a venture studio incubating ten startups in parallel, an OpsCo holding a corporate group's subsidiaries.
A portfolio is purely organizational — entities inside it remain legally independent — but it unlocks shared infrastructure: a single registered-agent contract that covers every member, a unified compliance calendar that surfaces every entity's filing deadlines on one timeline, batched billing, and the GET /portfolios/{id}/compliance rollup view.
Optional shared resources - shared_registered_agent_id — every member entity defaults to this RegisteredAgent instead of provisioning per-entity. Saves money and consolidates the inbound mail stream. - shared_compliance_calendar — the calendar view aggregates every member's deadlines. Disable for portfolios where each company should manage its own. - metadata — caller-owned key/value annotations. metadata.customer_id is the convention for correlating a portfolio to one of your end customers in embedded deployments. See metadata.
Returns 201 Created with the portfolio resource. Attach existing entities one at a time via `POST /portfolios/{id}/entities`, or form a whole cohort in one call via `POST /portfolios/{id}/entities/batch`. Idempotent via Idempotency-Key. See idempotency.
See also: Cookbook: build a portfolio dashboard, Portfolios API overview.
Last updated
Request Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
namestringRequiredmetadataobjectOptionalFlat string-to-string map. Up to 50 keys. Keys: max 40 chars, charset
[A-Za-z0-9_\\-.]. Values: max 500 chars. Keys prefixed matter_ are reserved
for platform use. Metadata is retrievable but not filterable via query params.
Response Body
application/json
application/problem+json
application/problem+json
application/problem+json
Request
curl -X POST "https://api.mattermode.com/v1/portfolios" \ -H "Content-Type: application/json" \ -d '{ "name": "Waypoint Systems, Inc.", "shared_registered_agent_id": "ra_X8nB5wPq", "shared_compliance_calendar": false, "metadata": { "customer_id": "cus_7Hpx9WxY" } }'const body = JSON.stringify({ "name": "Waypoint Systems, Inc.", "shared_registered_agent_id": "ra_X8nB5wPq", "shared_compliance_calendar": false, "metadata": { "customer_id": "cus_7Hpx9WxY" }})fetch("https://api.mattermode.com/v1/portfolios", { method: "POST", headers: { "Content-Type": "application/json" }, body})package mainimport ( "fmt" "net/http" "io/ioutil" "strings")func main() { url := "https://api.mattermode.com/v1/portfolios" body := strings.NewReader(`{ "name": "Waypoint Systems, Inc.", "shared_registered_agent_id": "ra_X8nB5wPq", "shared_compliance_calendar": false, "metadata": { "customer_id": "cus_7Hpx9WxY" } }`) req, _ := http.NewRequest("POST", url, body) req.Header.Add("Content-Type", "application/json") 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", "Idempotency-Key": "ee7c3a9b-3f1a-4d8e-9b2a-7c5e1f0a2d4b",}payload = { "name": "Waypoint Systems, Inc.", "shared_registered_agent_id": "ra_X8nB5wPq", "shared_compliance_calendar": false, "metadata": { "customer_id": "cus_7Hpx9WxY" }}resp = requests.post( "https://api.mattermode.com/v1/portfolios", headers=headers, json=payload,)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;import java.net.http.HttpRequest.BodyPublishers;var body = BodyPublishers.ofString("""{ "name": "Waypoint Systems, Inc.", "shared_registered_agent_id": "ra_X8nB5wPq", "shared_compliance_calendar": false, "metadata": { "customer_id": "cus_7Hpx9WxY" }}""");HttpClient client = HttpClient.newBuilder() .connectTimeout(Duration.ofSeconds(10)) .build();HttpRequest.Builder requestBuilder = HttpRequest.newBuilder() .uri(URI.create("https://api.mattermode.com/v1/portfolios")) .header("Content-Type", "application/json") .POST(body) .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 body = new StringContent("""{ "name": "Waypoint Systems, Inc.", "shared_registered_agent_id": "ra_X8nB5wPq", "shared_compliance_calendar": false, "metadata": { "customer_id": "cus_7Hpx9WxY" }}""", Encoding.UTF8, "application/json");var client = new HttpClient();var response = await client.PostAsync("https://api.mattermode.com/v1/portfolios", body);var responseBody = await response.Content.ReadAsStringAsync();curl --request POST 'https://api.mattermode.com/v1/portfolios' \ --header 'Authorization: Bearer sk_test_4eC39HqLyjWDarjtT1zdp7dc' \ --header 'Matter-Version: 2026-06-10' \ --header 'Idempotency-Key: ee7c3a9b-3f1a-4d8e-9b2a-7c5e1f0a2d4b' \ --header 'Content-Type: application/json' \ --data '{ "name": "Waypoint Systems, Inc.", "shared_registered_agent_id": "ra_X8nB5wPq", "shared_compliance_calendar": false, "metadata": { "customer_id": "cus_7Hpx9WxY" }}'const response = await fetch("https://api.mattermode.com/v1/portfolios", { method: "POST", headers: { "Authorization": "Bearer sk_test_4eC39HqLyjWDarjtT1zdp7dc", "Matter-Version": "2026-06-10", "Idempotency-Key": "ee7c3a9b-3f1a-4d8e-9b2a-7c5e1f0a2d4b", "Content-Type": "application/json", }, body: JSON.stringify({ "name": "Waypoint Systems, Inc.", "shared_registered_agent_id": "ra_X8nB5wPq", "shared_compliance_calendar": false, "metadata": { "customer_id": "cus_7Hpx9WxY" } }),});if (!response.ok) { throw new Error(`Matter API ${response.status}: ${await response.text()}`);}const data = await response.json();console.log(data);Response
application/json{
"id": "pf_S4dGqL2c",
"object": "portfolio",
"mode": "test",
"name": "Waypoint Systems, Inc.",
"shared_registered_agent_id": "ra_X8nB5wPq",
"shared_compliance_calendar": false,
"entity_ids": [],
"version": 0,
"metadata": {
"customer_id": "cus_7Hpx9WxY"
},
"created_at": "2026-05-12T09:30:00Z",
"updated_at": "2026-05-12T09:30:00Z"
}{
"type": "https://mattermode.com/docs/errors/invalid_request",
"title": "Invalid request",
"status": 400,
"code": "invalid_request",
"detail": "Request body could not be parsed as JSON.",
"doc_url": "https://mattermode.com/docs/guides/errors#invalid_request",
"request_id": "req_Qw9xYz8A"
}{
"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
}