canonical: https://jentic.com/apis/telegram-finder.io/telegram-finder

# Telegram Finder API

API documentation for Telegram Finder. Rate limit - maximum 100 Telegram user search per hour. If you need higher quotas we can work to unblock them; contact valentin@telegram-finder.io. The API exposes 11 endpoints.

## For AI agents

Programmatically get rate limit information, get account usage. Covers 11 operations.

## Scope

Does not handle payments, communications, or developer tools - use for crm only.

## Capabilities

- Get rate limit information
- Update contact
- Delete contact
- Create contacts (bulk)
- Monitor Telegram Finder API operational status and events

## Use cases

### CRM Operations

Use the Telegram Finder API to perform crm operations programmatically. The API provides 11 endpoints covering core functionality including get rate limit information, get account usage, get specific contact.

Example prompt: Call GET `/api/account/rate-limit` to get rate limit information

### Automated Account Management

Automate account operations by combining multiple Telegram Finder API endpoints. Agents can get account usage and then get specific contact in a single workflow.

Example prompt: Call GET `/api/account/usage` to get account usage, then verify the result

### AI Agent Integration via Jentic

AI agents discover and call Telegram Finder API endpoints through Jentic without managing credentials directly. An agent searches for the required operation by intent, receives the matching endpoint schema, and executes the call with Jentic-managed authentication. This eliminates the need to read API documentation or handle none tokens manually.

Example prompt: Search Jentic for 'get rate limit information', load the operation schema, and execute with Jentic-managed credentials

## Key endpoints

| Method | Path | Description |
| --- | --- | --- |
| GET | `/api/account/rate-limit` | Get rate limit information |
| GET | `/api/account/usage` | Get account usage |
| GET | `/api/contacts/{id}` | Get specific contact |
| PUT | `/api/contacts/{id}` | Update contact |
| DELETE | `/api/contacts/{id}` | Delete contact |
| POST | `/api/contacts` | Create contacts (bulk) |
| GET | `/api/contacts` | Get user contacts |
| DELETE | `/api/contacts` | Delete contacts (bulk) |

## Key resources

- **Account** — Operations for account
- **Contacts** — Operations for contacts
- **Enrich** — Operations for enrich
- **Telegram** — Operations for telegram

## AI readiness

This API is usable in Jentic One now. Its AI-readiness score against Jentic's framework shows where it stands today and where improvements would make it even easier for agents to use.

- **Score:** 61 / 100
- **Maturity:** AI-Aware
- **Dimensions:**
  - Foundational Compliance: 93 / 100
  - Developer Experience & Jentic Compatibility: 67 / 100
  - AI-Readiness & Agent Experience: 33 / 100
  - Agent Usability: 94 / 100
  - Security: 100 / 100
  - AI Discoverability: 84 / 100
- **View full report:** https://jentic.com/apis/telegram-finder.io/telegram-finder/scorecard
- **How the score is calculated:** https://docs.jentic.com/reference/api-readiness-framework/overview/
- **More about the dimensions:** https://docs.jentic.com/reference/api-readiness-framework/specification/#dimensional-model-overview

### Score it yourself

Every API in the directory is allowlisted, so you can re-score it with no key required.

- **Score your own API:** https://jentic.com/scorecard.md
- **Scoring CLI agent skill:** https://github.com/jentic/jentic-api-scorecard/blob/main/skills/jentic-api-scorecard/SKILL.md

```sh
npx @jentic/api-scorecard-cli score <openapi-url>
```

## Why Jentic

- **Setup:** Wiring the Telegram Finder API by hand still means writing the HTTP client, rate-limit checks, and paging for its contacts endpoints yourself, even where it needs no credential. Through Jentic you install once, import the Telegram Finder API from the API Directory, and your agent calls it.
- **Permission scoping:** The Telegram Finder API puts the contact id in the URL path (`/api/contacts/{id}`), so a rule can pin your agent to one contact: it can read and update that contact and nothing else. You choose the operations it may call, so destructive ones like deleting a contact are not included unless you add them.
- **Credential handling:** The Telegram Finder API needs no stored credential, so there is nothing for your Jentic One instance to hold. No secret ever enters the agent's prompt, logs, or context.
- **Discovery method:** Agents search Jentic by intent such as 'look up a contact' or 'check the rate limit', and Jentic returns the matching Telegram Finder API operation with its input schema so the agent calls the right endpoint without browsing the reference docs.

## Related APIs

- **Hubspot** — Alternative crm API
- **Salesforce** — Alternative crm API
- **Pipedrive** — Complementary crm API
- **Zoho** — Complementary crm API

## FAQ

### What authentication does the Telegram Finder API use?

The Telegram Finder API uses no authentication. Through Jentic, these credentials are stored encrypted in your Jentic One instance and injected at execution time, so raw secrets never enter the agent context.

### Can I get rate limit information with the Telegram Finder API?

Yes. Use the GET `/api/account/rate-limit` endpoint. The API returns structured JSON responses that agents can parse and act on directly.

### What are the rate limits for the Telegram Finder API?

Rate limits are not specified in the OpenAPI spec. Check the vendor documentation for current limits. Through Jentic, rate limiting is handled automatically with retry logic built into the execution layer.

### How do I get rate limit information through Jentic?

Install the Jentic SDK with pip install jentic, authenticate through Jentic One, the self-hosted execution layer, then search for 'get rate limit information'. Jentic returns the matching Telegram Finder API operation with its input schema. Load the schema and execute the call - credentials are injected automatically.

### How many endpoints does the Telegram Finder API have?

The Telegram Finder API exposes 11 endpoints covering account, contacts, enrich operations.

### Can I limit what my agent is allowed to do with the Telegram Finder API?

Yes. Jentic One is self-hosted, so your own rules decide which Telegram Finder API operations the agent may call. Because the contact id sits in the URL path (`/api/contacts/{id}`), you can pin the agent to a single contact so it only reads and updates that one and nothing else. You also choose the exact operations it may use, so destructive calls like deleting a contact are excluded unless you add them.
