API · Manage · Equity
List vesting overlays.
List every VestingOverlay attached to this entity. Each overlay layers a vesting schedule on top of an existing ShareLedgerEntry + companion Grant without rewriting the original issuance, so the response reflects the as-currently-in-effect schedule for previously-issued shares. Manage-phase, read-only.
Last updated
Response Body
application/json
Request
curl -X GET "https://api.mattermode.com/v1/entities/{id}/vesting_overlays"fetch("https://api.mattermode.com/v1/entities/{id}/vesting_overlays", { method: "GET"})package mainimport ( "fmt" "net/http" "io/ioutil")func main() { url := "https://api.mattermode.com/v1/entities/{id}/vesting_overlays" 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/entities/ent_Nq3KcAbc/vesting_overlays", 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/entities/{id}/vesting_overlays")) .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/entities/{id}/vesting_overlays");var responseBody = await response.Content.ReadAsStringAsync();curl --request GET 'https://api.mattermode.com/v1/entities/ent_Nq3KcAbc/vesting_overlays' \ --header 'Authorization: Bearer sk_test_4eC39HqLyjWDarjtT1zdp7dc' \ --header 'Matter-Version: 2026-06-10'const response = await fetch("https://api.mattermode.com/v1/entities/ent_Nq3KcAbc/vesting_overlays", { 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": "vesting_overlay",
"entity_id": "string",
"ledger_entry_id": "string",
"grant_id": "string",
"vesting_schedule": {
"cliff_months": 0,
"total_months": 1,
"granularity": "monthly",
"commencement_date": "2019-08-24"
},
"authorizing_resolution_id": "string",
"tax_election_acknowledgement": {
"acknowledged_implications": true,
"decision": "file_new_83b",
"new_83b_document_id": "string"
},
"effective_date": "2019-08-24",
"document_id": "string",
"metadata": {
"customer_id": "cus_7Hpx9WxY",
"portfolio_tag": "y-combinator-w26"
},
"created": 0,
"updated": 0,
"livemode": true
}
],
"has_more": true,
"next_cursor": "string"
}No example available.