> For clean Markdown of any page, append .md to the page URL. > For a complete documentation index, see https://docs.pinnacle.sh/v-2/api-reference/messages/list-blasts/llms.txt. > For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://docs.pinnacle.sh/_mcp/server. # List Blasts POST https://api.pinnacle.sh/messages/blasts/list Content-Type: application/json List all blasts with optional filtering and pagination. Results are sorted by creation date, newest first. Reference: https://docs.pinnacle.sh/api-reference/messages/list-blasts ## Authentication - `PINNACLE-API-KEY` header (required) — API Key authentication via header ## Request ### Body (application/json) This endpoint expects a ListBlastsRequest. - `pageIndex` (integer, optional, default: 0) - `pageSize` (integer, optional, default: 20) - `audienceId` (string, optional) — Filter blasts by audience ID. - `sender` (string, optional) — Filter blasts that include this sender (phone number or agent ID). - `content` (string, optional) — Search blast content (partial match, case-insensitive). ## Response ### 200 Returns paginated list of blasts. - `data` (list of BlastSummary, required) - `hasMore` (boolean, required) - `count` (integer, required) ## Errors ### 400 Bad Request Error Validation failed. The payload has missing required fields and/or invalid types. See [https://zod.dev/error-formatting](https://zod.dev/error-formatting) for more information. - `description` (string, required) — Human-readable summary of validation failures. - `errors` (ZodErrorErrors, required) — Structured dictionary of issues containing two main sections: - `errors`: Array of global validation errors not tied to specific fields - `properties`: Object mapping field names to their specific validation errors, where each field contains an `errors` array ### 401 Unauthorized Error The request lacks valid authentication credentials or the provided credentials are invalid. Ensure you're including a valid API key in the request headers and that your account has the necessary permissions to access this endpoint. - `error` (string, required) — Human-readable description of the error that occurred, corresponding to the HTTP status code. ### 500 Internal Server Error An unexpected error occurred on Pinnacle's servers while processing your request. If this error persists, please contact support with the request details. - `error` (string, required) — Human-readable description of the error that occurred, corresponding to the HTTP status code. ## Types ### BlastSummary - `id` (string, required) — Unique identifier for the blast. - `audienceId` (string, required) — Audience ID associated with this blast. - `type` (enum, required) — Type of the blast message. - Allowed values: `SMS`, `MMS`, `RCS` - `senders` (list of string, required) — Sender identifiers (phone numbers or agent IDs) used for the blast. - `content` (BlastSummaryContent, required) — Message content sent in the blast. - `options` (BlastSummaryOptions, required, nullable) — Blast options configuration. - `fallback` (BlastSummaryFallback, required, nullable) — Fallback message configuration, if any. - `createdAt` (string, required) — ISO 8601 timestamp of when the blast was created. ### ZodErrorErrors Structured dictionary of issues containing two main sections: - `errors`: Array of global validation errors not tied to specific fields - `properties`: Object mapping field names to their specific validation errors, where each field contains an `errors` array ### BlastSummaryContent Message content sent in the blast. ### BlastSummaryOptions Blast options configuration. ### BlastSummaryFallback Fallback message configuration, if any. ## Examples ### SMS Blast **Request** ```json {} ``` **Response** ```json { "data": [ { "id": "blast_abc123", "audienceId": "aud_abc123", "type": "SMS", "senders": [ "+12125551234" ], "content": { "text": "Flash sale — 20% off everything today!" }, "options": null, "fallback": null, "createdAt": "2025-01-15T10:30:00Z" } ], "hasMore": false, "count": 1 } ``` **SDK Code** ```python SMS Blast import requests url = "https://api.pinnacle.sh/messages/blasts/list" payload = {} headers = { "PINNACLE-API-KEY": "", "Content-Type": "application/json" } response = requests.post(url, json=payload, headers=headers) print(response.json()) ``` ```javascript SMS Blast const url = 'https://api.pinnacle.sh/messages/blasts/list'; const options = { method: 'POST', headers: {'PINNACLE-API-KEY': '', 'Content-Type': 'application/json'}, body: '{}' }; try { const response = await fetch(url, options); const data = await response.json(); console.log(data); } catch (error) { console.error(error); } ``` ```go SMS Blast package main import ( "fmt" "strings" "net/http" "io" ) func main() { url := "https://api.pinnacle.sh/messages/blasts/list" payload := strings.NewReader("{}") req, _ := http.NewRequest("POST", url, payload) req.Header.Add("PINNACLE-API-KEY", "") req.Header.Add("Content-Type", "application/json") res, _ := http.DefaultClient.Do(req) defer res.Body.Close() body, _ := io.ReadAll(res.Body) fmt.Println(res) fmt.Println(string(body)) } ``` ```ruby SMS Blast require 'uri' require 'net/http' url = URI("https://api.pinnacle.sh/messages/blasts/list") http = Net::HTTP.new(url.host, url.port) http.use_ssl = true request = Net::HTTP::Post.new(url) request["PINNACLE-API-KEY"] = '' request["Content-Type"] = 'application/json' request.body = "{}" response = http.request(request) puts response.read_body ``` ```java SMS Blast import com.mashape.unirest.http.HttpResponse; import com.mashape.unirest.http.Unirest; HttpResponse response = Unirest.post("https://api.pinnacle.sh/messages/blasts/list") .header("PINNACLE-API-KEY", "") .header("Content-Type", "application/json") .body("{}") .asString(); ``` ```php SMS Blast request('POST', 'https://api.pinnacle.sh/messages/blasts/list', [ 'body' => '{}', 'headers' => [ 'Content-Type' => 'application/json', 'PINNACLE-API-KEY' => '', ], ]); echo $response->getBody(); ``` ```csharp SMS Blast using RestSharp; var client = new RestClient("https://api.pinnacle.sh/messages/blasts/list"); var request = new RestRequest(Method.POST); request.AddHeader("PINNACLE-API-KEY", ""); request.AddHeader("Content-Type", "application/json"); request.AddParameter("application/json", "{}", ParameterType.RequestBody); IRestResponse response = client.Execute(request); ``` ```swift SMS Blast import Foundation let headers = [ "PINNACLE-API-KEY": "", "Content-Type": "application/json" ] let parameters = [] as [String : Any] let postData = JSONSerialization.data(withJSONObject: parameters, options: []) let request = NSMutableURLRequest(url: NSURL(string: "https://api.pinnacle.sh/messages/blasts/list")! as URL, cachePolicy: .useProtocolCachePolicy, timeoutInterval: 10.0) request.httpMethod = "POST" request.allHTTPHeaderFields = headers request.httpBody = postData as Data let session = URLSession.shared let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in if (error != nil) { print(error as Any) } else { let httpResponse = response as? HTTPURLResponse print(httpResponse) } }) dataTask.resume() ``` ### RCS Blast with Fallback **Request** ```json {} ``` **Response** ```json { "data": [ { "id": "blast_def456", "audienceId": "aud_abc123", "type": "RCS", "senders": [ "agent_abc123" ], "content": { "text": "Hi! Check out our new spring collection 🌸" }, "options": { "transcode": true, "validate": false, "standalone_card": { "orientation": "VERTICAL", "image_alignment": "LEFT" } }, "fallback": { "from": "+12125551234", "text": "Check out our new spring collection at https://example.com/spring", "mediaUrls": [ "https://example.com/spring-banner.jpg" ] }, "createdAt": "2025-02-01T12:00:00Z" } ], "hasMore": false, "count": 1 } ``` **SDK Code** ```python RCS Blast with Fallback import requests url = "https://api.pinnacle.sh/messages/blasts/list" payload = {} headers = { "PINNACLE-API-KEY": "", "Content-Type": "application/json" } response = requests.post(url, json=payload, headers=headers) print(response.json()) ``` ```javascript RCS Blast with Fallback const url = 'https://api.pinnacle.sh/messages/blasts/list'; const options = { method: 'POST', headers: {'PINNACLE-API-KEY': '', 'Content-Type': 'application/json'}, body: '{}' }; try { const response = await fetch(url, options); const data = await response.json(); console.log(data); } catch (error) { console.error(error); } ``` ```go RCS Blast with Fallback package main import ( "fmt" "strings" "net/http" "io" ) func main() { url := "https://api.pinnacle.sh/messages/blasts/list" payload := strings.NewReader("{}") req, _ := http.NewRequest("POST", url, payload) req.Header.Add("PINNACLE-API-KEY", "") req.Header.Add("Content-Type", "application/json") res, _ := http.DefaultClient.Do(req) defer res.Body.Close() body, _ := io.ReadAll(res.Body) fmt.Println(res) fmt.Println(string(body)) } ``` ```ruby RCS Blast with Fallback require 'uri' require 'net/http' url = URI("https://api.pinnacle.sh/messages/blasts/list") http = Net::HTTP.new(url.host, url.port) http.use_ssl = true request = Net::HTTP::Post.new(url) request["PINNACLE-API-KEY"] = '' request["Content-Type"] = 'application/json' request.body = "{}" response = http.request(request) puts response.read_body ``` ```java RCS Blast with Fallback import com.mashape.unirest.http.HttpResponse; import com.mashape.unirest.http.Unirest; HttpResponse response = Unirest.post("https://api.pinnacle.sh/messages/blasts/list") .header("PINNACLE-API-KEY", "") .header("Content-Type", "application/json") .body("{}") .asString(); ``` ```php RCS Blast with Fallback request('POST', 'https://api.pinnacle.sh/messages/blasts/list', [ 'body' => '{}', 'headers' => [ 'Content-Type' => 'application/json', 'PINNACLE-API-KEY' => '', ], ]); echo $response->getBody(); ``` ```csharp RCS Blast with Fallback using RestSharp; var client = new RestClient("https://api.pinnacle.sh/messages/blasts/list"); var request = new RestRequest(Method.POST); request.AddHeader("PINNACLE-API-KEY", ""); request.AddHeader("Content-Type", "application/json"); request.AddParameter("application/json", "{}", ParameterType.RequestBody); IRestResponse response = client.Execute(request); ``` ```swift RCS Blast with Fallback import Foundation let headers = [ "PINNACLE-API-KEY": "", "Content-Type": "application/json" ] let parameters = [] as [String : Any] let postData = JSONSerialization.data(withJSONObject: parameters, options: []) let request = NSMutableURLRequest(url: NSURL(string: "https://api.pinnacle.sh/messages/blasts/list")! as URL, cachePolicy: .useProtocolCachePolicy, timeoutInterval: 10.0) request.httpMethod = "POST" request.allHTTPHeaderFields = headers request.httpBody = postData as Data let session = URLSession.shared let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in if (error != nil) { print(error as Any) } else { let httpResponse = response as? HTTPURLResponse print(httpResponse) } }) dataTask.resume() ``` > One API for RCS, iMessage, MMS, and SMS. Build, test, and scale every channel — send your first message in minutes, not weeks.