> ## Documentation Index
> Fetch the complete documentation index at: https://docs.stackone.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Vtiger

> How to set up the Vtiger connector, plus the actions and events that are available.

![Vtiger](https://stackone-logos.com/api/vtiger/filled/svg)

v1.3.0[See changelog](https://docs.stackone.com/connectors/vtiger/changelog.md)

[57 actions](#actions) · [1 event](#events) · 1 auth method

CRM
IAM

## Getting Started

**1. Create or Select a Project**

Set up a new project or select an existing one. See [Organizations & Projects](https://docs.stackone.com/gateway/concepts/organizations-and-projects.md).

**2. Configure the Connector**

Enable the connector and create a Connector Profile in your project. See [Setup Connector Profile](https://docs.stackone.com/gateway/quickstart.md#setup-connector-profile).

> [card] [API Key · Connector Profile](https://docs.stackone.com/connectors/vtiger/guides/connector-profile/api-key.md)
>
> Uses email and access key for basic authentication. Access key can be found under My Preferences in the Vtiger CRM UI.

Optionally, configure receiving Events for Vtiger into StackOne.

> [card] [Webhooks setup](https://docs.stackone.com/connectors/vtiger/guides/webhook-setup.md)

**3. Link an Account**

Link an account [from the dashboard](https://docs.stackone.com/connect/managing-connectors/linking-accounts.md#link-from-the-dashboard) (or via [StackOne Hub](https://docs.stackone.com/embed/account-linking/overview)).

See the guide for the authentication type chosen in the Connector Profile:

> [card] [API Key · Link Account](https://docs.stackone.com/connectors/vtiger/guides/link-account/api-key.md)

**4. Use Actions**

Connect an AI platform to the linked account's actions. See [AI Platforms](https://docs.stackone.com/ai-platforms/overview.md).

Other ways to call actions are listed in [Protocols & SDKs](https://docs.stackone.com/connect/protocols-and-sdks.md).

## Actions

57 actions

ActionDescription

Get Current User`vtiger_get_current_user`

Retrieve the authenticated user's profile and session details from Vtiger CRM

List Users`vtiger_list_users`

Query all CRM user records with pagination support using SQL-like syntax

List Contacts`vtiger_list_contacts`

Query contact records from Vtiger CRM with pagination support

Get Contact`vtiger_get_contact`

Retrieve a single contact record by its composite ID from Vtiger CRM

Create Contact`vtiger_create_contact`

Create a new contact record in Vtiger CRM with personal and address details

Update Contact`vtiger_update_contact`

Partially update a contact record using the /revise endpoint, sending only changed fields

Delete Contact`vtiger_delete_contact`

Permanently delete a contact record from Vtiger CRM by its composite ID

Search Contacts`vtiger_search_contacts`

Search for contacts by email address or phone number using the /lookup endpoint

List Accounts`vtiger_list_accounts`

Query account (organization) records from Vtiger CRM with pagination support

Get Account`vtiger_get_account`

Retrieve a single account/organization record by its composite ID from Vtiger CRM

Create Account`vtiger_create_account`

Create a new account/organization record in Vtiger CRM with billing and company details

Update Account`vtiger_update_account`

Partially update an account record using the /revise endpoint, sending only changed fields

Delete Account`vtiger_delete_account`

Permanently delete an account/organization record from Vtiger CRM by its composite ID

Get Account Hierarchy`vtiger_get_account_hierarchy`

Retrieve the parent-child organizational hierarchy for an account in Vtiger CRM

Search Accounts`vtiger_search_accounts`

Search for accounts by email address or phone number using the /lookup endpoint

List Deals`vtiger_list_deals`

Query deal (Potentials) records from Vtiger CRM with pagination support

Get Deal`vtiger_get_deal`

Retrieve a single deal/opportunity record by its composite ID from Vtiger CRM

Create Deal`vtiger_create_deal`

Create a new deal/opportunity record in Vtiger CRM linked to an account

Update Deal`vtiger_update_deal`

Partially update a deal record using the /revise endpoint, sending only changed fields

Delete Deal`vtiger_delete_deal`

Permanently delete a deal/opportunity record from Vtiger CRM by its composite ID

Record Event`vtiger_webhook_record_event`

Fires when a Vtiger Workflow with a "Webhook" action runs against a record (e.g. a Lead, Contact, Organization, or Poten...

List Leads`vtiger_list_leads`

Query lead records from Vtiger CRM with pagination support

Get Lead`vtiger_get_lead`

Retrieve a single lead record by its composite ID from Vtiger CRM

Create Lead`vtiger_create_lead`

Create a new lead record in Vtiger CRM with contact and company details

Update Lead`vtiger_update_lead`

Partially update a lead record using the /revise endpoint, sending only changed fields

Delete Lead`vtiger_delete_lead`

Permanently delete a lead record from Vtiger CRM by its composite ID

Convert Lead`vtiger_convert_lead`

Convert a qualified lead into a contact and account, optionally creating a deal simultaneously

Search Leads`vtiger_search_leads`

Search for leads by email address or phone number using the /lookup endpoint

List Tasks`vtiger_list_tasks`

Query task and activity records from the Vtiger CRM Calendar module with pagination support

Get Task`vtiger_get_task`

Retrieve a single task/activity record by its composite ID from the Vtiger CRM Calendar module

Create Task`vtiger_create_task`

Create a new task, meeting, or call activity in the Vtiger CRM Calendar module

Update Task`vtiger_update_task`

Partially update a task/activity record using the /revise endpoint, sending only changed fields

Delete Task`vtiger_delete_task`

Permanently delete a task/activity record from the Vtiger CRM Calendar module by its composite ID

List Products`vtiger_list_products`

Query product catalog records from Vtiger CRM with pagination support

Get Product`vtiger_get_product`

Retrieve a single product record by its composite ID from Vtiger CRM

Create Product`vtiger_create_product`

Create a new product record in the Vtiger CRM product catalog

Update Product`vtiger_update_product`

Partially update a product record using the /revise endpoint, sending only changed fields

Delete Product`vtiger_delete_product`

Permanently delete a product record from the Vtiger CRM catalog by its composite ID

List Documents`vtiger_list_documents`

Query document and note records from Vtiger CRM with pagination support

Get Document`vtiger_get_document`

Retrieve a single document/note record by its composite ID from Vtiger CRM

Create Document`vtiger_create_document`

Create a new document or note record in Vtiger CRM

Update Document`vtiger_update_document`

Partially update a document/note record using the /revise endpoint, sending only changed fields

Delete Document`vtiger_delete_document`

Permanently delete a document/note record from Vtiger CRM by its composite ID

List Modules`vtiger_list_modules`

List all accessible CRM modules (entity types) available to the authenticated user

Describe Module`vtiger_describe_module`

Retrieve the schema, field definitions, and metadata for a specific Vtiger CRM module

Sync Records`vtiger_sync_records`

Retrieve records modified since a Unix timestamp for incremental data synchronization

Get Related Types`vtiger_get_related_types`

Discover which modules have relationship definitions with a given module in Vtiger CRM

Add Related Record`vtiger_add_related_record`

Create a relationship link between two existing records in Vtiger CRM

Get Related Records`vtiger_get_related_records`

Retrieve all records of a specific module type that are related to a given source record

Query Related Records`vtiger_query_related_records`

Query related records with SQL-like filter criteria, scoped to a source record's relationships

Delete Related Record`vtiger_delete_related_record`

Remove a relationship link between two records without deleting either record

Reopen Record`vtiger_reopen_record`

Reopen a previously closed or completed record in Vtiger CRM

Retrieve File`vtiger_retrieve_file`

Download the binary content of a file attachment from Vtiger CRM by its resource ID

Get Picklist Dependency`vtiger_get_picklist_dependency`

Retrieve the value dependency mapping between two linked picklist fields in a module

Add Tags`vtiger_add_tags`

Add one or more classification tags to a record in Vtiger CRM

Get Tags`vtiger_get_tags`

Retrieve all tags currently assigned to a specific record in Vtiger CRM

Delete Tags`vtiger_delete_tags`

Remove specific tags from a record, optionally removing them from all records in Vtiger CRM

## Events

Tags

Select all
|
Clear

Webhooks

No tags found

1 event

EventDescriptionTags

Record Event`vtiger_webhook_record_event`

Fires when a Vtiger Workflow with a "Webhook" action runs against a record (e.g. a Lead, Contact, Organization, or Poten...

Webhooks


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.