The EspoCRM connector lets your AI agent act in each user's EspoCRM account. Each user connects their own EspoCRM API key once, and Scalekit sends it with every call, so your agent never handles credentials. It comes with 58 tools.
- Tools
- 58
- What they doRead · write · destructive
- 32 · 17 · 932 read17 write9 destructive
- Users sign in with
- API key
Setup
Install the SDK
Terminal window npm install @scalekit-sdk/node dotenvTerminal window pip install scalekit-sdk-python python-dotenvSet your credentials
Add your Scalekit credentials to your
.envfile. Find values in app.scalekit.com > Developers > API Credentials..env SCALEKIT_ENVIRONMENT_URL=<your-environment-url>SCALEKIT_CLIENT_ID=<your-client-id>SCALEKIT_CLIENT_SECRET=<your-client-secret>Create the EspoCRM connection
In AgentKit > Connections, create an EspoCRM connection. The name you give it is the
connection_nameyour code passes. See Configure connections.Authorize a user and make your first call
quickstart.mts import { ScalekitClient } from '@scalekit-sdk/node'import 'dotenv/config'import { createInterface } from 'node:readline/promises'const scalekit = new ScalekitClient(process.env.SCALEKIT_ENVIRONMENT_URL,process.env.SCALEKIT_CLIENT_ID,process.env.SCALEKIT_CLIENT_SECRET,)const actions = scalekit.actionsconst connector = 'espocrm'const identifier = 'user_123'// Generate an authorization link for the userconst { link } = await actions.getAuthorizationLink({ connectionName: connector, identifier })console.log('Authorize EspoCRM:', link)const rl = createInterface({ input: process.stdin, output: process.stdout })await rl.question('Press Enter after authorizing...')rl.close()// Make your first callconst result = await actions.executeTool({connector,identifier,toolName: 'espocrm_accounts_list',toolInput: {},})console.log(result)Terminal window npx tsx quickstart.mtsquickstart.py import osfrom scalekit import ScalekitClientfrom dotenv import load_dotenvload_dotenv()scalekit_client = ScalekitClient(env_url=os.getenv("SCALEKIT_ENVIRONMENT_URL"),client_id=os.getenv("SCALEKIT_CLIENT_ID"),client_secret=os.getenv("SCALEKIT_CLIENT_SECRET"),)actions = scalekit_client.actionsconnection_name = "espocrm"identifier = "user_123"# Generate an authorization link for the userlink_response = actions.get_authorization_link(connection_name=connection_name,identifier=identifier,)print("Authorize EspoCRM:", link_response.link)input("Press Enter after authorizing...")# Make your first callresult = actions.execute_tool(tool_input={},tool_name="espocrm_accounts_list",connection_name=connection_name,identifier=identifier,)print(result)Terminal window python quickstart.pyEach user opens the link once and enters their EspoCRM credentials there. See Authorize a user for the full flow and statuses.
Tools
Pass the exact name toexecute_toolespocrm_account_cases_listList the Case records linked to an account.Read-onlyList Account Cases
List the Case records linked to an account. Returns total and list of records. Use this to see an account's cases. Get the account ID from espocrm_accounts_list.
Inputs
idstringrequired- Account record ID, from espocrm_accounts_list. Example: 6650f1a2b3c4d5e6f.
max_sizeinteger- Maximum records to return, up to 200. Example: 20.
offsetinteger- Number of records to skip, for paging. Example: 0.
orderstring- Sort direction. Example: desc.one of
ascdesc order_bystring- Field to sort by. Example: createdAt.
espocrm_account_contacts_listList the Contact records linked to an account.Read-onlyList Account Contacts
List the Contact records linked to an account. Returns total and list of records. Use this to see an account's contacts. Get the account ID from espocrm_accounts_list.
Inputs
idstringrequired- Account record ID, from espocrm_accounts_list. Example: 6650f1a2b3c4d5e6f.
max_sizeinteger- Maximum records to return, up to 200. Example: 20.
offsetinteger- Number of records to skip, for paging. Example: 0.
orderstring- Sort direction. Example: desc.one of
ascdesc order_bystring- Field to sort by. Example: createdAt.
espocrm_account_getGet one Account record by ID.Read-onlyGet Account
Get one Account record by ID. Returns all of its fields, including related IDs and names. Use espocrm_accounts_list to find the ID.
Inputs
idstringrequired- Account record ID, from espocrm_accounts_list. Example: 6650f1a2b3c4d5e6f.
espocrm_account_opportunities_listList the Opportunity records linked to an account.Read-onlyList Account Opportunities
List the Opportunity records linked to an account. Returns total and list of records. Use this to see an account's opportunities. Get the account ID from espocrm_accounts_list.
Inputs
idstringrequired- Account record ID, from espocrm_accounts_list. Example: 6650f1a2b3c4d5e6f.
max_sizeinteger- Maximum records to return, up to 200. Example: 20.
offsetinteger- Number of records to skip, for paging. Example: 0.
orderstring- Sort direction. Example: desc.one of
ascdesc order_bystring- Field to sort by. Example: createdAt.
espocrm_accounts_listList Account records, with optional text search, built-in filter, sorting and paging.Read-onlyList Accounts
List Account records, with optional text search, built-in filter, sorting and paging. Returns total and list, with each record's id and fields. Use this to find a account ID. Use espocrm_account_get for one record's full details.
Inputs
attribute_selectarray- Fields to return, to make the response smaller. Omit for all fields. Example: ["id", "name"]
max_sizeinteger- Maximum records to return, up to 200. Example: 20.
offsetinteger- Number of records to skip, for paging. Example: 0.
orderstring- Sort direction. Example: desc.one of
ascdesc order_bystring- Field to sort by, for example createdAt, modifiedAt or name. Example: createdAt.
primary_filterstring- Built-in filter: customers, resellers, partners, recentlyCreated. Example: customers.one of
customersresellerspartnersrecentlyCreated text_filterstring- Text search across the main fields. * is a wildcard. Example: acme*.
espocrm_call_getGet one Call record by ID.Read-onlyGet Call
Get one Call record by ID. Returns all of its fields, including related IDs and names. Use espocrm_calls_list to find the ID.
Inputs
idstringrequired- Call record ID, from espocrm_calls_list. Example: 6650f1a2b3c4d5e6f.
espocrm_calls_listList Call records, with optional text search, built-in filter, sorting and paging.Read-onlyList Calls
List Call records, with optional text search, built-in filter, sorting and paging. Returns total and list, with each record's id and fields. Use this to find a call ID. Use espocrm_call_get for one record's full details.
Inputs
attribute_selectarray- Fields to return, to make the response smaller. Omit for all fields. Example: ["id", "name"]
max_sizeinteger- Maximum records to return, up to 200. Example: 20.
offsetinteger- Number of records to skip, for paging. Example: 0.
orderstring- Sort direction. Example: desc.one of
ascdesc order_bystring- Field to sort by, for example createdAt, modifiedAt or name. Example: createdAt.
primary_filterstring- Built-in filter: planned, held, todays. Example: planned.one of
plannedheldtodays text_filterstring- Text search across the main fields. * is a wildcard. Example: acme*.
espocrm_campaign_getGet one Campaign record by ID, with all its fields.Read-onlyGet Campaign
Get one Campaign record by ID, with all its fields. Returns the full record. Get the ID from espocrm_campaigns_list.
Inputs
idstringrequired- Campaign record ID, from espocrm_campaigns_list. Example: 6650f1a2b3c4d5e6f.
espocrm_campaigns_listList marketing campaigns (name, status, type, dates, sent, opened and clicked counts), with optional text search, sorting and paging.Read-onlyList Campaigns
List marketing campaigns (name, status, type, dates, sent, opened and clicked counts), with optional text search, sorting and paging. Returns total and list of records. Use this to find an ID. Use espocrm_campaign_get for one record's full content.
Inputs
attribute_selectarray- Fields to return, to make the response smaller. Omit for all fields. Example: ["id", "name"]
max_sizeinteger- Maximum records to return, up to 200. Example: 20.
offsetinteger- Number of records to skip, for paging. Example: 0.
orderstring- Sort direction. Example: desc.one of
ascdesc order_bystring- Field to sort by, for example createdAt, modifiedAt or name. Example: createdAt.
primary_filterstring- Built-in filter: active. Example: active.one of
active text_filterstring- Text search across the main fields. * is a wildcard. Example: acme*.
espocrm_case_getGet one Case record by ID.Read-onlyGet Case
Get one Case record by ID. Returns all of its fields, including related IDs and names. Use espocrm_cases_list to find the ID.
Inputs
idstringrequired- Case record ID, from espocrm_cases_list. Example: 6650f1a2b3c4d5e6f.
espocrm_cases_listList Case records, with optional text search, built-in filter, sorting and paging.Read-onlyList Cases
List Case records, with optional text search, built-in filter, sorting and paging. Returns total and list, with each record's id and fields. Use this to find a case ID. Use espocrm_case_get for one record's full details.
Inputs
attribute_selectarray- Fields to return, to make the response smaller. Omit for all fields. Example: ["id", "name"]
max_sizeinteger- Maximum records to return, up to 200. Example: 20.
offsetinteger- Number of records to skip, for paging. Example: 0.
orderstring- Sort direction. Example: desc.one of
ascdesc order_bystring- Field to sort by, for example createdAt, modifiedAt or name. Example: createdAt.
primary_filterstring- Built-in filter: open, closed. Example: open.one of
openclosed text_filterstring- Text search across the main fields. * is a wildcard. Example: acme*.
espocrm_contact_getGet one Contact record by ID.Read-onlyGet Contact
Get one Contact record by ID. Returns all of its fields, including related IDs and names. Use espocrm_contacts_list to find the ID.
Inputs
idstringrequired- Contact record ID, from espocrm_contacts_list. Example: 6650f1a2b3c4d5e6f.
espocrm_contacts_listList Contact records, with optional text search, built-in filter, sorting and paging.Read-onlyList Contacts
List Contact records, with optional text search, built-in filter, sorting and paging. Returns total and list, with each record's id and fields. Use this to find a contact ID. Use espocrm_contact_get for one record's full details.
Inputs
attribute_selectarray- Fields to return, to make the response smaller. Omit for all fields. Example: ["id", "name"]
max_sizeinteger- Maximum records to return, up to 200. Example: 20.
offsetinteger- Number of records to skip, for paging. Example: 0.
orderstring- Sort direction. Example: desc.one of
ascdesc order_bystring- Field to sort by, for example createdAt, modifiedAt or name. Example: createdAt.
primary_filterstring- Built-in filter: portalUsers, notPortalUsers, accountActive. Example: portalUsers.one of
portalUsersnotPortalUsersaccountActive text_filterstring- Text search across the main fields. * is a wildcard. Example: acme*.
espocrm_document_getGet one Document record by ID, with all its fields.Read-onlyGet Document
Get one Document record by ID, with all its fields. Returns the full record. Get the ID from espocrm_documents_list.
Inputs
idstringrequired- Document record ID, from espocrm_documents_list. Example: 6650f1a2b3c4d5e6f.
espocrm_documents_listList documents (name, type, status, publish and expiration dates, file), with optional text search, sorting and paging.Read-onlyList Documents
List documents (name, type, status, publish and expiration dates, file), with optional text search, sorting and paging. Returns total and list of records. Use this to find an ID. Use espocrm_document_get for one record's full content.
Inputs
attribute_selectarray- Fields to return, to make the response smaller. Omit for all fields. Example: ["id", "name"]
max_sizeinteger- Maximum records to return, up to 200. Example: 20.
offsetinteger- Number of records to skip, for paging. Example: 0.
orderstring- Sort direction. Example: desc.one of
ascdesc order_bystring- Field to sort by, for example createdAt, modifiedAt or name. Example: createdAt.
primary_filterstring- Built-in filter: active, draft. Example: active.one of
activedraft text_filterstring- Text search across the main fields. * is a wildcard. Example: acme*.
espocrm_email_getGet one Email record by ID, with all its fields.Read-onlyGet Email
Get one Email record by ID, with all its fields. Returns the full record. Get the ID from espocrm_emails_list.
Inputs
idstringrequired- Email record ID, from espocrm_emails_list. Example: 6650f1a2b3c4d5e6f.
espocrm_emails_listList emails archived or sent in EspoCRM (subject, from, to, status, date sent, parent record), with optional text search, sorting and paging.Read-onlyList Emails
List emails archived or sent in EspoCRM (subject, from, to, status, date sent, parent record), with optional text search, sorting and paging. Returns total and list of records. Use this to find an ID. Use espocrm_email_get for one record's full content.
Inputs
attribute_selectarray- Fields to return, to make the response smaller. Omit for all fields. Example: ["id", "name"]
max_sizeinteger- Maximum records to return, up to 200. Example: 20.
offsetinteger- Number of records to skip, for paging. Example: 0.
orderstring- Sort direction. Example: desc.one of
ascdesc order_bystring- Field to sort by, for example createdAt, modifiedAt or name. Example: createdAt.
text_filterstring- Text search across the main fields. * is a wildcard. Example: acme*.
espocrm_knowledge_base_article_getGet one KnowledgeBaseArticle record by ID, with all its fields.Read-onlyGet Knowledge Base Article
Get one KnowledgeBaseArticle record by ID, with all its fields. Returns the full record. Get the ID from espocrm_knowledge_base_articles_list.
Inputs
idstringrequired- KnowledgeBaseArticle record ID, from espocrm_knowledge_base_articles_list. Example: 6650f1a2b3c4d5e6f.
espocrm_knowledge_base_articles_listList knowledge base articles (name, status, language, body), with optional text search, sorting and paging.Read-onlyList Knowledge Base Articles
List knowledge base articles (name, status, language, body), with optional text search, sorting and paging. Returns total and list of records. Use this to find an ID. Use espocrm_knowledge_base_article_get for one record's full content.
Inputs
attribute_selectarray- Fields to return, to make the response smaller. Omit for all fields. Example: ["id", "name"]
max_sizeinteger- Maximum records to return, up to 200. Example: 20.
offsetinteger- Number of records to skip, for paging. Example: 0.
orderstring- Sort direction. Example: desc.one of
ascdesc order_bystring- Field to sort by, for example createdAt, modifiedAt or name. Example: createdAt.
primary_filterstring- Built-in filter: published. Example: published.one of
published text_filterstring- Text search across the main fields. * is a wildcard. Example: acme*.
espocrm_lead_getGet one Lead record by ID.Read-onlyGet Lead
Get one Lead record by ID. Returns all of its fields, including related IDs and names. Use espocrm_leads_list to find the ID.
Inputs
idstringrequired- Lead record ID, from espocrm_leads_list. Example: 6650f1a2b3c4d5e6f.
espocrm_leads_listList Lead records, with optional text search, built-in filter, sorting and paging.Read-onlyList Leads
List Lead records, with optional text search, built-in filter, sorting and paging. Returns total and list, with each record's id and fields. Use this to find a lead ID. Use espocrm_lead_get for one record's full details.
Inputs
attribute_selectarray- Fields to return, to make the response smaller. Omit for all fields. Example: ["id", "name"]
max_sizeinteger- Maximum records to return, up to 200. Example: 20.
offsetinteger- Number of records to skip, for paging. Example: 0.
orderstring- Sort direction. Example: desc.one of
ascdesc order_bystring- Field to sort by, for example createdAt, modifiedAt or name. Example: createdAt.
primary_filterstring- Built-in filter: actual, active, converted. Example: actual.one of
actualactiveconverted text_filterstring- Text search across the main fields. * is a wildcard. Example: acme*.
espocrm_meeting_getGet one Meeting record by ID.Read-onlyGet Meeting
Get one Meeting record by ID. Returns all of its fields, including related IDs and names. Use espocrm_meetings_list to find the ID.
Inputs
idstringrequired- Meeting record ID, from espocrm_meetings_list. Example: 6650f1a2b3c4d5e6f.
espocrm_meetings_listList Meeting records, with optional text search, built-in filter, sorting and paging.Read-onlyList Meetings
List Meeting records, with optional text search, built-in filter, sorting and paging. Returns total and list, with each record's id and fields. Use this to find a meeting ID. Use espocrm_meeting_get for one record's full details.
Inputs
attribute_selectarray- Fields to return, to make the response smaller. Omit for all fields. Example: ["id", "name"]
max_sizeinteger- Maximum records to return, up to 200. Example: 20.
offsetinteger- Number of records to skip, for paging. Example: 0.
orderstring- Sort direction. Example: desc.one of
ascdesc order_bystring- Field to sort by, for example createdAt, modifiedAt or name. Example: createdAt.
primary_filterstring- Built-in filter: planned, held, todays. Example: planned.one of
plannedheldtodays text_filterstring- Text search across the main fields. * is a wildcard. Example: acme*.
espocrm_opportunities_listList Opportunity records, with optional text search, built-in filter, sorting and paging.Read-onlyList Opportunities
List Opportunity records, with optional text search, built-in filter, sorting and paging. Returns total and list, with each record's id and fields. Use this to find a opportunity ID. Use espocrm_opportunity_get for one record's full details.
Inputs
attribute_selectarray- Fields to return, to make the response smaller. Omit for all fields. Example: ["id", "name"]
max_sizeinteger- Maximum records to return, up to 200. Example: 20.
offsetinteger- Number of records to skip, for paging. Example: 0.
orderstring- Sort direction. Example: desc.one of
ascdesc order_bystring- Field to sort by, for example createdAt, modifiedAt or name. Example: createdAt.
primary_filterstring- Built-in filter: open, won, lost. Example: open.one of
openwonlost text_filterstring- Text search across the main fields. * is a wildcard. Example: acme*.
espocrm_opportunity_getGet one Opportunity record by ID.Read-onlyGet Opportunity
Get one Opportunity record by ID. Returns all of its fields, including related IDs and names. Use espocrm_opportunities_list to find the ID.
Inputs
idstringrequired- Opportunity record ID, from espocrm_opportunities_list. Example: 6650f1a2b3c4d5e6f.
espocrm_target_list_getGet one TargetList record by ID, with all its fields.Read-onlyGet Target List
Get one TargetList record by ID, with all its fields. Returns the full record. Get the ID from espocrm_target_lists_list.
Inputs
idstringrequired- TargetList record ID, from espocrm_target_lists_list. Example: 6650f1a2b3c4d5e6f.
espocrm_target_lists_listList target lists used by campaigns (name, entry count, opted-out count), with optional text search, sorting and paging.Read-onlyList Target Lists
List target lists used by campaigns (name, entry count, opted-out count), with optional text search, sorting and paging. Returns total and list of records. Use this to find an ID. Use espocrm_target_list_get for one record's full content.
Inputs
attribute_selectarray- Fields to return, to make the response smaller. Omit for all fields. Example: ["id", "name"]
max_sizeinteger- Maximum records to return, up to 200. Example: 20.
offsetinteger- Number of records to skip, for paging. Example: 0.
orderstring- Sort direction. Example: desc.one of
ascdesc order_bystring- Field to sort by, for example createdAt, modifiedAt or name. Example: createdAt.
text_filterstring- Text search across the main fields. * is a wildcard. Example: acme*.
espocrm_task_getGet one Task record by ID.Read-onlyGet Task
Get one Task record by ID. Returns all of its fields, including related IDs and names. Use espocrm_tasks_list to find the ID.
Inputs
idstringrequired- Task record ID, from espocrm_tasks_list. Example: 6650f1a2b3c4d5e6f.
espocrm_tasks_listList Task records, with optional text search, built-in filter, sorting and paging.Read-onlyList Tasks
List Task records, with optional text search, built-in filter, sorting and paging. Returns total and list, with each record's id and fields. Use this to find a task ID. Use espocrm_task_get for one record's full details.
Inputs
attribute_selectarray- Fields to return, to make the response smaller. Omit for all fields. Example: ["id", "name"]
max_sizeinteger- Maximum records to return, up to 200. Example: 20.
offsetinteger- Number of records to skip, for paging. Example: 0.
orderstring- Sort direction. Example: desc.one of
ascdesc order_bystring- Field to sort by, for example createdAt, modifiedAt or name. Example: createdAt.
primary_filterstring- Built-in filter: actual, completed, deferred, todays, overdue. Example: actual.one of
actualcompleteddeferredtodaysoverdue text_filterstring- Text search across the main fields. * is a wildcard. Example: acme*.
espocrm_teams_listList teams.Read-onlyList Teams
List teams. Returns each team's id and name. Use this to find IDs for teams_ids.
Inputs
max_sizeinteger- Maximum records to return, up to 200. Example: 50.
offsetinteger- Number of records to skip. Example: 0.
espocrm_user_getGet one user by ID.Read-onlyGet User
Get one user by ID. Returns the user's name, user name, email, teams and roles. Get IDs from espocrm_users_list.
Inputs
idstringrequired- User ID, from espocrm_users_list. Example: 6650f1a2b3c4d5e6f.
espocrm_users_listList users of the EspoCRM instance.Read-onlyList Users
List users of the EspoCRM instance. Returns each user's id, name, user name, email and type. Use this to find IDs for assigned_user_id.
Inputs
max_sizeinteger- Maximum records to return, up to 200. Example: 50.
offsetinteger- Number of records to skip. Example: 0.
text_filterstring- Text search on name, user name or email. * is a wildcard. Example: jane*.
espocrm_account_contact_linkLink an existing contact to an account.WriteLink Contact to Account
Link an existing contact to an account. Returns true on success. Use espocrm_account_contact_unlink to remove the link.
- Idempotent
Inputs
contact_idstringrequired- ID of the contact to link, from espocrm_contacts_list. Example: 6650f1a2b3c4d5e6f.
idstringrequired- Account record ID, from espocrm_accounts_list. Example: 6650f1a2b3c4d5e6f.
espocrm_account_createCreate a Account record.WriteCreate Account
Create a Account record. Returns the created record with its id. Use espocrm_account_update to change an existing record.
Inputs
namestringrequired- Company name. Example: Acme Corporation.
assigned_user_idstring- ID of the user the record is assigned to, from espocrm_users_list. Example: 6650f1a2b3c4d5e6f.
billing_address_citystring- City. Example: Springfield.
billing_address_countrystring- Country. Example: USA.
billing_address_postal_codestring- Postal code. Example: 62701.
billing_address_statestring- State or region. Example: IL.
billing_address_streetstring- Street address. Example: 21 Main Street.
descriptionstring- Free-text description. Example: Key account in the Midwest.
email_addressstring- Primary email address. Example: info@acme.example.
industrystring- Industry, for example Computer, Finance, Healthcare or Retail (default values; your admin may have customised the list). Example: Computer.
phone_numberstring- Primary phone number. Example: +1 555 0100.
teams_idsarray- IDs of the teams the record belongs to, from espocrm_teams_list. Example: ["6650f1a2b3c4d5e6f"]
typestring- Account type: Customer, Investor, Partner or Reseller (default values; your admin may have customised the list). Example: Customer.
websitestring- Website URL. Example: https://acme.example.
espocrm_account_updateUpdate fields of a Account record.WriteUpdate Account
Update fields of a Account record. Only the fields sent change. Returns the updated record. Get the ID from espocrm_accounts_list.
- Idempotent
Inputs
idstringrequired- Account record ID, from espocrm_accounts_list. Example: 6650f1a2b3c4d5e6f.
assigned_user_idstring- ID of the user the record is assigned to, from espocrm_users_list. Example: 6650f1a2b3c4d5e6f.
billing_address_citystring- City. Example: Springfield.
billing_address_countrystring- Country. Example: USA.
billing_address_postal_codestring- Postal code. Example: 62701.
billing_address_statestring- State or region. Example: IL.
billing_address_streetstring- Street address. Example: 21 Main Street.
descriptionstring- Free-text description. Example: Key account in the Midwest.
email_addressstring- Primary email address. Example: info@acme.example.
industrystring- Industry, for example Computer, Finance, Healthcare or Retail (default values; your admin may have customised the list). Example: Computer.
namestring- Company name. Example: Acme Corporation.
phone_numberstring- Primary phone number. Example: +1 555 0100.
teams_idsarray- IDs of the teams the record belongs to, from espocrm_teams_list. Example: ["6650f1a2b3c4d5e6f"]
typestring- Account type: Customer, Investor, Partner or Reseller (default values; your admin may have customised the list). Example: Customer.
websitestring- Website URL. Example: https://acme.example.
espocrm_call_createCreate a Call record.WriteCreate Call
Create a Call record. Returns the created record with its id. Use espocrm_call_update to change an existing record.
Inputs
assigned_user_idstringrequired- ID of the user the record is assigned to, from espocrm_users_list. Example: 6650f1a2b3c4d5e6f.
date_endstringrequired- End date-time in UTC, YYYY-MM-DD HH:mm:ss. Example: 2026-02-03 15:30:00.
date_startstringrequired- Start date-time in UTC, YYYY-MM-DD HH:mm:ss. Example: 2026-02-03 15:00:00.
namestringrequired- Call subject. Example: Discovery call.
contacts_idsarray- IDs of contacts on the call. Example: ["6650f1a2b3c4d5e6f"]
descriptionstring- Call notes. Example: Discuss requirements.
directionstring- Direction: Outbound or Inbound. Example: Outbound.
leads_idsarray- IDs of leads on the call. Example: ["6650f1a2b3c4d5e6f"]
parent_idstring- ID of the related parent record (set with parentType). Example: 6650f1a2b3c4d5e6f.
parent_typestring- Type of the related parent record: Account, Contact, Lead, Opportunity or Case. Example: Account.
statusstring- Status: Planned, Held or Not Held. Example: Planned.
teams_idsarray- IDs of the teams the record belongs to, from espocrm_teams_list. Example: ["6650f1a2b3c4d5e6f"]
users_idsarray- IDs of users on the call. Example: ["6650f1a2b3c4d5e6f"]
espocrm_call_updateUpdate fields of a Call record.WriteUpdate Call
Update fields of a Call record. Only the fields sent change. Returns the updated record. Get the ID from espocrm_calls_list.
- Idempotent
Inputs
idstringrequired- Call record ID, from espocrm_calls_list. Example: 6650f1a2b3c4d5e6f.
assigned_user_idstring- ID of the user the record is assigned to, from espocrm_users_list. Example: 6650f1a2b3c4d5e6f.
contacts_idsarray- IDs of contacts on the call. Example: ["6650f1a2b3c4d5e6f"]
date_endstring- End date-time in UTC, YYYY-MM-DD HH:mm:ss. Example: 2026-02-03 15:30:00.
date_startstring- Start date-time in UTC, YYYY-MM-DD HH:mm:ss. Example: 2026-02-03 15:00:00.
descriptionstring- Call notes. Example: Discuss requirements.
directionstring- Direction: Outbound or Inbound. Example: Outbound.
leads_idsarray- IDs of leads on the call. Example: ["6650f1a2b3c4d5e6f"]
namestring- Call subject. Example: Discovery call.
parent_idstring- ID of the related parent record (set with parentType). Example: 6650f1a2b3c4d5e6f.
parent_typestring- Type of the related parent record: Account, Contact, Lead, Opportunity or Case. Example: Account.
statusstring- Status: Planned, Held or Not Held. Example: Planned.
teams_idsarray- IDs of the teams the record belongs to, from espocrm_teams_list. Example: ["6650f1a2b3c4d5e6f"]
users_idsarray- IDs of users on the call. Example: ["6650f1a2b3c4d5e6f"]
espocrm_case_createCreate a Case record.WriteCreate Case
Create a Case record. Returns the created record with its id. Use espocrm_case_update to change an existing record.
Inputs
namestringrequired- Case subject. Example: Cannot log in.
account_idstring- ID of the related account. Example: 6650f1a2b3c4d5e6f.
assigned_user_idstring- ID of the user the record is assigned to, from espocrm_users_list. Example: 6650f1a2b3c4d5e6f.
contact_idstring- ID of the primary contact. Example: 6650f1a2b3c4d5e6f.
descriptionstring- Case details. Example: User gets an error after resetting their password.
lead_idstring- ID of the related lead. Example: 6650f1a2b3c4d5e6f.
prioritystring- Priority: Low, Normal, High or Urgent. Example: High.
statusstring- Status: New, Assigned, Pending, Closed, Rejected or Duplicate (default values; your admin may have customised the list). Example: New.
teams_idsarray- IDs of the teams the record belongs to, from espocrm_teams_list. Example: ["6650f1a2b3c4d5e6f"]
typestring- Type: Question, Incident or Problem (default values; your admin may have customised the list). Example: Incident.
espocrm_case_updateUpdate fields of a Case record.WriteUpdate Case
Update fields of a Case record. Only the fields sent change. Returns the updated record. Get the ID from espocrm_cases_list.
- Idempotent
Inputs
idstringrequired- Case record ID, from espocrm_cases_list. Example: 6650f1a2b3c4d5e6f.
account_idstring- ID of the related account. Example: 6650f1a2b3c4d5e6f.
assigned_user_idstring- ID of the user the record is assigned to, from espocrm_users_list. Example: 6650f1a2b3c4d5e6f.
contact_idstring- ID of the primary contact. Example: 6650f1a2b3c4d5e6f.
descriptionstring- Case details. Example: User gets an error after resetting their password.
lead_idstring- ID of the related lead. Example: 6650f1a2b3c4d5e6f.
namestring- Case subject. Example: Cannot log in.
prioritystring- Priority: Low, Normal, High or Urgent. Example: High.
statusstring- Status: New, Assigned, Pending, Closed, Rejected or Duplicate (default values; your admin may have customised the list). Example: New.
teams_idsarray- IDs of the teams the record belongs to, from espocrm_teams_list. Example: ["6650f1a2b3c4d5e6f"]
typestring- Type: Question, Incident or Problem (default values; your admin may have customised the list). Example: Incident.
espocrm_contact_createCreate a Contact record.WriteCreate Contact
Create a Contact record. Returns the created record with its id. Use espocrm_contact_update to change an existing record.
Inputs
last_namestringrequired- Last name. Example: Doe.
account_idstring- ID of the contact's account, from espocrm_accounts_list. Example: 6650f1a2b3c4d5e6f.
address_citystring- City. Example: Springfield.
address_countrystring- Country. Example: USA.
address_postal_codestring- Postal code. Example: 62701.
address_statestring- State or region. Example: IL.
address_streetstring- Street address. Example: 21 Main Street.
assigned_user_idstring- ID of the user the record is assigned to, from espocrm_users_list. Example: 6650f1a2b3c4d5e6f.
descriptionstring- Free-text description. Example: Met at the 2026 trade show.
do_not_callboolean- Do not call this contact. Example: false.
email_addressstring- Primary email address. Example: jane.doe@acme.example.
first_namestring- First name. Example: Jane.
phone_numberstring- Primary phone number. Example: +1 555 0101.
salutation_namestring- Salutation: Mr., Ms., Mrs. or Dr. Example: Ms.
teams_idsarray- IDs of the teams the record belongs to, from espocrm_teams_list. Example: ["6650f1a2b3c4d5e6f"]
titlestring- Job title. Example: VP Sales.
espocrm_contact_updateUpdate fields of a Contact record.WriteUpdate Contact
Update fields of a Contact record. Only the fields sent change. Returns the updated record. Get the ID from espocrm_contacts_list.
- Idempotent
Inputs
idstringrequired- Contact record ID, from espocrm_contacts_list. Example: 6650f1a2b3c4d5e6f.
account_idstring- ID of the contact's account, from espocrm_accounts_list. Example: 6650f1a2b3c4d5e6f.
address_citystring- City. Example: Springfield.
address_countrystring- Country. Example: USA.
address_postal_codestring- Postal code. Example: 62701.
address_statestring- State or region. Example: IL.
address_streetstring- Street address. Example: 21 Main Street.
assigned_user_idstring- ID of the user the record is assigned to, from espocrm_users_list. Example: 6650f1a2b3c4d5e6f.
descriptionstring- Free-text description. Example: Met at the 2026 trade show.
do_not_callboolean- Do not call this contact. Example: false.
email_addressstring- Primary email address. Example: jane.doe@acme.example.
first_namestring- First name. Example: Jane.
last_namestring- Last name. Example: Doe.
phone_numberstring- Primary phone number. Example: +1 555 0101.
salutation_namestring- Salutation: Mr., Ms., Mrs. or Dr. Example: Ms.
teams_idsarray- IDs of the teams the record belongs to, from espocrm_teams_list. Example: ["6650f1a2b3c4d5e6f"]
titlestring- Job title. Example: VP Sales.
espocrm_lead_createCreate a Lead record.WriteCreate Lead
Create a Lead record. Returns the created record with its id. Use espocrm_lead_update to change an existing record.
Inputs
account_namestring- Company name of the lead. Example: Globex.
address_citystring- City. Example: Springfield.
address_countrystring- Country. Example: USA.
address_postal_codestring- Postal code. Example: 62701.
address_statestring- State or region. Example: IL.
address_streetstring- Street address. Example: 21 Main Street.
assigned_user_idstring- ID of the user the record is assigned to, from espocrm_users_list. Example: 6650f1a2b3c4d5e6f.
descriptionstring- Free-text description. Example: Asked for a demo.
email_addressstring- Primary email address. Example: john@globex.example.
first_namestring- First name. Example: John.
industrystring- Industry (default values; your admin may have customised the list). Example: Computer.
last_namestring- Last name. Example: Smith.
opportunity_amountnumber- Expected deal amount. Example: 25000.
opportunity_amount_currencystring- Currency code of opportunity_amount, as enabled in your instance. Example: USD.
phone_numberstring- Primary phone number. Example: +1 555 0102.
sourcestring- Lead source: Call, Email, Existing Customer, Partner, Public Relations, Web Site, Campaign or Other (default values; your admin may have customised the list). Example: Web Site.
statusstring- Lead status: New, Assigned, In Process, Converted, Recycled or Dead (default values; your admin may have customised the list). Example: New.
teams_idsarray- IDs of the teams the record belongs to, from espocrm_teams_list. Example: ["6650f1a2b3c4d5e6f"]
titlestring- Job title. Example: CTO.
websitestring- Website URL. Example: https://globex.example.
espocrm_lead_updateUpdate fields of a Lead record.WriteUpdate Lead
Update fields of a Lead record. Only the fields sent change. Returns the updated record. Get the ID from espocrm_leads_list.
- Idempotent
Inputs
idstringrequired- Lead record ID, from espocrm_leads_list. Example: 6650f1a2b3c4d5e6f.
account_namestring- Company name of the lead. Example: Globex.
address_citystring- City. Example: Springfield.
address_countrystring- Country. Example: USA.
address_postal_codestring- Postal code. Example: 62701.
address_statestring- State or region. Example: IL.
address_streetstring- Street address. Example: 21 Main Street.
assigned_user_idstring- ID of the user the record is assigned to, from espocrm_users_list. Example: 6650f1a2b3c4d5e6f.
descriptionstring- Free-text description. Example: Asked for a demo.
email_addressstring- Primary email address. Example: john@globex.example.
first_namestring- First name. Example: John.
industrystring- Industry (default values; your admin may have customised the list). Example: Computer.
last_namestring- Last name. Example: Smith.
opportunity_amountnumber- Expected deal amount. Example: 25000.
opportunity_amount_currencystring- Currency code of opportunity_amount, as enabled in your instance. Example: USD.
phone_numberstring- Primary phone number. Example: +1 555 0102.
sourcestring- Lead source: Call, Email, Existing Customer, Partner, Public Relations, Web Site, Campaign or Other (default values; your admin may have customised the list). Example: Web Site.
statusstring- Lead status: New, Assigned, In Process, Converted, Recycled or Dead (default values; your admin may have customised the list). Example: New.
teams_idsarray- IDs of the teams the record belongs to, from espocrm_teams_list. Example: ["6650f1a2b3c4d5e6f"]
titlestring- Job title. Example: CTO.
websitestring- Website URL. Example: https://globex.example.
espocrm_meeting_createCreate a Meeting record.WriteCreate Meeting
Create a Meeting record. Returns the created record with its id. Use espocrm_meeting_update to change an existing record.
Inputs
assigned_user_idstringrequired- ID of the user the record is assigned to, from espocrm_users_list. Example: 6650f1a2b3c4d5e6f.
date_endstringrequired- End date-time in UTC, YYYY-MM-DD HH:mm:ss. Example: 2026-02-10 15:00:00.
date_startstringrequired- Start date-time in UTC, YYYY-MM-DD HH:mm:ss. Example: 2026-02-10 14:00:00.
namestringrequired- Meeting subject. Example: Quarterly review.
contacts_idsarray- IDs of contacts invited. Example: ["6650f1a2b3c4d5e6f"]
descriptionstring- Agenda or notes. Example: Review Q1 usage.
is_all_dayboolean- All-day meeting (then use dateStartDate and dateEndDate in the UI). Example: false.
join_urlstring- Online meeting link. Example: https://meet.example.com/abc.
leads_idsarray- IDs of leads invited. Example: ["6650f1a2b3c4d5e6f"]
parent_idstring- ID of the related parent record (set with parentType). Example: 6650f1a2b3c4d5e6f.
parent_typestring- Type of the related parent record: Account, Contact, Lead, Opportunity or Case. Example: Account.
statusstring- Status: Planned, Held or Not Held. Example: Planned.
teams_idsarray- IDs of the teams the record belongs to, from espocrm_teams_list. Example: ["6650f1a2b3c4d5e6f"]
users_idsarray- IDs of users invited. Example: ["6650f1a2b3c4d5e6f"]
espocrm_meeting_updateUpdate fields of a Meeting record.WriteUpdate Meeting
Update fields of a Meeting record. Only the fields sent change. Returns the updated record. Get the ID from espocrm_meetings_list.
- Idempotent
Inputs
idstringrequired- Meeting record ID, from espocrm_meetings_list. Example: 6650f1a2b3c4d5e6f.
assigned_user_idstring- ID of the user the record is assigned to, from espocrm_users_list. Example: 6650f1a2b3c4d5e6f.
contacts_idsarray- IDs of contacts invited. Example: ["6650f1a2b3c4d5e6f"]
date_endstring- End date-time in UTC, YYYY-MM-DD HH:mm:ss. Example: 2026-02-10 15:00:00.
date_startstring- Start date-time in UTC, YYYY-MM-DD HH:mm:ss. Example: 2026-02-10 14:00:00.
descriptionstring- Agenda or notes. Example: Review Q1 usage.
is_all_dayboolean- All-day meeting (then use dateStartDate and dateEndDate in the UI). Example: false.
join_urlstring- Online meeting link. Example: https://meet.example.com/abc.
leads_idsarray- IDs of leads invited. Example: ["6650f1a2b3c4d5e6f"]
namestring- Meeting subject. Example: Quarterly review.
parent_idstring- ID of the related parent record (set with parentType). Example: 6650f1a2b3c4d5e6f.
parent_typestring- Type of the related parent record: Account, Contact, Lead, Opportunity or Case. Example: Account.
statusstring- Status: Planned, Held or Not Held. Example: Planned.
teams_idsarray- IDs of the teams the record belongs to, from espocrm_teams_list. Example: ["6650f1a2b3c4d5e6f"]
users_idsarray- IDs of users invited. Example: ["6650f1a2b3c4d5e6f"]
espocrm_opportunity_createCreate a Opportunity record.WriteCreate Opportunity
Create a Opportunity record. Returns the created record with its id. Use espocrm_opportunity_update to change an existing record.
Inputs
amountnumberrequired- Deal amount. Example: 50000.
amount_currencystringrequired- Currency code of amount, as enabled in your instance. Example: USD.
close_datestringrequired- Expected close date, YYYY-MM-DD. Example: 2026-03-31.
namestringrequired- Opportunity name. Example: Acme - 50 seats.
account_idstring- ID of the account, from espocrm_accounts_list. Example: 6650f1a2b3c4d5e6f.
assigned_user_idstring- ID of the user the record is assigned to, from espocrm_users_list. Example: 6650f1a2b3c4d5e6f.
contacts_idsarray- IDs of related contacts. Example: ["6650f1a2b3c4d5e6f"]
descriptionstring- Free-text description. Example: Renewal plus upsell.
lead_sourcestring- Lead source (default values; your admin may have customised the list). Example: Partner.
probabilityinteger- Win probability in percent (0 to 100). Example: 60.
stagestring- Sales stage: Prospecting, Qualification, Proposal, Negotiation, Closed Won or Closed Lost (default values; your admin may have customised the list). Example: Proposal.
teams_idsarray- IDs of the teams the record belongs to, from espocrm_teams_list. Example: ["6650f1a2b3c4d5e6f"]
espocrm_opportunity_updateUpdate fields of a Opportunity record.WriteUpdate Opportunity
Update fields of a Opportunity record. Only the fields sent change. Returns the updated record. Get the ID from espocrm_opportunities_list.
- Idempotent
Inputs
idstringrequired- Opportunity record ID, from espocrm_opportunities_list. Example: 6650f1a2b3c4d5e6f.
account_idstring- ID of the account, from espocrm_accounts_list. Example: 6650f1a2b3c4d5e6f.
amountnumber- Deal amount. Example: 50000.
amount_currencystring- Currency code of amount, as enabled in your instance. Example: USD.
assigned_user_idstring- ID of the user the record is assigned to, from espocrm_users_list. Example: 6650f1a2b3c4d5e6f.
close_datestring- Expected close date, YYYY-MM-DD. Example: 2026-03-31.
contacts_idsarray- IDs of related contacts. Example: ["6650f1a2b3c4d5e6f"]
descriptionstring- Free-text description. Example: Renewal plus upsell.
lead_sourcestring- Lead source (default values; your admin may have customised the list). Example: Partner.
namestring- Opportunity name. Example: Acme - 50 seats.
probabilityinteger- Win probability in percent (0 to 100). Example: 60.
stagestring- Sales stage: Prospecting, Qualification, Proposal, Negotiation, Closed Won or Closed Lost (default values; your admin may have customised the list). Example: Proposal.
teams_idsarray- IDs of the teams the record belongs to, from espocrm_teams_list. Example: ["6650f1a2b3c4d5e6f"]
espocrm_task_createCreate a Task record.WriteCreate Task
Create a Task record. Returns the created record with its id. Use espocrm_task_update to change an existing record.
Inputs
assigned_user_idstringrequired- ID of the user the record is assigned to, from espocrm_users_list. Example: 6650f1a2b3c4d5e6f.
namestringrequired- Task name. Example: Send proposal.
date_endstring- Due date-time in UTC, YYYY-MM-DD HH:mm:ss. Example: 2026-02-05 17:00:00.
date_startstring- Start date-time in UTC, YYYY-MM-DD HH:mm:ss. Example: 2026-02-02 09:00:00.
descriptionstring- Task details. Example: Include the volume discount.
parent_idstring- ID of the related parent record (set with parentType). Example: 6650f1a2b3c4d5e6f.
parent_typestring- Type of the related parent record: Account, Contact, Lead, Opportunity or Case. Example: Account.
prioritystring- Priority: Low, Normal, High or Urgent. Example: Normal.
statusstring- Status: Not Started, Started, Completed, Canceled or Deferred (default values; your admin may have customised the list). Example: Not Started.
teams_idsarray- IDs of the teams the record belongs to, from espocrm_teams_list. Example: ["6650f1a2b3c4d5e6f"]
espocrm_task_updateUpdate fields of a Task record.WriteUpdate Task
Update fields of a Task record. Only the fields sent change. Returns the updated record. Get the ID from espocrm_tasks_list.
- Idempotent
Inputs
idstringrequired- Task record ID, from espocrm_tasks_list. Example: 6650f1a2b3c4d5e6f.
assigned_user_idstring- ID of the user the record is assigned to, from espocrm_users_list. Example: 6650f1a2b3c4d5e6f.
date_endstring- Due date-time in UTC, YYYY-MM-DD HH:mm:ss. Example: 2026-02-05 17:00:00.
date_startstring- Start date-time in UTC, YYYY-MM-DD HH:mm:ss. Example: 2026-02-02 09:00:00.
descriptionstring- Task details. Example: Include the volume discount.
namestring- Task name. Example: Send proposal.
parent_idstring- ID of the related parent record (set with parentType). Example: 6650f1a2b3c4d5e6f.
parent_typestring- Type of the related parent record: Account, Contact, Lead, Opportunity or Case. Example: Account.
prioritystring- Priority: Low, Normal, High or Urgent. Example: Normal.
statusstring- Status: Not Started, Started, Completed, Canceled or Deferred (default values; your admin may have customised the list). Example: Not Started.
teams_idsarray- IDs of the teams the record belongs to, from espocrm_teams_list. Example: ["6650f1a2b3c4d5e6f"]
espocrm_account_contact_unlinkRemove the link between a contact and an account.DestructiveUnlink Contact from Account
Remove the link between a contact and an account. Neither record is deleted. Returns true on success. Use espocrm_account_contacts_list to find linked contacts.
- Idempotent
Inputs
contact_idstringrequired- ID of the contact to unlink, from espocrm_account_contacts_list. Example: 6650f1a2b3c4d5e6f.
idstringrequired- Account record ID, from espocrm_accounts_list. Example: 6650f1a2b3c4d5e6f.
espocrm_account_deleteDelete a Account record (it can be restored from the admin's Deleted records only if your instance keeps them).DestructiveDelete Account
Delete a Account record (it can be restored from the admin's Deleted records only if your instance keeps them). Returns true on success. Get the ID from espocrm_accounts_list.
- Idempotent
Inputs
idstringrequired- Account record ID, from espocrm_accounts_list. Example: 6650f1a2b3c4d5e6f.
espocrm_call_deleteDelete a Call record (it can be restored from the admin's Deleted records only if your instance keeps them).DestructiveDelete Call
Delete a Call record (it can be restored from the admin's Deleted records only if your instance keeps them). Returns true on success. Get the ID from espocrm_calls_list.
- Idempotent
Inputs
idstringrequired- Call record ID, from espocrm_calls_list. Example: 6650f1a2b3c4d5e6f.
espocrm_case_deleteDelete a Case record (it can be restored from the admin's Deleted records only if your instance keeps them).DestructiveDelete Case
Delete a Case record (it can be restored from the admin's Deleted records only if your instance keeps them). Returns true on success. Get the ID from espocrm_cases_list.
- Idempotent
Inputs
idstringrequired- Case record ID, from espocrm_cases_list. Example: 6650f1a2b3c4d5e6f.
espocrm_contact_deleteDelete a Contact record (it can be restored from the admin's Deleted records only if your instance keeps them).DestructiveDelete Contact
Delete a Contact record (it can be restored from the admin's Deleted records only if your instance keeps them). Returns true on success. Get the ID from espocrm_contacts_list.
- Idempotent
Inputs
idstringrequired- Contact record ID, from espocrm_contacts_list. Example: 6650f1a2b3c4d5e6f.
espocrm_lead_deleteDelete a Lead record (it can be restored from the admin's Deleted records only if your instance keeps them).DestructiveDelete Lead
Delete a Lead record (it can be restored from the admin's Deleted records only if your instance keeps them). Returns true on success. Get the ID from espocrm_leads_list.
- Idempotent
Inputs
idstringrequired- Lead record ID, from espocrm_leads_list. Example: 6650f1a2b3c4d5e6f.
espocrm_meeting_deleteDelete a Meeting record (it can be restored from the admin's Deleted records only if your instance keeps them).DestructiveDelete Meeting
Delete a Meeting record (it can be restored from the admin's Deleted records only if your instance keeps them). Returns true on success. Get the ID from espocrm_meetings_list.
- Idempotent
Inputs
idstringrequired- Meeting record ID, from espocrm_meetings_list. Example: 6650f1a2b3c4d5e6f.
espocrm_opportunity_deleteDelete a Opportunity record (it can be restored from the admin's Deleted records only if your instance keeps them).DestructiveDelete Opportunity
Delete a Opportunity record (it can be restored from the admin's Deleted records only if your instance keeps them). Returns true on success. Get the ID from espocrm_opportunities_list.
- Idempotent
Inputs
idstringrequired- Opportunity record ID, from espocrm_opportunities_list. Example: 6650f1a2b3c4d5e6f.
espocrm_task_deleteDelete a Task record (it can be restored from the admin's Deleted records only if your instance keeps them).DestructiveDelete Task
Delete a Task record (it can be restored from the admin's Deleted records only if your instance keeps them). Returns true on success. Get the ID from espocrm_tasks_list.
- Idempotent
Inputs
idstringrequired- Task record ID, from espocrm_tasks_list. Example: 6650f1a2b3c4d5e6f.
No tools match.