evolution-foundation Evo CRM
Interact with your Evo AI CRM instance directly via the REST API.
Setup (one-time)
- Get your API access token from your CRM admin panel.
- Set environment variables:
EVO_CRM_URL=https://api.evoai.app EVO_CRM_TOKEN=your_api_access_token
Commands
Contacts
List contacts
python3 /mnt/skills/user/int-evo-crm/scripts/evo_crm_client.py contacts [--sort name] [--page 1]
Get contact details
python3 /mnt/skills/user/int-evo-crm/scripts/evo_crm_client.py contact <id>
Search contacts
python3 /mnt/skills/user/int-evo-crm/scripts/evo_crm_client.py search_contacts --q <term>
Filter contacts (advanced)
python3 /mnt/skills/user/int-evo-crm/scripts/evo_crm_client.py filter_contacts --payload '{"attribute_key":"city","filter_operator":"equal_to","values":["NYC"]}'
Create contact
python3 /mnt/skills/user/int-evo-crm/scripts/evo_crm_client.py create_contact --name "John Doe" [--email john@example.com] [--phone +5511999999999]
Update contact
python3 /mnt/skills/user/int-evo-crm/scripts/evo_crm_client.py update_contact <id> [--name "New Name"] [--email new@example.com] [--phone +5511999999999]
Delete contact
python3 /mnt/skills/user/int-evo-crm/scripts/evo_crm_client.py delete_contact <id>
Contact conversations
python3 /mnt/skills/user/int-evo-crm/scripts/evo_crm_client.py contact_conversations <id>
Contact notes
python3 /mnt/skills/user/int-evo-crm/scripts/evo_crm_client.py contact_notes <id>
Create contact note
python3 /mnt/skills/user/int-evo-crm/scripts/evo_crm_client.py create_contact_note <id> --content "Note text here"
Contact pipelines
python3 /mnt/skills/user/int-evo-crm/scripts/evo_crm_client.py contact_pipelines <id>
Conversations
List conversations
python3 /mnt/skills/user/int-evo-crm/scripts/evo_crm_client.py conversations [--status open] [--assignee_type all] [--inbox_id <id>] [--page 1]
Get conversation details
python3 /mnt/skills/user/int-evo-crm/scripts/evo_crm_client.py conversation <id>
Search conversations
python3 /mnt/skills/user/int-evo-crm/scripts/evo_crm_client.py search_conversations --q <term>
Filter conversations (advanced)
python3 /mnt/skills/user/int-evo-crm/scripts/evo_crm_client.py filter_conversations --payload '{"status":"open"}' [--page 1]
Conversation counts by status
python3 /mnt/skills/user/int-evo-crm/scripts/evo_crm_client.py conversation_meta [--status open] [--assignee_type all]
Create conversation
python3 /mnt/skills/user/int-evo-crm/scripts/evo_crm_client.py create_conversation --contact_id <id> --inbox_id <id>
Assign conversation
python3 /mnt/skills/user/int-evo-crm/scripts/evo_crm_client.py assign_conversation <id> --assignee_id <user_id>
Toggle conversation status
python3 /mnt/skills/user/int-evo-crm/scripts/evo_crm_client.py toggle_status <id> --status resolved
Toggle conversation priority
python3 /mnt/skills/user/int-evo-crm/scripts/evo_crm_client.py toggle_priority <id> --priority urgent
Mute/Unmute conversation
python3 /mnt/skills/user/int-evo-crm/scripts/evo_crm_client.py mute_conversation <id>
python3 /mnt/skills/user/int-evo-crm/scripts/evo_crm_client.py unmute_conversation <id>
Mark conversation as unread
python3 /mnt/skills/user/int-evo-crm/scripts/evo_crm_client.py mark_unread <id>
Send conversation transcript
python3 /mnt/skills/user/int-evo-crm/scripts/evo_crm_client.py send_transcript <id> --email user@example.com
Messages
List messages in conversation
python3 /mnt/skills/user/int-evo-crm/scripts/evo_crm_client.py messages <conversation_id>
Send message (or private note)
python3 /mnt/skills/user/int-evo-crm/scripts/evo_crm_client.py create_message <conversation_id> --content "Hello" [--private]
Update message
python3 /mnt/skills/user/int-evo-crm/scripts/evo_crm_client.py update_message <conversation_id> <message_id> --content "Updated text"
Delete message
python3 /mnt/skills/user/int-evo-crm/scripts/evo_crm_client.py delete_message <conversation_id> <message_id>
Retry failed message
python3 /mnt/skills/user/int-evo-crm/scripts/evo_crm_client.py retry_message <conversation_id> <message_id>
Inboxes
List all inboxes
python3 /mnt/skills/user/int-evo-crm/scripts/evo_crm_client.py inboxes
Get inbox details
python3 /mnt/skills/user/int-evo-crm/scripts/evo_crm_client.py inbox <id>
List inbox agents
python3 /mnt/skills/user/int-evo-crm/scripts/evo_crm_client.py inbox_agents <inbox_id>
Get assignable agents
python3 /mnt/skills/user/int-evo-crm/scripts/evo_crm_client.py assignable_agents <inbox_id>
List inbox message templates
python3 /mnt/skills/user/int-evo-crm/scripts/evo_crm_client.py inbox_templates <inbox_id>
Pipelines
List all pipelines
python3 /mnt/skills/user/int-evo-crm/scripts/evo_crm_client.py pipelines
Get pipeline details
python3 /mnt/skills/user/int-evo-crm/scripts/evo_crm_client.py pipeline <id>
Pipeline stats
python3 /mnt/skills/user/int-evo-crm/scripts/evo_crm_client.py pipeline_stats
python3 /mnt/skills/user/int-evo-crm/scripts/evo_crm_client.py pipeline_stat <id>
List pipeline stages
python3 /mnt/skills/user/int-evo-crm/scripts/evo_crm_client.py pipeline_stages <pipeline_id>
List pipeline items
python3 /mnt/skills/user/int-evo-crm/scripts/evo_crm_client.py pipeline_items <pipeline_id> [--stage_id <id>] [--page 1]
Create pipeline item
python3 /mnt/skills/user/int-evo-crm/scripts/evo_crm_client.py create_pipeline_item <pipeline_id> --contact_id <id> --stage_id <id>
Move item to stage
python3 /mnt/skills/user/int-evo-crm/scripts/evo_crm_client.py move_item <pipeline_id> <item_id> --stage_id <target_stage_id>
Bulk move items
python3 /mnt/skills/user/int-evo-crm/scripts/evo_crm_client.py bulk_move_items <pipeline_id> --item_ids id1,id2,id3 --stage_id <target>
Remove pipeline item
python3 /mnt/skills/user/int-evo-crm/scripts/evo_crm_client.py remove_pipeline_item <pipeline_id> <item_id>
Pipeline items stats
python3 /mnt/skills/user/int-evo-crm/scripts/evo_crm_client.py pipeline_items_stats <pipeline_id>
Labels
Contact labels
python3 /mnt/skills/user/int-evo-crm/scripts/evo_crm_client.py contact_labels <contact_id>
python3 /mnt/skills/user/int-evo-crm/scripts/evo_crm_client.py add_contact_labels <contact_id> --labels label1,label2
Conversation labels
python3 /mnt/skills/user/int-evo-crm/scripts/evo_crm_client.py conversation_labels <conversation_id>
python3 /mnt/skills/user/int-evo-crm/scripts/evo_crm_client.py add_conversation_labels <conversation_id> --labels label1,label2
Output
JSON to stdout. List responses include pagination metadata:
{
"success": true,
"data": [...],
"meta": { "pagination": { "page": 1, "total": 336, "totalPages": 17 } }
}
Resources
- contacts, conversations, messages, inboxes, pipelines, pipeline_stages, pipeline_items, labels