getfly_list_users
List users
List the Getfly CRM users (employees): user id, name, department, email, phone. Use the user_name (login name) for the recipient/manager arguments of the create tools. Filters: user_id, contact_name, email, contact_mobile, valid (1 = active users). GET /api/v6.1/users.
輸入參數sortlimitfieldsoffsetfiltersdirection
One user by id or by login name (exactly one of user_id and user_username). GET /api/v6.1/user.
輸入參數fieldsuser_iduser_username
getfly_list_accounts
List customers
List customers (accounts, i.e. companies or individuals) with code, name, phone, email, address, type, source, relationship, manager, total revenue and contacts. Filters: id, account_code, account_name, phone_office, email, account_type, account_source, relation_id, industry, billing_address_street, created_at, updated_at (gte/lte/between), account_manager (user id), sale_order_status. Newest first. GET /api/v6/accounts.
輸入參數sortlimitfieldsoffsetfiltersdirection
getfly_get_account
Get customer
One customer by its customer code (account_code, e.g. KH/2025/000001): full profile with contacts, custom fields, type, source, industry, manager and revenue. GET /api/v6.1/account?account_code=.
輸入參數fieldsaccount_code必填
getfly_create_account
Create customer
WRITE: Create a new customer (account) in Getfly CRM. The customer code must be unique (leave it out to let Getfly generate one). Type, source, industry, relationship, country, province, district and ward are given by NAME and must match the names configured in Getfly. Optionally adds one primary contact. Creating records may trigger the workflows and notifications set up in the CRM. POST /api/v6.1/account.
輸入參數emailcontactwebsitebirthdaysic_codeward_namedescriptionaccount_codeaccount_name必填country_namephone_officecustom_fields另有 8 個
getfly_update_account
Update customer
WRITE: Update fields of an existing customer, found by its current customer code. Send only the fields to change. Names (relationship, country, province...) must match those configured in Getfly. Contacts and the type/source/industry lists are not editable here. PUT /api/v6.1/account.
輸入參數emailwebsitebirthdaysic_codeward_namedescriptionaccount_codeaccount_namecountry_namephone_officecustom_fieldsdistrict_name另有 5 個
getfly_list_campaigns
List campaigns
List sales campaigns (opportunity pipelines): campaign code and name, responsible user, lock state, related users and the pipeline stages (status ids and names). GET /api/v6.1/campaigns.
輸入參數fields
getfly_get_campaign_stages
Get campaign stages
The pipeline stages of one campaign (status id, name and how many opportunities are in each). Pass exactly one of campaign_id and campaign_code. GET /api/v6.1/campaign/status.
輸入參數campaign_idcampaign_code
getfly_list_opportunities
List opportunities
List sales opportunities (deals in a campaign pipeline) with code, name, stage, probability, handler, customer and campaign. Filter by campaign with the campaign_code argument. GET /api/v6.1/opportunities.
輸入參數sortlimitfieldsoffsetfiltersdirectioncampaign_code
getfly_get_opportunity
Get opportunity
One opportunity by its code (e.g. CH2284): stage, probability, handler, customer and campaign. GET /api/v6.1/opportunity.
輸入參數fieldsopportunity_code必填
getfly_create_opportunity
Create opportunity
WRITE: Create a sales opportunity in a campaign for a customer and assign it to a user. Creates (or links) the customer and contact from the details given. The assigned user and the campaign rules may be notified by Getfly. POST /api/v6.1/opportunity.
輸入參數account_codeaccount_name必填contact_name必填account_emailaccount_phone必填campaign_code必填contact_emailcontact_phone必填recipient_username必填
getfly_move_opportunity_stage
Move opportunity to a pipeline stage
WRITE: Move an opportunity to another stage of its campaign pipeline, without changing anything else. Identify the opportunity by code (or id) and the campaign by code (or id); the new stage by name (or status id) from getfly_get_campaign_stages. Won/lost/cancelled results are not set here. PUT /api/v6.1/opportunity/stage.
輸入參數campaign_idcampaign_codeopportunity_idopportunity_codeopportunity_statusopportunity_status_name
getfly_list_products
List products
List products and services with code, name, category, unit, retail/wholesale/online price, sale price, VAT and dates. GET /api/v6.1/products.
輸入參數sortlimitfieldsoffsetdirection
getfly_get_product
Get product
One product by its code (e.g. SP.00192): prices, unit, category, VAT, variants and custom fields. GET /api/v6.1/product.
輸入參數fieldsproduct_code必填
getfly_list_sale_orders
List sales orders
List sales orders with code, customer, amounts, discount, VAT, status, payment status, assigned user and line items. Filters: id, order_date, created_at, updated_at (eq, gte, lte, between). Newest first. GET /api/v6.1/sale_orders.
輸入參數sortlimitfieldsoffsetfiltersdirectionorder_date_toupdated_sinceorder_date_from
getfly_get_sale_order
Get sales order
One sales order by its order code: status, payment status, amounts, customer, line items, shipping info and custom fields. Add payment_periods to fields to include the payment schedule. GET /api/v6.1/sale_order.
輸入參數fieldsorder_code必填
getfly_list_tickets
List support tickets
List support tickets with code, title, content, category, customer and custom fields. GET /api/v6.1/tickets.
輸入參數sortlimitfieldsoffsetfiltersdirection
getfly_get_ticket
Get support ticket
One support ticket by its ticket code. GET /api/v6.1/ticket.
輸入參數fieldsticket_code必填
getfly_list_ticket_categories
List ticket categories
The support ticket categories (id and name). Use a name as cate_name when creating a ticket. GET /api/v6.1/ticket/categories.
無需輸入參數。
getfly_list_ticket_statuses
List ticket statuses
The support ticket statuses (id and name). Use a name as status_name when creating a ticket. GET /api/v6.1/ticket/status.
無需輸入參數。
getfly_create_ticket
Create support ticket
WRITE: Create a support ticket, optionally for a customer. Category and status are given by NAME and must match the names configured in Getfly (getfly_list_ticket_categories, getfly_list_ticket_statuses). The content may contain HTML. Getfly may notify the support team. POST /api/v6.1/ticket.
輸入參數cate_nameexpected_atstatus_nameaccount_codecontact_nameticket_title必填account_emailticket_content必填emergency_phone
getfly_list_tasks
List tasks
List tasks with code, name, start/end time, status, progress, assignee, project and related customers. GET /api/v6.1/tasks.
輸入參數limitfieldsoffset
One task by its task code: status, progress, assignee, project, dates and custom fields. GET /api/v6.1/task.
輸入參數fieldstask_code必填
getfly_create_task
Create task
WRITE: Create a task, optionally in a project, assigned to a user and linked to a customer. Project and task type are given by NAME and must exist in Getfly; users by login name. The assignee may be notified by Getfly. POST /api/v6.1/task.
輸入參數task_codetask_name必填account_codeproject_namerelated_userstask_end_datetask_type_nametask_start_datetask_descriptiontask_parent_codetask_receiver_username
getfly_complete_task
Complete task
WRITE: Mark a task as completed, by its task code. POST /api/v6.1/task/complete.
輸入參數task_code必填
getfly_list_funds
List funds
List the cash/bank funds (accounts for receipts and payments) with id, name, parent, level and financial account. GET /api/v6.1/funds.
輸入參數sortlimitfieldsoffsetfiltersdirection