← Tools Reference

EspoCRM

EspoCRM integration (Productivity, Marketing). Imported from open-connector.

API key4 tools{base_url}
GET
espocrm_get_app_user
Get the current EspoCRM user data for the configured connection, including ACL and preferences when returned.

/api/v1/App/user

GET
espocrm_get_metadata
Get EspoCRM application metadata, optionally narrowed to one metadata path.

/api/v1/Metadata

1 parameter
ParamTypeRequiredDescription
keystringoptionalOptional metadata path to return, such as entityDefs.Lead.fields.status.options.
GET
espocrm_list_records
List EspoCRM records for an entity type with optional pagination, sorting, and where clauses.

/api/v1/{entityType}

6 parameters
ParamTypeRequiredDescription
entityTypestringrequiredThe EspoCRM entity type, such as Account or Contact.
maxSizeintegeroptionalThe maximum number of records to return.
offsetintegeroptionalThe zero-based list offset.
orderBystringoptionalThe EspoCRM field used for sorting.
orderstringoptionalThe sort direction.
wherearrayoptionalEspoCRM where clauses passed as JSON.
POST
espocrm_create_record
Create one EspoCRM record for the specified entity type.

/api/v1/{entityType}

2 parameters
ParamTypeRequiredDescription
entityTypestringrequiredThe EspoCRM entity type, such as Account or Contact.
dataobjectoptionalThe EspoCRM record fields to create or update.