canonical: https://jentic.com/apis/vtiger.com/vtiger-rest-api

# Vtiger REST API

Vtiger CRM REST API for managing CRM records, modules, relationships, tags, and performing queries and sync operations. The API exposes 25 endpoints secured with basic authentication.

## For AI agents

Programmatically get current user, list accessible modules. Covers 25 operations with basic authentication.

## Scope

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

## Capabilities

- Get current user
- List accessible modules
- Describe module metadata
- Create a record
- Retrieve a record
- Update a record
- Partial update a record

## Use cases

### CRM Operations

Use the Vtiger REST API to perform crm operations programmatically. The API provides 25 endpoints covering core functionality including get current user, list accessible modules, describe module metadata.

Example prompt: Call GET /me to get current user

### Automated Accounts Management

Automate accounts operations by combining multiple Vtiger REST API endpoints. Agents can list accessible modules and then describe module metadata in a single workflow.

Example prompt: Call GET /listtypes to list accessible modules, then verify the result

### AI Agent Integration via Jentic

AI agents discover and call Vtiger REST 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 basic tokens manually.

Example prompt: Search Jentic for 'get current user', load the operation schema, and execute with Jentic-managed credentials

## Key endpoints

| Method | Path | Description |
| --- | --- | --- |
| GET | `/me` | Get current user |
| GET | `/listtypes` | List accessible modules |
| GET | `/describe` | Describe module metadata |
| POST | `/create` | Create a record |
| GET | `/retrieve` | Retrieve a record |
| POST | `/update` | Update a record |
| POST | `/revise` | Partial update a record |
| POST | `/delete` | Delete a record |

## Key resources

- **Accounts** — Operations related to Accounts
- **Authentication** — Operations related to Authentication
- **Files** — Operations related to Files
- **Leads** — Operations related to Leads
- **Metadata** — Operations related to Metadata

## Why Jentic

- **Setup:** Wiring the Vtiger REST API by hand means setting up HTTP basic auth with your CRM email as username and access key as password, resolving your own instance host, and passing those on every call. Through Jentic you install once, import the Vtiger REST API from the API Directory, store the email and access key once, and your agent calls it.
- **Permission scoping:** The Vtiger REST API routes actions through generic operations like /create, /retrieve, /update and /delete rather than per-record URL paths, so limit the agent to the operations it needs, such as retrieve and create, and leave destructive ones like delete or revise out of the allowed set unless you add them.
- **Credential handling:** Your Vtiger email and access key are stored once, encrypted, by your own Jentic One instance and injected at execution time. They never enter the agent's prompt, logs, or context.
- **Discovery method:** Agents search Jentic by intent such as 'get the current user' or 'create a contact record', and Jentic returns the matching Vtiger REST 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 Vtiger REST API use?

The Vtiger REST API uses HTTP Basic authentication with username and password. 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 current user with the Vtiger REST API?

Yes. Use the GET /me endpoint. The API returns structured JSON responses that agents can parse and act on directly.

### What are the rate limits for the Vtiger REST 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 current user through Jentic?

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

### How many endpoints does the Vtiger REST API have?

The Vtiger REST API exposes 25 endpoints covering accounts, authentication, files operations.

### Can I limit what my agent is allowed to do with the Vtiger REST API?

Yes. Because Jentic One is self-hosted, your own rules decide which Vtiger operations and credentials the agent may use. The Vtiger REST API routes everything through generic operations like /create, /retrieve, /update, and /delete rather than per-record paths, so you allow only the ones the agent needs, such as /retrieve and /create. Destructive operations like /delete and /revise stay outside the allowed set unless you deliberately add them.