get_client_folder | Get one client folder: name, description, owner, extended_info. id (integer, required, from list_client_folders). |
get_lead | Get one lead: title, description (contact details), status, step, amount, probability, reminder, tags, owner, team, client folder and extended_info. id (integer, required, from list_leads). |
list_activities | List the activity types (Call, E-mail, Meeting…): [{id, name, kind, parent_id, …}]. The id is the activity_id of reminders and comments. No arguments. |
list_client_folders | List the client folders: [{id, name, description, is_active, user_id}]. The id is the client_id of add_lead_to_client_folder. Optional order (“name” default or “id”) and direction (“asc” default or “desc”). |
list_lead_comments | List the comments of a lead: [{id, content, created_at, user, activity_id, is_pinned, …}]. Arguments: lead_id (integer, required, from list_leads); direction (“asc” or “desc”, default desc = newest first). |
list_leads | List leads (the unassigned ones only with include_unassigned). The total count is in the X-TOTAL-COUNT header. All arguments optional: limit (integer, default 100); offset (integer, default 0); order (string: id, creation_date, last_update, next_action, sale_step, amount, probability, probalized_amount or alphabetically; default id); direction (“asc” or “desc”, default desc); status (array of strings among todo, standby, won, lost, cancelled); step (string: step names separated by commas, OR step ids separated by commas, never mixed; names must match exactly, see list_steps); starred (boolean, true = starred leads only); user_id (string or integer: user id or e-mail, from list_users); email (string: leads whose description or comments contain this address); tags (array of strings: leads having all of them); updated_after (string, date or date-time); start_date and end_date (strings, dates) with date_range_type (“creation” default, “update”, “next_action” or “closed”); include_unassigned (boolean, default false). |
list_pipelines | List the pipelines: [{id, name, is_default}] (a single one when multiple pipelines are not enabled). No arguments. |
list_steps | List the steps of all pipelines: [{id, name, position, pipeline_id, pipeline}]. The id or exact name is the step argument of create_lead and update_lead. Optional direction (“asc” or “desc”, default asc, by position). |
list_users | List the users of the account (deleted ones included, is_disabled = true): [{id, firstname, lastname, email, is_admin, …}]. The id or e-mail is the user_id of the lead actions. All arguments optional: email (string); lastname (string); firstname (string); status (“all”, “activated” or “deactivated”, default all); role (“all”, “admin” or “non-admin”, default all); direction (“asc” or “desc”, default asc, by id). |
ping | Check that the API key works: {status: 200, message}. Also used as the credential probe. No arguments. |