get_current_user | Get the user the API key acts as (name, e-mail, roles). A Workspace key is not bound to a person and gets a 404; use a Personal key to read it. No arguments. |
get_record | Get one record as a JSON:API resource { data: { type, id, attributes, relationships } }. Arguments: object (string, required, e.g. “person”); id (string, required, from list_records); optional include (comma-separated relationship names to embed). |
list_list_records | List the records that belong to a list (id from list_lists). Arguments: object (string, required, the object type of the list); list (string, required, the list id); optional filter (same shape as list_records), include, limit (integer 1-500), offset, sort_column + sort_dir. The answer is JSON:API { data: […], included, meta, links }. |
list_lists | List the lists (saved views of records) of the workspace, across all objects. Optional arguments: entity (string, object type to keep, e.g. “deal”); list_type (one of static, dynamic, default; dynamic lists are hidden unless asked); search (string, part of the title); limit (integer 1-2000), offset, sort_column + sort_dir. |
list_record_activities | List the activity feed of a record, newest first: field updates, comments and relationship changes. Arguments: object (string, required); id (string, required, from list_records); optional limit (integer 1-500), offset, sort_column + sort_dir. |
list_record_relationship | List the records linked to a record through one relationship, e.g. the deals of a person. Arguments: object (string, required); id (string, required, from list_records); relationship (string, required, from list_schemas, e.g. “deals”); optional include, limit (integer 1-500, default 100), offset, sort_column + sort_dir. |
list_records | List or search the records of one object (companies, people, deals, tasks, meetings or a custom object). Arguments: object (string, required, e.g. “deal”); optional filter (object { fieldName: string or { operator: string } }, e.g. {“email_addresses”: “jane@acme.com”} or {“stage”: “Won”}), include (comma-separated relationship names to embed), limit, offset, sort_column + sort_dir. Optional limit (integer 1-500, default 500), offset (integer), sort_column + sort_dir (ASC or DESC). The answer is JSON:API { data: […], included, meta: { total_records }, links }; follow links.next for the next page. |
list_schemas | List the object schemas of the workspace: for each object (company, person, deal, task, custom c_… objects) its fields with their types and its relationships. Call it first to learn the exact object names, field names (to use in attributes and filters) and relationship names. No arguments. |
list_users | List the users of the workspace with their roles (ids to use in user-reference fields such as an owner). Optional limit (integer 1-500, default 500), offset (integer), sort_column + sort_dir (ASC or DESC). The answer is JSON:API { data: […], included, meta: { total_records }, links }; follow links.next for the next page. |
