Get Agent | Pinnacle | Documentation

curl https://api.pinnacle.sh/rcs/agent_abc123def456 \
     -H "PINNACLE-API-KEY: <apiKey>"

{
  "id": "agent_abc123def456",
  "type": "TEST",
  "serviceId": "acme-support_agent",
  "carrierLaunches": {
    "ATT": "NOT_LAUNCHED",
    "TMOBILE": "LAUNCHED",
    "VERIZON": "PENDING",
    "OTHERS": "NOT_LAUNCHED"
  },
  "details": {
    "name": "Acme Support",
    "description": "Get help with your Acme orders and account",
    "iconUrl": "https://example.com/logo.png",
    "heroUrl": "https://example.com/hero.png",
    "color": "#FF6B00",
    "phones": [
      {
        "phone": "+14155550123",
        "label": "Support"
      }
    ],
    "emails": [
      {
        "email": "support@example.com",
        "label": "Support"
      }
    ],
    "websites": [
      {
        "url": "https://example.com",
        "label": "Website"
      }
    ],
    "privacyUrl": "https://example.com/privacy",
    "termsUrl": "https://example.com/terms",
    "isConversational": true,
    "agentUseCase": "MULTI_USE"
  }
}

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.

Authentication

PINNACLE-API-KEYstring

API Key authentication via header

Path parameters

agentIdstringRequiredformat: "^agent_.*"

The RCS agent ID (must be prefixed with agent_).

Response

The agent details.

idstring

The unique agent ID, prefixed with agent_.

typeenum

The agent type.

TEST — A test agent for development and testing with whitelisted numbers only.

The agent type. - `TEST` — A test agent for development and testing with whitelisted numbers only.

Allowed values:

serviceIdstring

The RCS service ID assigned to this agent.

carrierLaunchesobject

Per-carrier launch status.

detailsobject

The configuration details of an RCS agent, as returned by the GET endpoint.

Errors

400

Bad Request Error

401

Unauthorized Error

403

Forbidden Error

404

Not Found Error

500

Internal Server Error