---
title: "Get Agent"
method: GET
path: "/rcs/{agentId}"
tags: ["rcs"]
---

# Get Agent

`GET /rcs/{agentId}`

## Request

- Base URL: `https://api.pinnacle.sh`
- URL: `https://api.pinnacle.sh/rcs/{agentId}`
- Auth: API key in header `PINNACLE-API-KEY`

Retrieve details of an RCS agent by its ID.

Returns the agent's configuration including display name, description, logo, hero image,
contact information, and other settings.

## Path parameters

- `agentId` string, required

## Response `200`

The agent details.

- RcsAgentResponse: Response containing details of an RCS agent.
  - `id` string, required: The unique agent ID, prefixed with `agent_`.
  - `type` 'TEST', required: The agent type. - `TEST` — A test agent for development and testing with whitelisted numbers only.
  - `serviceId` string, required: The RCS service ID assigned to this agent.
  - `carrierLaunches` CarrierLaunches, required: Per-carrier launch status grouped by category. `carriers` covers AT&T / T-Mobile / Verizon / other carriers; `verification` covers the AEGIS and Google verification flows.
    - `carriers` CarrierLaunchesCarriers, required: Per-carrier launch status. Each carrier moves through `NOT_LAUNCHED` → `PENDING` → `LAUNCHED` as Pinnacle submits the agent for review and the carrier accepts it. The agent is only deliverable on a carrier once that carrier reports `LAUNCHED`.
      - `ATT` 'NOT_LAUNCHED' | 'PENDING' | 'LAUNCHED', required: Launch status for a carrier. - `NOT_LAUNCHED` — No launch requested. - `PENDING` — Launch pending. - `LAUNCHED` — Launched.
      - `TMOBILE` 'NOT_LAUNCHED' | 'PENDING' | 'LAUNCHED', required: Launch status for a carrier. - `NOT_LAUNCHED` — No launch requested. - `PENDING` — Launch pending. - `LAUNCHED` — Launched.
      - `VERIZON` 'NOT_LAUNCHED' | 'PENDING' | 'LAUNCHED', required: Launch status for a carrier. - `NOT_LAUNCHED` — No launch requested. - `PENDING` — Launch pending. - `LAUNCHED` — Launched.
      - `OTHERS` 'NOT_LAUNCHED' | 'PENDING' | 'LAUNCHED', required: Launch status for a carrier. - `NOT_LAUNCHED` — No launch requested. - `PENDING` — Launch pending. - `LAUNCHED` — Launched.
    - `verification` CarrierLaunchesVerification, required: External verifier status. AEGIS (the U.S. carrier vetting authority used by AT&T, T-Mobile, and Verizon) and Google each send a verification email to the brand's contact address. Each verifier moves through `NOT_SENT` → `SENT` → `VERIFIED` once the brand replies and the verifier confirms ownership.
      - `AEGIS` 'NOT_SENT' | 'SENT' | 'VERIFIED', required: Verification status for an external verifier (AEGIS, Google). - `NOT_SENT` — Verification email not sent yet. - `SENT` — Email sent, awaiting reply on the brand contact email. - `VERIFIED` — Verified.
      - `GOOGLE` 'NOT_SENT' | 'SENT' | 'VERIFIED', required: Verification status for an external verifier (AEGIS, Google). - `NOT_SENT` — Verification email not sent yet. - `SENT` — Email sent, awaiting reply on the brand contact email. - `VERIFIED` — Verified.
  - `details` RcsAgentDetails, required: The configuration details of an RCS agent, as returned by the GET endpoint.
    - `name` string: Display name of the agent.
    - `description` string: Description of the agent.
    - `iconUrl` string, uri, nullable: URL to the agent's logo image.
    - `heroUrl` string, uri, nullable: URL to the agent's hero banner image.
    - `color` string: The agent's brand color hex code.
    - `phones` RcsAgentDetailsPhonesItems[]: Contact phone numbers for the agent.
      - `phone` string: Phone number in E.164 format.
      - `label` string: Display label for the phone number.
    - `emails` RcsAgentDetailsEmailsItems[]: Contact email addresses for the agent.
      - `email` string: Email address.
      - `label` string: Display label for the email.
    - `websites` RcsAgentDetailsWebsitesItems[]: Website links for the agent.
      - `url` string: Website URL.
      - `label` string: Display label for the website.
    - `privacyUrl` string, uri, nullable: URL to the agent's privacy policy.
    - `termsUrl` string, uri, nullable: URL to the agent's terms and conditions.
    - `isConversational` boolean, nullable: Whether the agent supports two-way conversations. `true` for agents that respond to user messages, `false` for send-only agents (e.g., notifications).
    - `agentUseCase` 'TRANSACTIONAL' | 'PROMOTIONAL' | 'OTP' | 'MULTI_USE': The primary use case for the RCS agent. - `TRANSACTIONAL` — Order confirmations, shipping updates, appointment reminders. - `PROMOTIONAL` — Marketing messages, offers, discounts. - `OTP` — One-time passwords and verification codes. - `MULTI_USE` — A combination of transactional, promotional, and/or OTP messaging.

## Other responses

- `400`: Validation failed. The payload has missing required fields and/or invalid types. <br> See https://zod.dev/error-formatting for more information.
- `401`: The request lacks valid authentication credentials or the provided credentials are invalid. <br> Ensure you're including a valid API key in the request headers and that your account has the necessary permissions to access this endpoint.
- `403`: Your subscription does not include access to this feature. <br> This occurs when attempting to use functionality that requires a higher subscription tier. Please upgrade your subscription to access this feature.
- `404`: The requested resource could not be found. <br> This may occur if the identifier is incorrect, the resource has been deleted, or you don't have permission to access it.
- `500`: An unexpected error occurred on Pinnacle's servers while processing your request. <br> If this error persists, please contact support with the request details.

---

[API](https://skmtc.dev/pinnacle/apis/pinnacle-2.md) - [All operations](https://skmtc.dev/pinnacle/apis/pinnacle-2/llms.txt) - [OpenAPI document](https://skmtc.dev/pinnacle/apis/pinnacle-2/revisions/45416dadab79?raw)