KnowWho CRM

Creates one record: a person, company, event, note, task, or opportunity. Matches against existing records before creating: a person by any of their email addresses or by exact name and company, a company by name or domain, an event by name and date. When an exact match exists, returns the existing records and creates nothing unless told to proceed. A company given by name for a person or an opportunity is matched the same way and created when nothing close exists. A person can have several email addresses and phone numbers, the first of each being the primary. People, companies and events can carry tags: each is stored in lower case with spaces and separators turned into single dashes, and an existing tag of the same name is reused. Creation-time attachments are limited to what makes the record meaningful: a person's employer and role, a note's mentions (at least one required), a task's subject people and what it relates to, an opportunity's company. All other connections, including an event's host and the people involved in an opportunity, are not covered. Returns the id and a one-line confirmation stating whether the record was created or matched.

create_entity

Permanently removes one connection between two records, for a connection recorded in error. Cannot be undone. A job or membership that ended, rather than never existed, is covered by ending it, which keeps the history; deletion removes the record that it ever existed. KNOWS and PARTNER_OF are matched in either direction; INTRODUCED, RELATES_TO, CLIENT_OF and SUBSIDIARY_OF only as recorded. Where more than one connection of the type exists between the two records, the same selection applies as for updating a connection; otherwise nothing is removed and the candidates are returned.

delete_link

Permanently removes one record and every connection to it. Cannot be undone. The workspace's own users and the workspace's own organisation cannot be deleted. A company with people currently recorded as working there is not deleted until they are moved or ended. Notes, tasks and interactions that mention a deleted person remain, without the mention. A tag left on no record is removed. Returns the name of what was removed.

delete_entity

Returns what is recorded about one or more companies or organisations: the record itself, people currently there with roles, people formerly there, members where the organisation is a network or club, other companies it is related to in either direction (members, member of, clients, client of, parent, subsidiaries, partners, with dates and whether ended), interactions with anyone there, notes mentioning the company, open tasks about the company or anyone there, events it hosted, and opportunities with it. Summary detail gives counts and the most recent interaction date; full detail gives every body and applies to one company at a time. Requires company ids. Does not cover: finding a company from a name, or person-level views.

get_company

Returns what is recorded about one or more opportunities: the record itself, the company it is with, the people involved and their roles, who captured it, its interaction timeline, notes mentioning it, open tasks attached to it, and the date of the most recent related interaction. Summary detail gives counts and the last touch; full detail gives every body and applies to one opportunity at a time. Requires opportunity ids. Does not cover: listing or filtering opportunities.

get_opportunity

Returns what is recorded about one or more people: their details, current and former companies with roles (a person can have several current ones), colleagues, people they know, introductions given and received, events attended, memberships, opportunities they are involved in, interactions, notes about them, and open tasks. Summary detail gives counts and the most recent interaction date in place of note and interaction bodies. Full detail gives every body and is available for one person at a time. Requires person ids. Does not cover: finding a person from a name, filtering across many people, or company-level views.

get_person

Creates a connection between two existing records. WORKS_AT: person to company, with role, title and start date; a person can hold several jobs at once, so other current employment is kept unless ending it is requested, in which case it is dated to the new start; the response lists the person's other current employment; a current role at the same company is updated in place. MEMBER_OF: person to a network, club, chamber or community. KNOWS: two people, symmetric, one connection covers both directions; an existing one is updated. INTRODUCED: the first person introduced the second; directional; does not by itself record that they know each other. ATTENDED: person to event. INVOLVES: opportunity to person, with the person's role in the deal, an existing one being updated; interaction to person, a participant; task to person it is about. RELATES_TO: task to company, event or opportunity; interaction to event or opportunity; opportunity to company, replacing any previous company; event to its host company. Between two companies: MEMBER_OF (the first is a member of the second, a network or association), CLIENT_OF (the first is a client of the second), SUBSIDIARY_OF (the first is owned by the second), PARTNER_OF (symmetric, one connection covers both directions); each with optional since, until and notes; an existing one is updated; where the same relationship is already recorded the other way round, nothing is written and the existing one is returned. Requires ids for both ends. Returns a confirmation naming both records.

link

Returns records of one type that match exact field values, a date range, a substring on one named field, a connection to a given record, tags, or the signed-in user as owner. Connection matching is one hop, any relationship, either direction. Substring matching is exact and on a single named field, not tolerant of misspellings and not across fields. Date ranges apply to the type's own date: event date, interaction date, task due date, opportunity expected close, otherwise created date. Filterable fields: Person first_name, last_name, email (any of the person's addresses), source; Company name, type, status, domain; Event name, type, location; Interaction type, direction; Task status, type; Note none; Opportunity status, stage, currency. Tags apply to people, companies and events; a record matches when it carries every tag given. Companies can be filtered by a relationship to a given company: by default the companies on the first side of it, that is the members of a network (MEMBER_OF), the clients of a supplier (CLIENT_OF), the subsidiaries of a parent (SUBSIDIARY_OF) or the partners of a company (PARTNER_OF); direction to reverses it, giving the networks a company belongs to, its suppliers or its parent; ended relationships are left out unless included. Results are projected summaries ordered by that date, or by name where there is none, with a page offset. Covers: filtered lists, tasks due, people at a company or event, quiet opportunities. Does not cover: name lookup across fields, or one record's full neighbourhood.

query

Records something that happened at a point in time: a meeting, call, email, message, or attendance at an event. Takes a plain account of what happened and the people present or taking part, given by id or by name and details. People, companies and events given by details are matched against existing records, by any email address, then by name and company, then by name alone, before anything is created. Where a reference matches more than one existing record, nothing is written and the candidates are returned. Contact details, tags, and an event's description and link are written only to records this call creates; tags given for a record that already exists are not applied and are listed in the response. Also records who was introduced by whom, that the signed-in user and any colleagues listed now know the people met, a standing observation as a note, and follow-up tasks. Nothing is written until every reference has resolved to exactly one record. Returns a confirmation listing what was matched to existing records and what was created, with names spelled out. Covers: any encounter, including a first meeting, a later contact, an introduction, and follow-ups arising. Does not cover: standing facts with no encounter attached, or corrections to something already recorded.

record_encounter

Finds people, companies, events, notes, interactions and opportunities by name, any of a person's email addresses, or words that appear in their text, an interaction's account of what happened, or an event's description, location or notes. Matching is by words, tolerant of misspellings and partial words, not by meaning: a query using different words to the ones written does not match. Returns ids with one line of context, what the match was on, and a short snippet. Note hits include the people and companies the note mentions; interaction hits include the people involved. Covers: locating a record from a name, an email, or a word expected to appear in it. Does not cover: filtering by field value or date, connections between records, or one record's full history. Results are brief, never full records.

search