> 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/rcs-agents/list/llms.txt. > For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://docs.pinnacle.sh/_mcp/server. # List RCS Agents POST https://api.pinnacle.sh/rcs/agents/list Content-Type: application/json List all RCS agents with pagination. Results are sorted by creation date, newest first. Reference: https://docs.pinnacle.sh/api-reference/rcs-agents/list ## Authentication - `PINNACLE-API-KEY` header (required) — API Key authentication via header ## Request ### Body (application/json) This endpoint expects a ListAgentsRequest. - `pageIndex` (integer, optional, default: 0) - `pageSize` (integer, optional, default: 20) - `agentType` (enum, optional) — Filter by agent type. - Allowed values: `PRODUCTION`, `TEST` - `name` (string, optional) — Case-insensitive substring search on agent name. ## Response ### 200 Returns paginated list of agents. - `data` (list of AgentSummary, 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 ### AgentSummary - `agentId` (string, required) — Unique identifier for the agent. - `agentType` (enum, required) — Type of the agent. - Allowed values: `PRODUCTION`, `TEST` - `createdAt` (string, required) — ISO 8601 timestamp of when the agent was created. - `updatedAt` (string, required) — ISO 8601 timestamp of when the agent was last updated. - `serviceId` (string, optional, nullable) — Service ID associated with the agent. - `carrierLaunches` (AgentSummaryCarrierLaunches, optional, nullable) — Raw per-carrier launch + verification state for the agent. Each value is tri-state — `null` means "no launch requested" or "not sent yet"; `false` means "pending" / "sent"; `true` means "launched" / "verified". Use the [GET /rcs/\{agentId}](/api-reference/rcs-agents/get) endpoint for the resolved enum representation. - `config` (AgentSummaryConfig, optional, nullable) — Agent configuration details. ### 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 ### AgentSummaryCarrierLaunches Raw per-carrier launch + verification state for the agent. Each value is tri-state — `null` means "no launch requested" or "not sent yet"; `false` means "pending" / "sent"; `true` means "launched" / "verified". Use the [GET /rcs/\{agentId}](/api-reference/rcs-agents/get) endpoint for the resolved enum representation. - `ATT` (boolean, optional, nullable) — Launch status for AT&T. null = not requested, false = pending, true = launched. - `OTHERS` (boolean, optional, nullable) — Launch status for other carriers. null = not requested, false = pending, true = launched. - `TMOBILE` (boolean, optional, nullable) — Launch status for T-Mobile. null = not requested, false = pending, true = launched. - `VERIZON` (boolean, optional, nullable) — Launch status for Verizon. null = not requested, false = pending, true = launched. - `AEGIS` (boolean, optional, nullable) — AEGIS verification status. null = not sent, false = sent, true = verified. - `GOOGLE` (boolean, optional, nullable) — Google verification status. null = not sent, false = sent, true = verified. ### AgentSummaryConfig Agent configuration details. - `name` (string, optional) — Display name of the agent (max 40 characters). - `description` (string, optional) — Description of the agent (max 100 characters). - `color` (string, optional) — Hex color code for the agent. - `websites` (list of AgentSummaryConfigWebsitesItems, optional) - `phones` (list of AgentSummaryConfigPhonesItems, optional) - `emails` (list of AgentSummaryConfigEmailsItems, optional) - `iconUrl` (string, optional, nullable) — Logo image URL. - `heroUrl` (string, optional, nullable) — Hero image URL. - `privacyUrl` (string, optional, nullable) — Privacy policy URL. - `termsUrl` (string, optional, nullable) — Terms of service URL. - `isConversational` (boolean, optional, nullable) — Whether the agent supports two-way conversation. - `agentUseCase` (enum, optional, nullable) — Use case for the agent. - Allowed values: `TRANSACTIONAL`, `PROMOTIONAL`, `OTP`, `MULTI_USE` ### AgentSummaryConfigWebsitesItems - `url` (string, optional) - `label` (string, optional) ### AgentSummaryConfigPhonesItems - `phone` (string, optional) - `label` (string, optional) ### AgentSummaryConfigEmailsItems - `email` (string, optional) - `label` (string, optional) ## Examples **Request** ```json {} ``` **Response** ```json { "data": [ { "agentId": "agent_abc123", "agentType": "TEST", "createdAt": "2025-01-15T10:30:00Z", "updatedAt": "2025-02-20T14:00:00Z", "serviceId": "pinnacletest_agent", "carrierLaunches": { "ATT": null, "OTHERS": null, "TMOBILE": true, "VERIZON": false }, "config": { "name": "My Test Agent", "description": "A test RCS agent", "color": "#FF6B00" } } ], "hasMore": false, "count": 1 } ``` **SDK Code** ```python List RCS Agents import requests url = "https://api.pinnacle.sh/rcs/agents/list" payload = {} headers = { "PINNACLE-API-KEY": "", "Content-Type": "application/json" } response = requests.post(url, json=payload, headers=headers) print(response.json()) ``` ```javascript List RCS Agents const url = 'https://api.pinnacle.sh/rcs/agents/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 List RCS Agents package main import ( "fmt" "strings" "net/http" "io" ) func main() { url := "https://api.pinnacle.sh/rcs/agents/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 List RCS Agents require 'uri' require 'net/http' url = URI("https://api.pinnacle.sh/rcs/agents/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 List RCS Agents import com.mashape.unirest.http.HttpResponse; import com.mashape.unirest.http.Unirest; HttpResponse response = Unirest.post("https://api.pinnacle.sh/rcs/agents/list") .header("PINNACLE-API-KEY", "") .header("Content-Type", "application/json") .body("{}") .asString(); ``` ```php List RCS Agents request('POST', 'https://api.pinnacle.sh/rcs/agents/list', [ 'body' => '{}', 'headers' => [ 'Content-Type' => 'application/json', 'PINNACLE-API-KEY' => '', ], ]); echo $response->getBody(); ``` ```csharp List RCS Agents using RestSharp; var client = new RestClient("https://api.pinnacle.sh/rcs/agents/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 List RCS Agents 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/rcs/agents/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.