API · Manage · Sweeps
List sweeps.
List every Sweep visible to the caller, newest first. Each entry carries its row source, column definitions, status (draft, running, complete, failed), and aggregate cell counts. Expand individual cells with the per-sweep retrieve endpoint. Manage-phase, read-only.
Last updated
Response Body
application/json
Request
curl -X GET "https://api.mattermode.com/v1/sweeps"fetch("https://api.mattermode.com/v1/sweeps", { method: "GET"})package mainimport ( "fmt" "net/http" "io/ioutil")func main() { url := "https://api.mattermode.com/v1/sweeps" 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/sweeps", 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/sweeps")) .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/sweeps");var responseBody = await response.Content.ReadAsStringAsync();curl --request GET 'https://api.mattermode.com/v1/sweeps' \ --header 'Authorization: Bearer sk_test_4eC39HqLyjWDarjtT1zdp7dc' \ --header 'Matter-Version: 2026-06-10'const response = await fetch("https://api.mattermode.com/v1/sweeps", { 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
200Sweeps.
application/json{
"object": "list",
"data": [
{
"id": "swp_a1b2c3d4",
"object": "sweep",
"name": "Series A diligence — material contracts",
"entity_id": "string",
"portfolio_id": "string",
"row_source": "documents",
"row_filter": {},
"columns": [
{
"id": "col_termination",
"name": "Termination notice (days)",
"type": "yes_no",
"instruction": "How many days' notice is required to terminate the agreement?",
"tag_options": [
"string"
]
}
],
"cells": [
{
"row_id": "string",
"col_id": "string",
"summary": "string",
"reasoning": "string",
"citation": {
"ref": 1,
"doc_id": "doc_a1b2c3d4",
"version_id": "ver_e5f6",
"page": 5,
"quote": "A majority of the directors then in office shall constitute a quorum."
},
"status": "pending",
"error": "string"
}
],
"status": "draft",
"started_at": "2019-08-24T14:15:22Z",
"completed_at": "2019-08-24T14:15:22Z",
"created_at": "2019-08-24T14:15:22Z",
"created_by": "string"
}
],
"has_more": true
}