API · Exit · Entities
Retrieve the creditor claims window.
Returns the entity's current CreditorClaimsWindow. One window per entity at a time; returns 404 not_found if no window has been started. Use to poll the window's status (pending_publication → open → closed), enumerate claims_received[], and inspect the per-recipient notice trail in known_creditors[].
Last updated
Response Body
application/json
application/problem+json
Request
curl -X GET "https://api.mattermode.com/v1/entities/{id}/creditor_claims_window"fetch("https://api.mattermode.com/v1/entities/{id}/creditor_claims_window", { method: "GET"})package mainimport ( "fmt" "net/http" "io/ioutil")func main() { url := "https://api.mattermode.com/v1/entities/{id}/creditor_claims_window" 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/creditor_claims_window", 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}/creditor_claims_window")) .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}/creditor_claims_window");var responseBody = await response.Content.ReadAsStringAsync();curl --request GET 'https://api.mattermode.com/v1/entities/ent_Nq3KcAbc/creditor_claims_window' \ --header 'Authorization: Bearer sk_test_4eC39HqLyjWDarjtT1zdp7dc' \ --header 'Matter-Version: 2026-06-10'const response = await fetch("https://api.mattermode.com/v1/entities/ent_Nq3KcAbc/creditor_claims_window", { 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": "creditor_claims_window",
"id": "string",
"entity_id": "string",
"procedure": "default_281",
"statutory_window_days": 60,
"publication_date": "2019-08-24",
"opened_at": "2019-08-24T14:15:22Z",
"closes_at": "2019-08-24T14:15:22Z",
"closed_at": "2019-08-24T14:15:22Z",
"status": "pending_publication",
"known_creditors": [
{
"recipient_id": "string",
"recipient_name": "string",
"notice_channel": "certified_mail",
"notice_sent_at": "2019-08-24T14:15:22Z",
"notice_document_id": "string",
"delivery_confirmed_at": "2019-08-24T14:15:22Z"
}
],
"publication_records": [
{
"publication": "string",
"publication_date": "2019-08-24",
"proof_document_id": "string"
}
],
"claims_received": [
{
"claim_id": "string",
"claimant_name": "string",
"received_at": "2019-08-24T14:15:22Z",
"amount_claimed_usd": 0,
"basis": "string",
"status": "open",
"settled_at": "2019-08-24T14:15:22Z",
"settlement_document_id": "string"
}
],
"created": 0,
"updated": 0,
"livemode": true
}{
"type": "https://mattermode.com/docs/errors/not_found",
"title": "Not found",
"status": 404,
"code": "not_found",
"detail": "No entity with id `ent_Nq3KcAbc` is visible to this token.",
"doc_url": "https://mattermode.com/docs/guides/errors#not_found",
"request_id": "req_Qw9xYz8A"
}