rcs

Get Agent

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.

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

Path parameters

agentIdstring required

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

Response

The agent details.

idstring 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.
serviceIdstring required

The RCS service ID assigned to this agent.

Changes

No recorded changes to this operation across all 1 revision of this API.