# GramClaw Telegram API API

**Canonical:** https://apis.io/apis/gramclaw-com/gramclaw-telegram-api-api/  
**Provider:** GramClaw — https://apis.io/providers/gramclaw-com/  
**Base URL:** https://gramclaw.com/api/v1  
**Documentation:** https://gramclaw.com/llms.txt

GramClaw Telegram API API is one of 2 APIs that [GramClaw](https://apis.io/providers/gramclaw-com/) publishes on the [APIs.io](https://apis.io/) network, described by a machine-readable OpenAPI specification. This API exposes 5 JSON Schema definitions. The published artifact set on APIs.io includes an OpenAPI specification and 5 JSON Schemas.

Disabled-by-default, workspace-scoped API for eligible internal Telegram accounts. It supports scoped reads, gated CRM/Pipeline operations, username start-chat, idempotent text or one-file message sends (25 MiB maximum), explicit read-state, and campaign reads. Campaign-scoped keys can create, pause

## Operations (20)

| Method | Path | Summary |
|---|---|---|
| GET | `/me` | Verify key and list eligible Telegram accounts |
| GET | `/chats` | List existing scoped Telegram chats |
| GET | `/chats/{chat_id}` | Get an existing chat and supported participant metadata |
| GET | `/chats/{chat_id}/messages` | Read scoped Telegram history without marking it read |
| POST | `/chats/{chat_id}/read-state` | Explicitly set Telegram chat read/unread state |
| POST | `/chats/start` | Open a private chat by Telegram username |
| POST | `/search` | Search persisted scoped Telegram messages |
| GET | `/contacts` | List persisted account-scoped Telegram contacts |
| GET | `/pipeline` | Read workspace pipeline and account-scoped placements |
| POST | `/pipeline/move` | Move one exact account-scoped chat to a visible stage |
| GET | `/columns` | Read custom columns and account-scoped values |
| POST | `/columns/set` | Set or clear a column value on one exact account-scoped chat |
| GET | `/analytics` | Read authoritative internal Telegram analytics |
| GET | `/campaigns` | List internal Telegram campaigns |
| POST | `/campaigns` | Create an internal Telegram campaign for existing private chats |
| POST | `/campaigns/{campaign_id}/pause` | Pause an internal sequence campaign |
| POST | `/campaigns/{campaign_id}/resume` | Resume a paused internal sequence campaign |
| POST | `/campaigns/{campaign_id}/cancel` | Permanently cancel an internal Telegram campaign |
| GET | `/campaigns/{campaign_id}` | Get internal Telegram campaign detail |
| POST | `/messages` | Send text and optionally one attachment to an existing eligible chat |

## Machine-readable artifacts (6)

- **OpenAPI** — https://artifacts.apis.io/gramclaw-com/openapi/_original/gramclaw-com-api-openapi.json
- **JSONSchema** — https://artifacts.apis.io/gramclaw-com/json-schema/gramclaw-com-create-campaign-request-schema.json
- **JSONSchema** — https://artifacts.apis.io/gramclaw-com/json-schema/gramclaw-com-attachment-send-request-schema.json
- **JSONSchema** — https://artifacts.apis.io/gramclaw-com/json-schema/gramclaw-com-read-state-request-schema.json
- **JSONSchema** — https://artifacts.apis.io/gramclaw-com/json-schema/gramclaw-com-start-chat-request-schema.json
- **JSONSchema** — https://artifacts.apis.io/gramclaw-com/json-schema/gramclaw-com-send-request-schema.json

## Other GramClaw APIs (1)

- [GramClaw Telegram API](https://apis.io/apis/gramclaw-com/gramclaw-telegram-api/)

---

Profiled by [API Evangelist](https://apievangelist.com) and published on [APIs.io](https://apis.io/apis/gramclaw-com/gramclaw-telegram-api-api/). The API's provider profile, Kin Score and agent-readiness rating are at https://apis.io/providers/gramclaw-com/.