Fluid CRM

Creates one company. name is required. This does not check for duplicates: calling it twice with the same company creates two records. Prefer companies_bulk_create even for a single company, because that one matches on website and name first. website is stored exactly as given and is used to match duplicates later, so a malformed website becomes a matching key. label attaches labels ('Partner|Key Account' attaches both; a new name is added to the catalog). Records created here cannot be deleted through this API: confirm with the user before creating records they did not explicitly ask for. Returns the created company with labels and custom_fields.

companies_create

Creates one contact. name is required. This does not check for duplicates: calling it twice with the same person creates two records. Prefer contacts_bulk_create even for a single contact, because that one matches on email first. Text fields are trimmed of surrounding spaces; email keeps its case and is used to match duplicates later. expected_close_date takes a calendar date as YYYY-MM-DD. Records created here cannot be deleted through this API: confirm with the user before creating records they did not explicitly ask for. Returns the created contact with labels and custom_fields.

contacts_create

Creates one deal. Needs stage_id (see workspace_schema) and one of title, deal_name, contact_name or contact_id. company links the company with the same name or same domain (Stripe, stripe.com), else creates it. contact_name links the contact with the same email, else the same name at that company (record, then company text), else, with no email, company or organization_id, the one contact of that name; else creates one with email, phone, job_title, source, notes, next_action, expected_close_date and the company's stored name. contact_id and organization_id link directly. With no company, the deal takes the contact's company. More than one matching contact or company is an error and nothing is created. Other fields on a matched contact are not changed (listed in linked.ignored), and the deal's value is copied onto the linked contact. With contact_name, title is the contact's stored name and deal_name is deal_name, else title. contact_id alone: title is the contact's name, deal_name empty. It does not check for duplicate deals. To add many deals with duplicate protection use deals_bulk_create. deals_create makes several calls per deal and is meant for one deal at a time. Dates are YYYY-MM-DD; value is 0 to under 10 billion. Records created here cannot be deleted through this API. A deal with no contact has an empty contact in the app, and the app requires a contact name when that deal is edited. Returns the deal plus linked { contact, company, ignored }.

deals_create

Creates a reminder on a deal. deal_id and reminder_at are required, note is optional. reminder_at takes an absolute ISO 8601 timestamp including the user's UTC offset, e.g. 2026-11-15T10:00:00+02:00. Work out anything relative the user says, such as 'next Friday' or 'in two weeks', into an absolute timestamp yourself before calling. Prefer a midday time over midnight. If you only have a date, do not invent a time: send it as YYYY-MM-DD together with tz (the user's IANA timezone) and it is stored at 12:00 that day in that zone, so it never lands on the wrong day. If you do not know the user's timezone, ask for it rather than assuming UTC. Returns the created reminder.

reminders_create

Finds companies. Filter by text (q matches name, website and industry) or updated_since (an ISO 8601 timestamp), or fetch specific companies by id or ids. Every row carries its labels (names) and custom_fields. limit is capped at 500 and the applied page size is echoed as limit. Returns { items[], next_cursor, has_more, limit }; pass cursor to get the next page and stop when has_more is false (an unreadable or altered cursor is rejected with an error rather than silently restarting from page 1: drop it and start again).

companies_list

Finds contacts. Filter by text (q matches name, email and company), organization_id or updated_since (an ISO 8601 timestamp), or fetch specific contacts by id or ids. Every row carries its labels (names) and custom_fields. limit is capped at 500 and the applied page size is echoed as limit. Returns { items[], next_cursor, has_more, limit }; pass cursor to get the next page and stop when has_more is false (an unreadable or altered cursor is rejected with an error rather than silently restarting from page 1: drop it and start again).

contacts_list

Finds deals. Filter by text (q matches title and deal name), stage_id, contact_id, organization_id, status (active, won or lost) or updated_since (an ISO 8601 timestamp), or fetch specific deals by id or ids. Every row carries its labels (names) and custom_fields. limit is capped at 500 and the applied page size is echoed as limit. Returns { items[], next_cursor, has_more, limit }; pass cursor to get the next page and stop when has_more is false (an unreadable or altered cursor is rejected with an error rather than silently restarting from page 1: drop it and start again).

deals_list

Answers 'how many deals are in X' and 'what is the pipeline worth' without paging through deals. Returns active deal count and total value per stage per pipeline, won and lost totals, workspace-wide deal totals, reminder counts (overdue, due today, due this week) and contact and company counts. Always pass tz as the user's own timezone in IANA form, e.g. Europe/Helsinki; it defaults to UTC, which changes what counts as due today and due this week.

get_pipeline_summary

Describes a workspace in one call: pipelines with their stages (ids, order, win probability), the label catalog, and the custom field definitions for deals, contacts and companies. Call it before creating or moving deals (you need a stage_id), attaching labels, or writing custom_fields (matched by field name). Two things to know before writing. Deal custom fields listed with a pipeline_id belong to that pipeline: set them only on deals in it (the app shows the value only while the deal is in that pipeline). Fields with required true must be filled before a deal is moved into their pipeline; deals_update does not enforce this, the app does. Label names are matched without case sensitivity, and a name that does not exist yet is created as a new label that cannot be deleted through this API, so check the catalog before inventing one. Returns { pipelines[{id,name,stages[]}], labels[], custom_fields{deal[],contact[],company[]} }.

workspace_schema

Imports up to 50 companies in one call using Fluid's duplicate matching: a row whose website host or name already exists is reported as matched and not created, and www is stripped before matching, so www.example.com finds example.com. A row with no name is skipped and listed in row_reports (reason missing_name); the valid rows still import. Retrying the same rows is always safe. name is required per row. A row may carry label ('Partner|Key Account' attaches both; a name not in the catalog is added to it). For more than 50 rows, split into chunks and call once per chunk. Records created here cannot be deleted through this API: confirm with the user before importing a large list. Returns counts (received, created, skipped_invalid, matched_existing, duplicates_in_batch, failed), created_companies[{row_idx,id}] and row_reports[{row_idx,reason}], numbered by your rows counting from 1 (row_idx 1 is your first row).

companies_bulk_create