Mail recipients: method overview
If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the MCP server so that the assistant can utilize the official REST documentation.
Mail recipients in Bitrix24 are contacts and employees that can be selected when addressing an e-mail.
The methods in this section allow you to:
- search for contacts from the address book using a search string
- search for employees by name and e-mail
- retrieve a list of recipient fields and the description of a specific field
Quick links: all methods
User documentation: Manage emails in Bitrix24
When to use each method
Use mail.recipient.listcontacts when you need to select external recipients from the address book for an e-mail.
Use mail.recipient.listemployees when you need to find a Bitrix24 employee by name or e-mail.
Use mail.recipient.field.list and mail.recipient.field.get when you need to:
- find available recipient fields
- retrieve the types and metadata of a specific field
Workflow for working with recipients
- Select the e-mail recipients: external recipients via mail.recipient.listcontacts, employees via mail.recipient.listemployees
- Verify the recipient data structure: the list of fields via mail.recipient.field.list and the field description via mail.recipient.field.get
Section limitations
- Search results depend on the search string and data accessibility for the current user
- The methods in this section select recipients and do not perform e-mail sending
Connection with Other Objects
E-mail. The methods in this section help select recipients for sending and replying to e-mails in the mail.message.* methods.
Overview of Methods
Scope:
Who can execute the methods: any user
|
Method |
Description |
|
Searches for contacts from the address book |
|
|
Searches for employees by name or e-mail |
|
|
Returns a list of recipient fields |
|
|
Returns the description of a recipient field |