# Goliath Developers > The Goliath developer API: one endpoint (POST https://server.goliathdata.com/api/v1/call), 619 named operations, Bearer keys that act as their owner. The whole catalog as one Markdown file: https://server.goliathdata.com/api/v1/help ## Start - [Quickstart](https://goliathdata.com/developers/quickstart/): create a key and make your first call - [Errors](https://goliathdata.com/developers/guides/errors/): every status and code ## Guides - [Account API](https://goliathdata.com/developers/guides/account/): Read and update your profile and organization settings, route new contacts, inspect permissions, and manage integration connections through the Goliath developer API - [AI Employees API](https://goliathdata.com/developers/guides/ai-employees/): Hire, configure, switch on and off, and assign AI employees to contacts, and answer their suggestion cards, through the Goliath developer API - [Appointments API](https://goliathdata.com/developers/guides/appointments/): Check calendar conflicts, manage appointments and SMS reminders, and configure booking availability through the Goliath developer API - [Ask Goliath API](https://goliathdata.com/developers/guides/ask-goliath/): Talk to a person's Ask Goliath agent from your own app or AI system, and send feedback to the Goliath team, through the developer API - [Authorization](https://goliathdata.com/developers/guides/authorization/): How the developer API decides what a key may do — scopes, organization access, and what a 403 means - [Automations Map API](https://goliathdata.com/developers/guides/automation-map/): Read your organization's Automations Map, its version history, and restore an earlier version through the Goliath developer API - [Billing API](https://goliathdata.com/developers/guides/billing/): Read subscription dates, plan allowances, AI usage warnings, credit balances, and fixed credit packs through the Goliath developer API - [Bulk Tasks API](https://goliathdata.com/developers/guides/bulk-tasks/): Poll the status of long-running bulk jobs through the Goliath developer API - [Call Lists API](https://goliathdata.com/developers/guides/call-lists/): Build, page, edit and archive dialer call lists through the Goliath developer API - [Communications API](https://goliathdata.com/developers/guides/communications/): Send texts and emails, read and triage inbox conversations, manage opt-outs, phone numbers, call routing and the dialer through the Goliath developer API - [Contact Imports API](https://goliathdata.com/developers/guides/contact-imports/): Import contacts from a spreadsheet — map columns, preview, revise and confirm — through the Goliath developer API - [Contacts API](https://goliathdata.com/developers/guides/contacts/): Search, create, update and enrich contacts; manage links, Do Not Contact, AI pauses, sharing and suggestion cards through the Goliath developer API - [Content Templates API](https://goliathdata.com/developers/guides/content-templates/): Manage reusable email, SMS, note, task, and task-set templates through the Goliath developer API - [Contracts API](https://goliathdata.com/developers/guides/contracts/): Read contract templates and contracts, prepare a contract from a template, and send, remind, correct or void it through the Goliath developer API - [Coverage API](https://goliathdata.com/developers/guides/coverage/): Check which property signals are live in your counties and read the Coverage page through the Goliath developer API - [Deals API](https://goliathdata.com/developers/guides/deals/): Search and filter deals, read open-task counts, edit custom fields, and work deals in bulk through the Goliath developer API - [Files API](https://goliathdata.com/developers/guides/files/): Exports, bulk skip traces, upload reports and export presets through the Goliath developer API - [Forms API](https://goliathdata.com/developers/guides/forms/): Manage lead-capture forms, read submissions, and pull form analytics through the Goliath developer API - [Library API](https://goliathdata.com/developers/guides/library/): Read and edit files and folders, share them, run skip traces and tags on Library files, and manage memory notes through the Goliath developer API - [Memory API](https://goliathdata.com/developers/guides/memory/): Add conversation records from another system to your organization's memory through the Goliath developer API - [Notifications API](https://goliathdata.com/developers/guides/notifications/): Read and manage your notification feed, decide Catch up cards, and tidy your Today list through the Goliath developer API - [Developer API Overview](https://goliathdata.com/developers/guides/overview/): Authenticate, discover, and call Goliath developer API operations from your own code - [Partnerships API](https://goliathdata.com/developers/guides/partnerships/): Set up and manage lead-sharing partnerships with other Goliath organizations through the Goliath developer API - [Pipelines API](https://goliathdata.com/developers/guides/pipelines/): Manage pipeline structure and read pipeline analytics through the Goliath developer API - [What Goliath Is](https://goliathdata.com/developers/guides/platform-overview/): An overview of the Goliath platform for developers and AI agents: what it does for real-estate investors and operators, and which API covers each part - [Properties API](https://goliathdata.com/developers/guides/properties/): Search properties, count signal events, manage saved filters and folders, organize lists, and skip-trace owners through the Goliath developer API - [Write without fear](https://goliathdata.com/developers/guides/retry-safe-writes/): A write that times out leaves you guessing. Here's how to retry anything and never create it twice. - [Scheduled Tasks API](https://goliathdata.com/developers/guides/scheduled-tasks/): Schedule Ask Goliath to run an instruction on a cron or at a set time, and pause, resume, edit or delete scheduled tasks through the Goliath developer API - [Configuration](https://goliathdata.com/developers/guides/sdk-configuration/): GoliathClient constructor options — base URL, timeouts, retries, and custom fetch - [Discovering operations](https://goliathdata.com/developers/guides/sdk-discovery/): Find any operation via the in-package docs tree, the live discovery endpoints, or the untyped escape hatch - [Errors, retries & idempotency](https://goliathdata.com/developers/guides/sdk-errors/): Every @goliath-data/sdk error class, the built-in retry policy, and how idempotent writes work - [Tasks API](https://goliathdata.com/developers/guides/tasks/): Create, list, reschedule, and complete CRM to-do tasks through the Goliath developer API - [Team API](https://goliathdata.com/developers/guides/team/): Manage team roles, permissions, teams, invitations and goal plans, and read live activity counts and team analytics through the Goliath developer API - [TypeScript SDK](https://goliathdata.com/developers/guides/typescript-sdk/): Call the Goliath developer API with typed methods, built-in retries, and idempotent writes using @goliath-data/sdk - [Workflows API](https://goliathdata.com/developers/guides/workflows/): Build workflow drafts, set live sending schedules, enroll contacts in bulk, and manage runs and templates through the Goliath developer API - [Skip Trace API](https://goliathdata.com/developers/integrations/skip-trace-api/): Run skip traces programmatically from your own systems using the Goliath developer API - [Actions](https://goliathdata.com/developers/integrations/zapier-actions/): Things your Zaps can do inside Goliath. - [Connecting Goliath to Zapier](https://goliathdata.com/developers/integrations/zapier-auth/): How to connect your Goliath account to Zapier. - [Zapier Integration Overview](https://goliathdata.com/developers/integrations/zapier-overview/): Connect Goliath to thousands of apps via Zapier — push contacts in from any source, and react to contact events in your Zaps. - [Triggers](https://goliathdata.com/developers/integrations/zapier-triggers/): Events in Goliath that can start a Zap. - [Introduction](https://goliathdata.com/developers/webhooks/): Goliath's webhook API — send data in, get signals out. - [CatalystEvent](https://goliathdata.com/developers/webhooks/catalyst-event/): The trigger signal that caused a Goliath webhook to fire. - [Catalyst Property Event](https://goliathdata.com/developers/webhooks/catalyst-event-webhooks/): Shared type definitions used across Goliath webhook payloads. - [CatalystSummary](https://goliathdata.com/developers/webhooks/catalyst-summary/): The parsed contents of catalystEvent.summary — delivered as a stringified JSON object. - [Contact Webhook Payload](https://goliathdata.com/developers/webhooks/contact-webhook/): Reference for the JSON body POSTed to URLs configured on the contact Send Webhook workflow action and the Forward Contact agent tool - [Email](https://goliathdata.com/developers/webhooks/email/): A single email address with a confidence ranking. - [Authentication](https://goliathdata.com/developers/webhooks/inbound-auth/): How to authenticate inbound webhook requests using a token URL or JWT. - [Create Contact](https://goliathdata.com/developers/webhooks/inbound-create/): Create or update a contact from structured data — no AI extraction. - [Create with AI](https://goliathdata.com/developers/webhooks/inbound-create-with-ai/): Send unstructured text and let Goliath's AI extract and create or update a contact. - [Errors](https://goliathdata.com/developers/webhooks/inbound-error/): HTTP error codes returned by Goliath inbound webhook endpoints. - [Find Contact](https://goliathdata.com/developers/webhooks/inbound-find/): Search for contacts in Goliath by name, phone, or email. - [ContactResponse](https://goliathdata.com/developers/webhooks/inbound-types-contact-response/): The contact object returned by the find endpoint. - [ContactCreateInput](https://goliathdata.com/developers/webhooks/inbound-types-create-input/): Request body for the create and create-with-ai inbound webhook endpoints. - [ContactFindInput](https://goliathdata.com/developers/webhooks/inbound-types-find-input/): Request body for the find contact inbound webhook endpoint. - [ContactUpdateInput](https://goliathdata.com/developers/webhooks/inbound-types-update-input/): Request body for the update contact inbound webhook endpoint. - [Update Contact](https://goliathdata.com/developers/webhooks/inbound-update/): Patch an existing contact by ID. - [Overview](https://goliathdata.com/developers/webhooks/inbound-webhook-overview/): Per-organization HTTP endpoints that let external systems create or update contacts in Goliath without a user JWT. - [Owner](https://goliathdata.com/developers/webhooks/owner/): A single known owner tied to a property, with direct contact data attached. - [Parcel](https://goliathdata.com/developers/webhooks/parcel/): Legal and assessor-level data about a land parcel. - [Phone](https://goliathdata.com/developers/webhooks/phone/): A single phone number with its line type and confidence ranking. - [Property](https://goliathdata.com/developers/webhooks/property/): The full enriched property object tied to a Goliath webhook event. - [PropertyMetrics](https://goliathdata.com/developers/webhooks/property-metrics/): Core valuation and physical details about a property. - [SkipTrace](https://goliathdata.com/developers/webhooks/skip-trace/): The contact bundle attached directly to an owner — best available phones and emails for that person. - [SkipTraceResult](https://goliathdata.com/developers/webhooks/skiptrace-result/): An individual in the expanded people graph tied to a property — includes owners and known relatives. ## Reference ### Contacts - [getContact](https://goliathdata.com/developers/reference/contacts/getContact.md): MERGED IDS RESOLVE: an id merged into another contact returns the SURVIVING record, so the id that comes back can differ from the one you sent. - [getContactsProperties](https://goliathdata.com/developers/reference/contacts/getContactsProperties.md): Many contacts' linked properties in ONE read: contactIds in (a bulk selection's ids, up to 200), each contact's properties[] out (propertyString, and property.id, the property id a skip trace,... - [findContactsByNote](https://goliathdata.com/developers/reference/contacts/findContactsByNote.md): Contacts by what their NOTES say; for calls, texts and emails too, use searchInteractions. - [searchInteractions](https://goliathdata.com/developers/reference/contacts/searchInteractions.md): Contacts by what was SAID on calls, notes, texts or emails. - [countContacts](https://goliathdata.com/developers/reference/contacts/countContacts.md): The number of active contacts visible to you, in one call: the total the Contacts page shows (archived and hidden contacts excluded). - [findContacts](https://goliathdata.com/developers/reference/contacts/findContacts.md): Fuzzy-search contacts by name, phone, email, or address. - [searchContactTags](https://goliathdata.com/developers/reference/contacts/searchContactTags.md): Search contact tags and lists. tags are free-form TAGS; lists, uploadTags and exportTags are LISTS (the last two from imports and exports), each with folderId (listFilterFolders). - [contactTagUsage](https://goliathdata.com/developers/reference/contacts/contactTagUsage.md): Free-form tags, least-used first: contactCount (visible, unarchived), orgContactCount (org, +archived; null w/o view-all: 0 proves nothing), dependents. maxContactCount 0 = unused (view-all).... - [listSmsOptOuts](https://goliathdata.com/developers/reference/contacts/listSmsOptOuts.md): Who opted out of texts (texted STOP, unsubscribed, carrier opt-out, blocked by a teammate), newest first: source, optedOutAt, reason, phoneNumber and the contacts you can see carrying it. - [countRecords](https://goliathdata.com/developers/reference/contacts/countRecords.md): Count records grouped by any field in ONE call: tasks per contact or per teammate, mine vs others, contacts by source, deals by stage. - [listContactCustomFields](https://goliathdata.com/developers/reference/contacts/listContactCustomFields.md): The organization's contact custom-field DEFINITIONS (id, name, type: TEXT/NUMBER/DOLLAR/DATE/LINK/DROPDOWN, dropdown options, allowMultiple, defaultValue). - [listContactFilters](https://goliathdata.com/developers/reference/contacts/listContactFilters.md): List the saved contact filters VISIBLE to the key owner; run one with filterContacts, delete one with deleteContactFilter. - [filterContacts](https://goliathdata.com/developers/reference/contacts/filterContacts.md): Run a contact filter and paginate the matches with limit/offset. - [listContactActivities](https://goliathdata.com/developers/reference/contacts/listContactActivities.md): A contact's activity timeline (calls, texts, emails, notes, system events), most recent first. - [getContactIdentity](https://goliathdata.com/developers/reference/contacts/getContactIdentity.md): A contact's own email addresses: never its related people's (sub-contacts'), and never one marked WRONG. - [listContactSuggestions](https://goliathdata.com/developers/reference/contacts/listContactSuggestions.md): A contact's pending suggestion cards, newest first: what each proposes (action: a text or email reply and its words, a note, a task, a booking, a fix to the record), with how sure it is. dirtyAt... - [createContact](https://goliathdata.com/developers/reference/contacts/createContact.md): Create a contact; needs sellerFirstName, sellerLastName, and type (LISTING | INVESTMENT | BUYER | UNDETERMINED); phones/emails optional. - [updateContact](https://goliathdata.com/developers/reference/contacts/updateContact.md): Update a contact by contactId: the general-purpose per-contact write. - [addContactNote](https://goliathdata.com/developers/reference/contacts/addContactNote.md): Add a text note to a contact, synchronously (getContact returns it at once). - [editContactNote](https://goliathdata.com/developers/reference/contacts/editContactNote.md): Rewrite an existing note's body (by noteId). - [deleteContactNote](https://goliathdata.com/developers/reference/contacts/deleteContactNote.md): PERMANENTLY delete a note (by noteId): it leaves the contact's timeline with NO undo, so ALWAYS show its text and get their yes; a card counts. - [createNoteReply](https://goliathdata.com/developers/reference/contacts/createNoteReply.md): Reply to a note (getContact notes[]) as the key owner; AI employees cannot. - [editNoteReply](https://goliathdata.com/developers/reference/contacts/editNoteReply.md): Replace a reply's body (replyId from getContact notes[].replies); echoes the saved body. - [deleteNoteReply](https://goliathdata.com/developers/reference/contacts/deleteNoteReply.md): Delete a reply for good. - [changeNotePinned](https://goliathdata.com/developers/reference/contacts/changeNotePinned.md): Pin (isPinned true) or unpin a note (getContact notes[]); any teammate may. - [addContactTags](https://goliathdata.com/developers/reference/contacts/addContactTags.md): Add tags to contacts: existing ones by tagIds (searchContactTags), new ones by exact name in newTagNames, created as this runs, never createContactTag first. removeContactTags is the twin. - [removeContactTags](https://goliathdata.com/developers/reference/contacts/removeContactTags.md): Strip tags (tag ids from searchContactTags) off contacts: the removal twin of addContactTags, and the undo for a bulk tag that leaves the tag definition alone. - [addContactsToList](https://goliathdata.com/developers/reference/contacts/addContactsToList.md): Add contacts to one or more LISTS (segments) by list id (searchContactTags lists / createContactList): the selection-wide form of updateContact’s addToListIds; removeContactsFromList is the twin. - [removeContactsFromList](https://goliathdata.com/developers/reference/contacts/removeContactsFromList.md): Take contacts OFF one or more lists by list id: the removal twin of addContactsToList and the undo for a bulk add. - [assignContact](https://goliathdata.com/developers/reference/contacts/assignContact.md): Assign a teammate to contacts (get userId from listTeammates). role defaults to POINT_PERSON; pass PARTICIPANT for a secondary assignment. - [unassignContact](https://goliathdata.com/developers/reference/contacts/unassignContact.md): Take teammates OFF contacts: the removal twin of assignContact, and the offboarding op. userIds is a LIST, so one call clears several teammates from the selection; each is removed from every... - [setContactsCustomField](https://goliathdata.com/developers/reference/contacts/setContactsCustomField.md): Set ONE DROPDOWN custom field to the same value across a selection of contacts: the bulk form of updateContact’s updateCustomFieldValues. customFieldId from listContactCustomFields; read the... - [createContactTag](https://goliathdata.com/developers/reference/contacts/createContactTag.md): Create an org-wide free-form contact tag, synchronously. - [renameContactTag](https://goliathdata.com/developers/reference/contacts/renameContactTag.md): Rename a FREE-FORM contact tag in place (tagId from searchContactTags tags). - [createContactCustomField](https://goliathdata.com/developers/reference/contacts/createContactCustomField.md): Create an org-wide contact custom-field DEFINITION (name + type: TEXT | NUMBER | DOLLAR | DATE | LINK | DROPDOWN; options required for DROPDOWN; allowMultiple optional), synchronously. - [updateContactCustomField](https://goliathdata.com/developers/reference/contacts/updateContactCustomField.md): Edit a contact custom-field DEFINITION in place (id from listContactCustomFields). - [reorderContactCustomFields](https://goliathdata.com/developers/reference/contacts/reorderContactCustomFields.md): Set the DISPLAY ORDER of the organization's contact custom fields. - [createContactList](https://goliathdata.com/developers/reference/contacts/createContactList.md): Create an org-wide contact list (segment), synchronously. - [renameContactList](https://goliathdata.com/developers/reference/contacts/renameContactList.md): Rename a contact LIST in place (listId from searchContactTags lists): "rename Hot Leads to Priority Sellers". - [archiveContacts](https://goliathdata.com/developers/reference/contacts/archiveContacts.md): Archive (soft-delete) contacts by id. - [unarchiveContacts](https://goliathdata.com/developers/reference/contacts/unarchiveContacts.md): Restore archived contacts by id: the undo for archiveContacts. - [findDuplicateContactGroups](https://goliathdata.com/developers/reference/contacts/findDuplicateContactGroups.md): Every duplicate group (same name + shared phone or email) in ONE call, never contact by contact. matchBy: NAME = name alone, unverified, each group listing the phones and emails its members share... - [findContactDataProblems](https://goliathdata.com/developers/reference/contacts/findContactDataProblems.md): Contact data problems in ONE call, never contact by contact: EMAIL_NOT_LOWERCASE, NAME_EMPTY, NAME_ONE_WORD (a first or last name missing; which is unknown), PHONE_NOT_NORMALIZED (not the 10-digit... - [findSharedPropertyAddresses](https://goliathdata.com/developers/reference/contacts/findSharedPropertyAddresses.md): Groups of 2+ contacts linked to the same property address (the parcel, else the mailing address row, else the text folded for case and punctuation), largest first, in ONE call: address,... - [contactListUsage](https://goliathdata.com/developers/reference/contacts/contactListUsage.md): EVERY list in ONE call, import uploads ("Contacts from … .csv", kind UPLOAD) and exports included, emptiest first: contactCount (unarchived you see), orgActiveContactCount /... - [duplicateContactsByRep](https://goliathdata.com/developers/reference/contacts/duplicateContactsByRep.md): findDuplicateContactGroups tallied per assigned rep (point person) in ONE call: per rep, groupCount (groups holding one of their contacts) and contactCount; userId null = unassigned. totalGroups,... - [lowercaseContactEmails](https://goliathdata.com/developers/reference/contacts/lowercaseContactEmails.md): Lowercase every capitalised email on these contacts (≤500; the ids findContactDataProblems problem EMAIL_NOT_LOWERCASE lists), in place: changedEmails, changedContacts, left (the contact already... - [getContactConnections](https://goliathdata.com/developers/reference/contacts/getContactConnections.md): A contact's Links card (externalLinks), related people (linkedRelationships, with linkedContactId), relatives not yet contacts (subContacts) and the AI pause in force (aiPause, null when AI is on:... - [listContactDirectMail](https://goliathdata.com/developers/reference/contacts/listContactDirectMail.md): The letters sent to one contact by any mail provider, newest first, 20 a page (pass nextCursor as after): id, campaignLabel, status, preparedAt, mailedAt. - [setContactDoNotContact](https://goliathdata.com/developers/reference/contacts/setContactDoNotContact.md): Mark a contact Do Not Contact (optional reason): every text, email and call to it is blocked, its workflow runs stop for good and its AI employees come off. - [setPhoneDoNotContact](https://goliathdata.com/developers/reference/contacts/setPhoneDoNotContact.md): Opt one phone number out of texts AND calls for the whole organization, on every contact that carries it (suppressChannel does one medium). - [pauseContactAi](https://goliathdata.com/developers/reference/contacts/pauseContactAi.md): Pause AI on one contact. mode ALL: no AI employee runs, and workflow AI employee steps that come due are skipped, not deferred; MESSAGES: runs go on but no AI text, email or Slack message is... - [resumeContactAi](https://goliathdata.com/developers/reference/contacts/resumeContactAi.md): Turn AI back on for one contact (a contact with no pause is a no-op); its AI employees can text and email it again. - [pauseContactsAi](https://goliathdata.com/developers/reference/contacts/pauseContactsAi.md): pauseContactAi (same mode and pausedUntil) for many contacts, as a bulk task (bulkTaskId, getBulkTask). - [resumeContactsAi](https://goliathdata.com/developers/reference/contacts/resumeContactsAi.md): resumeContactAi for many contacts, as a bulk task (bulkTaskId, getBulkTask). - [addContactExternalLink](https://goliathdata.com/developers/reference/contacts/addContactExternalLink.md): Add a titled URL to a contact's Links card (getContactConnections externalLinks): a web address, or an app path starting with / (it becomes the app's own URL). - [removeContactFiles](https://goliathdata.com/developers/reference/contacts/removeContactFiles.md): Take files off a contact's Files & Photos by file id (a Library filing's uploadedFileId, or a files[].id), as the Files card's delete does. - [updateContactExternalLink](https://goliathdata.com/developers/reference/contacts/updateContactExternalLink.md): Change a contact link's title or URL (an omitted one is kept). - [removeContactExternalLink](https://goliathdata.com/developers/reference/contacts/removeContactExternalLink.md): Remove a contact link, for good. - [updateContactRelationship](https://goliathdata.com/developers/reference/contacts/updateContactRelationship.md): Set the relation label and note on a related person (getContactConnections linkedRelationships id). - [unlinkRelatedContact](https://goliathdata.com/developers/reference/contacts/unlinkRelatedContact.md): Disconnect a related person (linkedRelationships id), for good. - [convertSubContactToLinkedRelationship](https://goliathdata.com/developers/reference/contacts/convertSubContactToLinkedRelationship.md): Promote a relative (getContactConnections subContacts id) to its own contact, linked back as a related person; returns the link with linkedContactId. linkToExisting: true links the org's existing... - [requestDirectMailCancellation](https://goliathdata.com/developers/reference/contacts/requestDirectMailCancellation.md): Ask the mail provider to cancel one letter (listContactDirectMail id). contactId must be the contact the letter is on: the id getContact returns, which differs from a merged-away id (this write... - [controlContactsWorkflowRuns](https://goliathdata.com/developers/reference/contacts/controlContactsWorkflowRuns.md): PAUSE or RESUME the workflow runs of contacts (optional workflowGroupIds narrows it). - [decideContactSuggestionsInBulk](https://goliathdata.com/developers/reference/contacts/decideContactSuggestionsInBulk.md): Accept or dismiss many cards at once (verb ACCEPT or DISMISS, suggestionIds at most 500): each runs as its own Accept or Dismiss would, so an ACCEPT can send a reply per card. - [decideSuggestion](https://goliathdata.com/developers/reference/contacts/decideSuggestion.md): Accept or dismiss any card in the suggestion feed (a contact's, an AI employee's or an account card) by its id (verb ACCEPT or DISMISS), the same door Work through uses. - [dismissContactSuggestion](https://goliathdata.com/developers/reference/contacts/dismissContactSuggestion.md): Dismiss a suggestion card with the reason the person gave (NOT_RELEVANT, WRONG_TONE, WRONG_FACTS, ALREADY_DONE, OTHER, …). - [markContactSuggestionHandled](https://goliathdata.com/developers/reference/contacts/markContactSuggestionHandled.md): Close a card the person already handled themselves (they sent the text, made the task): it is marked done WITHOUT running its action, and the reply's paired cards stay pending. - [setAsideContactSuggestions](https://goliathdata.com/developers/reference/contacts/setAsideContactSuggestions.md): Take cards out of an import's bulk review: they stay pending on each contact's own card. - [commentOnSuggestionCard](https://goliathdata.com/developers/reference/contacts/commentOnSuggestionCard.md): Comment on a suggestion card ("too pushy"). - [acceptContactSuggestion](https://goliathdata.com/developers/reference/contacts/acceptContactSuggestion.md): Accept a contact's suggestion card as written: a reply card SENDS its text or email to the contact; another card applies its action. - [acceptEditedContactSuggestion](https://goliathdata.com/developers/reference/contacts/acceptEditedContactSuggestion.md): Accept a text or email reply card with the person's own words (text) in place of the draft; it SENDS. - [mergeContacts](https://goliathdata.com/developers/reference/contacts/mergeContacts.md): Merge duplicate contacts into one survivor. contactIds: the full set (2+); primaryContactId MUST be one of them; it keeps its custom fields and agent, absorbing the others’ notes, tags,... - [linkContactAsRelatedPerson](https://goliathdata.com/developers/reference/contacts/linkContactAsRelatedPerson.md): Connect linkedContactId to parentContactId as a related person, with an optional relation label. - [deleteContactTags](https://goliathdata.com/developers/reference/contacts/deleteContactTags.md): Delete free-form contact tags by id (from createContactTag), removing them from every contact. - [deleteContactFilter](https://goliathdata.com/developers/reference/contacts/deleteContactFilter.md): PERMANENTLY delete a saved CONTACT filter by id (from listContactFilters): no archive, no undo. - [deleteContactLists](https://goliathdata.com/developers/reference/contacts/deleteContactLists.md): Delete contact lists by id (from createContactList), dropping their membership. - [deleteContactCustomField](https://goliathdata.com/developers/reference/contacts/deleteContactCustomField.md): Permanently delete a contact custom-field DEFINITION (id from listContactCustomFields). - [enrichContact](https://goliathdata.com/developers/reference/contacts/enrichContact.md): Skip-trace a contact to discover phone numbers and emails. - [createContactFromProperty](https://goliathdata.com/developers/reference/contacts/createContactFromProperty.md): Create a CRM contact from a property (id/esId). - [shareContactWithPartner](https://goliathdata.com/developers/reference/contacts/shareContactWithPartner.md): Share one contact with a partner organization, the contact page's Share: the partner gets its own copy. partnerOrganizationId from listPartnerships; assignments name the PARTNER org users who get... - [unshareContactWithPartner](https://goliathdata.com/developers/reference/contacts/unshareContactWithPartner.md): Stop sharing a contact with a partner organization: the partner's users lose access to their copy (revokedUsersCount), and sharing it again makes them a new one, never theirs back. - [shareContactsWithPartner](https://goliathdata.com/developers/reference/contacts/shareContactsWithPartner.md): shareContactWithPartner for many contacts (contactIds), as a bulk task (bulkTaskId, getBulkTask). partnerOrganizationId from listPartnerships; assignments name the PARTNER org users who get it... - [setContactsTeams](https://goliathdata.com/developers/reference/contacts/setContactsTeams.md): Put contacts on teams (addTeamIds, from listTeams) and take them off (removeTeamIds); replaceExisting makes addTeamIds the exact set. addTeamIds is required: pass [] to only take them off. - [getContactFieldVisibility](https://goliathdata.com/developers/reference/contacts/getContactFieldVisibility.md): Each contact field's show-when rule: visibleWhen { fieldId, optionIds } (shown only when that dropdown is any of those options), null when always shown. - [addContactCustomFieldOption](https://goliathdata.com/developers/reference/contacts/addContactCustomFieldOption.md): Add one option to a contact DROPDOWN field (listContactCustomFields). - [setContactCustomFieldVisibility](https://goliathdata.com/developers/reference/contacts/setContactCustomFieldVisibility.md): Show fields only when one dropdown is any of optionIds (that dropdown's option ids), replacing each field's rule (read it first: getContactFieldVisibility); optionIds empty = always show. ### Bulk Tasks - [getBulkTask](https://goliathdata.com/developers/reference/bulk-tasks/getBulkTask.md): Status of an async bulk task by the bulkTaskId an async op returned (addPropertiesToList and the like): status (CREATED = queued, PROCESSING = being applied, COMPLETED, FAILED = the change was NOT... ### Appointments - [listAppointments](https://goliathdata.com/developers/reference/appointments/listAppointments.md): List appointments: org-wide for a team-admin key, the key owner's own otherwise (MEMBER keys always only their own, whatever the filters). - [checkAvailability](https://goliathdata.com/developers/reference/appointments/checkAvailability.md): Live conflict check for a proposed slot: run it BEFORE createAppointment, and before moving a time with updateAppointment. - [listAppointmentReminders](https://goliathdata.com/developers/reference/appointments/listAppointmentReminders.md): The organization's appointment reminders: each with its steps (one SMS each, its message and amountBefore + unitBefore lead time, longest lead first) and isGlobal (true on the flagged default). - [getMyAvailabilitySchedule](https://goliathdata.com/developers/reference/appointments/getMyAvailabilitySchedule.md): The key owner's saved availability schedule: timezone, weeklyHours, dateOverrides; null if never saved: booking then uses Mon-Fri 9:00-17:00 in a fallback zone (America/New_York, or a booking... - [createAppointment](https://goliathdata.com/developers/reference/appointments/createAppointment.md): Create an appointment: title, timezone, startDate, endDate; optional location, description, contactIds (accessible to the key owner), participant userIds (listTeammates),... - [updateAppointment](https://goliathdata.com/developers/reference/appointments/updateAppointment.md): Update an appointment by id (listAppointments): title, times, location, description, outcome; addUserIds/removeUserIds, addContactIds/removeContactIds; switch or clear the reminder with... - [deleteAppointment](https://goliathdata.com/developers/reference/appointments/deleteAppointment.md): Delete an appointment by id (from listAppointments). - [createAppointmentReminder](https://goliathdata.com/developers/reference/appointments/createAppointmentReminder.md): A reminder TEXTS REAL CONTACTS automatically. - [updateAppointmentReminder](https://goliathdata.com/developers/reference/appointments/updateAppointmentReminder.md): A reminder TEXTS REAL CONTACTS automatically. - [setDefaultAppointmentReminder](https://goliathdata.com/developers/reference/appointments/setDefaultAppointmentReminder.md): Turn "Run for every appointment" on or off for one reminder (appointmentReminderId), its messages and timing untouched. isGlobal: true makes it the org default and clears any previous one (an org... - [deleteAppointmentReminder](https://goliathdata.com/developers/reference/appointments/deleteAppointmentReminder.md): Delete a reminder by appointmentReminderId. - [setMyAvailabilitySchedule](https://goliathdata.com/developers/reference/appointments/setMyAvailabilitySchedule.md): Create or replace the key owner's availability schedule, a FULL replacement: read getMyAvailabilitySchedule and send back a modified copy, every override to keep included. ### Tasks - [listMyTasks](https://goliathdata.com/developers/reference/tasks/listMyTasks.md): The key owner's OWN to-do queue (appointments, never OVERDUE here: listAppointments). - [listContactTasks](https://goliathdata.com/developers/reference/tasks/listContactTasks.md): List every to-do task on one contact (by contactId from findContacts/getContact/listMyTasks): title, description, dueDate, completedAt, and assigned participants. - [createTaskOnContact](https://goliathdata.com/developers/reference/tasks/createTaskOnContact.md): Create a to-do task on a contact: one line item (title, optional description, due day, assignees) in someone's queue, checked off with completeTask; NOT a calendar event (createAppointment) and... - [createTaskOnDeal](https://goliathdata.com/developers/reference/tasks/createTaskOnDeal.md): Create a to-do task on a deal with no contact: pipeline work that belongs to the deal (order the title search, chase the inspection report). dealId from findDeals/getDeal. createTaskOnContact's... - [updateTask](https://goliathdata.com/developers/reference/tasks/updateTask.md): Fix an existing task by taskId + its linked contactId (from listMyTasks or listContactTasks): title, description, taskType, dueDate (ISO, with timezone), timezone, or participants (teammate... - [rescheduleTasks](https://goliathdata.com/developers/reference/tasks/rescheduleTasks.md): Move MANY tasks to ONE due date in one call ('all my overdue tasks to tomorrow'): taskIds (up to 200, from listMyTasks) OR dueBefore + expectedCount: the key owner's own open tasks due before... - [deleteTask](https://goliathdata.com/developers/reference/tasks/deleteTask.md): PERMANENTLY delete ONE task by taskId + its contactId: gone from the contact and the queue with NO undo, so ALWAYS confirm with the user, naming the task. - [completeTask](https://goliathdata.com/developers/reference/tasks/completeTask.md): Mark a task complete by taskId + its contactId (listMyTasks/listContactTasks). - [completeTaskById](https://goliathdata.com/developers/reference/tasks/completeTaskById.md): Complete a task by taskId ALONE, for tasks with NO contact (listMyTasks contact: null; typically deal tasks). - [deleteTasks](https://goliathdata.com/developers/reference/tasks/deleteTasks.md): deleteTask for many: items [{ id: taskId, contactId }] (up to 200), each task on its own contact; returns deletedCount. - [bulkCreateTasksOnContacts](https://goliathdata.com/developers/reference/tasks/bulkCreateTasksOnContacts.md): The Contacts bulk bar's Add task: ONE task (createTaskOnContact's rules) on each of contactIds, as a background task (bulkTaskId, getBulkTask). assignToPointPerson gives each contact's task to... - [updateTaskOnDeal](https://goliathdata.com/developers/reference/tasks/updateTaskOnDeal.md): updateTask ONLY for a row whose contact is null, by taskId + its dealId (listMyTasks deals); one with a contact is refused (use updateTask), an appointment too, and for a non-admin key one it is... - [deleteTaskOnDeal](https://goliathdata.com/developers/reference/tasks/deleteTaskOnDeal.md): deleteTask ONLY for a row whose contact is null, by taskId + its dealId; refused like updateTaskOnDeal for a contact (use deleteTask), an appointment (deleteAppointment) or a task the non-admin... - [clearStaleWorkflowTasks](https://goliathdata.com/developers/reference/tasks/clearStaleWorkflowTasks.md): Clear the key owner's stale workflow tasks: open to-dos a workflow made, on their list alone, due more than 7 days before today in timezone (an IANA zone). - [cancelTaskClear](https://goliathdata.com/developers/reference/tasks/cancelTaskClear.md): Undo a clear inside its 10 seconds (CANCELLED, nothing changed); ALREADY_STARTED means use restoreClearedTasks. - [restoreClearedTasks](https://goliathdata.com/developers/reference/tasks/restoreClearedTasks.md): Bring back the tasks a clear removed (for 30 days after it), by the clear's bulkTaskId. ### Deals - [getDeal](https://goliathdata.com/developers/reference/deals/getDeal.md): Fetch one deal by id: title, value, close date, stage, pipeline, COMMISSION AND TEAM SPLIT, CUSTOM-FIELD VALUES, assigned users (empty = unassigned), linked contacts (id + name), and linked deals... - [findDeals](https://goliathdata.com/developers/reference/deals/findDeals.md): Search AND TOTAL the deals you can see: totals sums EVERY match, not the page (price, average, commission; totalCount is the count), so a total is one call. - [surveyDeals](https://goliathdata.com/developers/reference/deals/surveyDeals.md): Survey deals: findDeals' search (same visibility), without stageName/outcome/windows/totals, with a deliberately LEAN row: deal id, title, isArchived, stage NAME, pipeline NAME, assigned users by... - [listStalledDeals](https://goliathdata.com/developers/reference/deals/listStalledDeals.md): List deals going cold: no activity for a while, ordered by days inactive, of deals you can see. - [listPipelines](https://goliathdata.com/developers/reference/deals/listPipelines.md): List the organization's deal pipelines with per-stage deal counts and values. - [listDealFilters](https://goliathdata.com/developers/reference/deals/listDealFilters.md): List the saved DEAL filters VISIBLE to the key owner: every shared deal filter in the organization plus your own private ones. - [filterDeals](https://goliathdata.com/developers/reference/deals/filterDeals.md): Run a SAVED deal filter (filterId from listDealFilters or saveFilter type DEAL) over ONE pipeline (pipelineId from listPipelineNames) and page the matching deals with limit/offset: id, title,... - [listPipelineNames](https://goliathdata.com/developers/reference/deals/listPipelineNames.md): List the organization's own deal pipelines, id and name only, oldest first. sameNameCount is how many share the row's name. - [listPipelineStages](https://goliathdata.com/developers/reference/deals/listPipelineStages.md): One pipeline's stages, in order (all pipelines: listStagesOfPipelines). - [listStagesOfPipelines](https://goliathdata.com/developers/reference/deals/listStagesOfPipelines.md): Every owned and shared pipeline and its stages, in order; a large organization's answer is cut short. - [listDealCustomFields](https://goliathdata.com/developers/reference/deals/listDealCustomFields.md): List a deal pipeline's custom-field DEFINITIONS (by pipelineId from listPipelines): id, name, type (TEXT/NUMBER/DOLLAR/DATE/LINK/DROPDOWN), dropdown options, allowMultiple, defaultValue. - [getDeletionImpact](https://goliathdata.com/developers/reference/deals/getDeletionImpact.md): Preview what deleting an org-owned record affects before you do it: it serves every delete op that takes a dependencyResolution, not just the deal ones. - [listDealActivity](https://goliathdata.com/developers/reference/deals/listDealActivity.md): One deal's activity feed, most-recent-first: the audit trail behind "who changed the price on this deal, and when did it get reassigned?". - [listDealComments](https://goliathdata.com/developers/reference/deals/listDealComments.md): One deal's comment thread, most-recent-first (the activity feed narrowed to COMMENT events, paged at the database: the full thread stays reachable however busy the rest of the feed is). - [listDealFiles](https://goliathdata.com/developers/reference/deals/listDealFiles.md): Files attached to a deal, most-recent-first: screenshots, recordings, documents. - [addDealComment](https://goliathdata.com/developers/reference/deals/addDealComment.md): Append a comment to a deal's activity feed, attributed to the API key's owner. - [attachDealFile](https://goliathdata.com/developers/reference/deals/attachDealFile.md): Attach a CHAT file to a deal: the write twin of listDealFiles. - [removeDealFile](https://goliathdata.com/developers/reference/deals/removeDealFile.md): Detach one file from a deal by fileId (fileIds come from listDealFiles). - [createDeal](https://goliathdata.com/developers/reference/deals/createDeal.md): Create a deal in a pipeline stage. - [updateDeal](https://goliathdata.com/developers/reference/deals/updateDeal.md): Update a deal by id: title, price, close date, stage. - [archiveDeal](https://goliathdata.com/developers/reference/deals/archiveDeal.md): Archive or RESTORE one deal by id (isArchived true or false); archiveDeals archives many. - [createPipeline](https://goliathdata.com/developers/reference/deals/createPipeline.md): Create a deal pipeline in your organization. - [createDealCustomField](https://goliathdata.com/developers/reference/deals/createDealCustomField.md): Create a custom-field DEFINITION on a deal pipeline you OWN (pipelineId from listPipelines): name + type (TEXT | NUMBER | DOLLAR | DATE | LINK | DROPDOWN; options required and non-empty for... - [updateDealCustomField](https://goliathdata.com/developers/reference/deals/updateDealCustomField.md): Edit an existing deal custom-field DEFINITION in place (by id from listDealCustomFields). - [updatePipeline](https://goliathdata.com/developers/reference/deals/updatePipeline.md): Update a deal pipeline's title and/or description (by pipelineId from listPipelines). - [addPipelineStages](https://goliathdata.com/developers/reference/deals/addPipelineStages.md): Append one or more stages to a pipeline (by pipelineId). - [updatePipelineStage](https://goliathdata.com/developers/reference/deals/updatePipelineStage.md): Update one pipeline stage (by stageId from listPipelineStages): rename, change description, toggle isTerminal / terminalType (WON|LOST|NEUTRAL), or set winProbability (0-100). - [reorderPipelineStages](https://goliathdata.com/developers/reference/deals/reorderPipelineStages.md): Reorder a pipeline's stages (by pipelineId): pass every stage id in the desired order. - [deletePipeline](https://goliathdata.com/developers/reference/deals/deletePipeline.md): Delete a deal pipeline (owner-only). - [deletePipelineStage](https://goliathdata.com/developers/reference/deals/deletePipelineStage.md): Delete a single pipeline stage (owner-only). - [getPipelineAnalytics](https://goliathdata.com/developers/reference/deals/getPipelineAnalytics.md): Per-pipeline TRENDS for a rolling period (SEVEN_DAYS | FOURTEEN_DAYS | THIRTY_DAYS | YEAR_TO_DATE; THIRTY_DAYS is the last 30 days, not this month) from a NIGHTLY snapshot (asOfDate): stage... - [listPipelineTransitions](https://goliathdata.com/developers/reference/deals/listPipelineTransitions.md): Stage-to-stage deal movement (the funnel) for a reporting period (same period values as getPipelineAnalytics), optionally narrowed to one pipelineId: per transition: deal counts, exits from the... - [archiveDeals](https://goliathdata.com/developers/reference/deals/archiveDeals.md): Archive many deals of one pipeline by id (restore with archiveDeal); a whole filter is the board's own select-all Archive. - [deleteDeal](https://goliathdata.com/developers/reference/deals/deleteDeal.md): Delete a deal for good; archiveDeal hides it instead, so prefer that unless they said delete. - [bulkUpdateDeals](https://goliathdata.com/developers/reference/deals/bulkUpdateDeals.md): One updateDeal input for many deals (stage, close date, owners, contacts); every id must be a deal your org owns or shares, or the whole call is refused. - [bulkCreateDealsOnContacts](https://goliathdata.com/developers/reference/deals/bulkCreateDealsOnContacts.md): A new deal per contact from a createDeal deal template (the bulk bar's Add to pipeline). propertyAttachmentMode ALL attaches each contact's properties as the bulk bar does (default NONE);... - [editDealComment](https://goliathdata.com/developers/reference/deals/editDealComment.md): Replace the body of your own deal comment (listDealComments id). - [deleteDealComment](https://goliathdata.com/developers/reference/deals/deleteDealComment.md): Delete a deal comment you wrote, for good. - [addDealExternalLink](https://goliathdata.com/developers/reference/deals/addDealExternalLink.md): Add a titled URL to a deal's Links card (getDeal externalLinks). - [removeDealExternalLink](https://goliathdata.com/developers/reference/deals/removeDealExternalLink.md): Remove a deal link. - [linkPipelineItems](https://goliathdata.com/developers/reference/deals/linkPipelineItems.md): Link two unarchived deals on your org's own pipelines; both list it (getDeal linkedItems). - [unlinkPipelineItems](https://goliathdata.com/developers/reference/deals/unlinkPipelineItems.md): Remove a deal link (getDeal linkedItems id). - [getDealPipelineLayout](https://goliathdata.com/developers/reference/deals/getDealPipelineLayout.md): One pipeline's field layout: each custom field with its display order, showOnCard and cardDisplayOrder (the up-to-5 fields the board card shows), and hiddenDetailFieldKeys (what the deal sheet and... - [addDealCustomFieldOption](https://goliathdata.com/developers/reference/deals/addDealCustomFieldOption.md): Append ONE option to a DROPDOWN deal custom field (id from listDealCustomFields). - [reorderDealCustomFields](https://goliathdata.com/developers/reference/deals/reorderDealCustomFields.md): Set the display order of one pipeline's custom fields: pass every field id of that pipeline (listDealCustomFields), first = top. - [deleteDealCustomField](https://goliathdata.com/developers/reference/deals/deleteDealCustomField.md): Permanently delete a deal custom-field DEFINITION (id from listDealCustomFields). - [setDealCardFields](https://goliathdata.com/developers/reference/deals/setDealCardFields.md): Choose the fields every deal card on one pipeline's board shows: at most 5 field ids of that pipeline, built-ins included, in order. - [setDealDetailHiddenFields](https://goliathdata.com/developers/reference/deals/setDealDetailHiddenFields.md): Hide fields from one pipeline's deal sheet and create/edit form, for everyone: hiddenFieldKeys REPLACES the hidden set (getDealPipelineLayout first; an empty list shows everything). - [getDealDetailTabs](https://goliathdata.com/developers/reference/deals/getDealDetailTabs.md): One pipeline's deal-sheet tabs: each tab's name and its fields in order (native: or custom:), with the layout version. - [setDealDetailTabs](https://goliathdata.com/developers/reference/deals/setDealDetailTabs.md): Replace one pipeline's deal-sheet tabs for everyone (getDealDetailTabs first, and pass its version as expectedVersion: a stale one is refused). - [updateDealExternalLink](https://goliathdata.com/developers/reference/deals/updateDealExternalLink.md): Change a deal link's title or url (linkId from getDeal's externalLinks); an omitted one is kept. ### Properties - [getProperty](https://goliathdata.com/developers/reference/properties/getProperty.md): Fetch one property by id: address, skip-trace status, signal recency, owner of record and mailing address (metadata, as the page shows them), and visible tags and lists (each { id, name,... - [getPropertySignals](https://goliathdata.com/developers/reference/properties/getPropertySignals.md): A property's filings (newest 50), notice text in adBody. - [getPropertyOwners](https://goliathdata.com/developers/reference/properties/getPropertyOwners.md): A property's people. crmContacts: your own contacts at it (linked, or at its street and ZIP), with relation (OWNS or null = owner; FORMER_OWNER, MAILING and the rest are not) and the phones and... - [findProperties](https://goliathdata.com/developers/reference/properties/findProperties.md): Search properties by (partial) address. - [listPropertyFilters](https://goliathdata.com/developers/reference/properties/listPropertyFilters.md): List the saved property filters VISIBLE to the key owner; run one by id with filterProperties (the tree stays server-side: getFilter reads it). - [listFilterFolders](https://goliathdata.com/developers/reference/properties/listFilterFolders.md): Saved-filter folders of one type (PROPERTY, CONTACT, DEAL), empty ones included: the org's shared ones plus your private ones. - [filterProperties](https://goliathdata.com/developers/reference/properties/filterProperties.md): Run a property filter and paginate the matches with limit/offset. - [countPropertySignals](https://goliathdata.com/developers/reference/properties/countPropertySignals.md): Count PUBLIC-RECORD SIGNAL EVENTS in an area, by type and publication-day window. - [searchPropertyTags](https://goliathdata.com/developers/reference/properties/searchPropertyTags.md): Search your organization's property tags and lists by name. - [findPropertiesByParcel](https://goliathdata.com/developers/reference/properties/findPropertiesByParcel.md): Search properties by (partial) parcel id. - [findPropertiesByMlsId](https://goliathdata.com/developers/reference/properties/findPropertiesByMlsId.md): Search properties by (partial) MLS id. - [findPropertiesNearPoint](https://goliathdata.com/developers/reference/properties/findPropertiesNearPoint.md): Properties within ~150 m of a point, the parcel it is on first: candidates, not one answer (match a house number). - [getRelatedProperties](https://goliathdata.com/developers/reference/properties/getRelatedProperties.md): Batch property attributes by id (esId): owner of record and mailing address, beds/baths/size, year built, last sale, value, occupancy, county, lat/long, years owned, ownerPortfolioSize (parcels... - [getZoningCodes](https://goliathdata.com/developers/reference/properties/getZoningCodes.md): List the zoning codes available for a location (by state + city id or county FIPS). - [searchCounties](https://goliathdata.com/developers/reference/properties/searchCounties.md): Find US counties by (partial) name and return each match's name, fullName, state and fips. - [searchCities](https://goliathdata.com/developers/reference/properties/searchCities.md): Find US cities by (partial) name and return each match's id, name and state. - [listFilterFieldNames](https://goliathdata.com/developers/reference/properties/listFilterFieldNames.md): The COMPLETE vocabulary of filterable fields for a domain (CONTACT, PROPERTY or DEAL): every fieldId saveFilter accepts, with label, category and UI component. - [listFilterFields](https://goliathdata.com/developers/reference/properties/listFilterFields.md): The filterable-field catalog for a filter domain WITH full value shapes: how to WRITE a condition once you know which field you want (CONTACT, PROPERTY or DEAL; other FilterType values are rejected). - [getFilter](https://goliathdata.com/developers/reference/properties/getFilter.md): Fetch ONE saved filter by id, including its full root criteria tree: the only operation that returns the tree (listPropertyFilters / listContactFilters / listDealFilters return metadata only). - [addPropertyTags](https://goliathdata.com/developers/reference/properties/addPropertyTags.md): Add existing tag(s) (by tag id) to a property. - [removePropertyTag](https://goliathdata.com/developers/reference/properties/removePropertyTag.md): Remove one tag (by tag id) from a property. - [createPropertyList](https://goliathdata.com/developers/reference/properties/createPropertyList.md): Get or create an org-wide PROPERTY list by exact name (synchronous). - [addPropertiesToList](https://goliathdata.com/developers/reference/properties/addPropertiesToList.md): Add properties to one or more lists (list ids from searchPropertyTags). - [removePropertiesFromList](https://goliathdata.com/developers/reference/properties/removePropertiesFromList.md): Remove properties from ONE list (listId from searchPropertyTags or getProperty's lists). - [saveFilter](https://goliathdata.com/developers/reference/properties/saveFilter.md): Create a saved filter. type CONTACT runs with filterContacts, PROPERTY with filterProperties, DEAL (status, title, pipeline stage, assignees, deal custom fields) with filterDeals: find deal... - [updateFilter](https://goliathdata.com/developers/reference/properties/updateFilter.md): Edit a saved filter IN PLACE by id (property, contact or deal): its criteria, name, description, folder or visibility. - [createFilterFolder](https://goliathdata.com/developers/reference/properties/createFilterFolder.md): Create a saved-filter folder (returns id). scope is the filters' type (PROPERTY, CONTACT, DEAL); personal: true makes it private, else it and filters filed in it are shared; with parentId it takes... - [renameFilterFolder](https://goliathdata.com/developers/reference/properties/renameFilterFolder.md): Rename a filter folder (listFilterFolders id); onto a sibling’s name it MERGES into it. - [deleteFilterFolder](https://goliathdata.com/developers/reference/properties/deleteFilterFolder.md): Delete a filter folder (listFilterFolders id); its contents move up a level. - [listFolders](https://goliathdata.com/developers/reference/properties/listFolders.md): Every folder on one surface (scope: PROPERTY, CONTACT, DEAL, FORM, …), flat: the org's shared tree plus your personal one. ownerUserId set = personal. itemCount counts items filed directly in it. - [renameFolder](https://goliathdata.com/developers/reference/properties/renameFolder.md): Rename a folder by id (listFolders); a name a sibling already has is refused. - [moveFolder](https://goliathdata.com/developers/reference/properties/moveFolder.md): Put a folder under another folder of the same surface (parentId), or at the top level (parentId: null). - [reorderFolders](https://goliathdata.com/developers/reference/properties/reorderFolders.md): Set the order of one set of sibling folders: scope, their parentId (null = top level), personal (which side), and orderedIds first to last. - [deleteFolder](https://goliathdata.com/developers/reference/properties/deleteFolder.md): Delete a folder by id (listFolders). - [moveItemsToFolder](https://goliathdata.com/developers/reference/properties/moveItemsToFolder.md): File items into a folder (folderId), or to the top level (folderId: null). items are { kind, id }; kind is FILTER, CONTACT_LIST, PROPERTY_LIST, FORM, TEMPLATE, LIBRARY_FILE or WORKFLOW_GROUP. - [reorderFolderItems](https://goliathdata.com/developers/reference/properties/reorderFolderItems.md): Set the display order of items inside one folder: orderedItems ({ kind, id }) first to last. - [reorderFilters](https://goliathdata.com/developers/reference/properties/reorderFilters.md): Set the display order of saved filters: filterIds first to last (listPropertyFilters / listContactFilters / listDealFilters ids). - [deleteFilter](https://goliathdata.com/developers/reference/properties/deleteFilter.md): PERMANENTLY delete a saved filter by id (any type): no archive, no undo. - [skipTraceProperty](https://goliathdata.com/developers/reference/properties/skipTraceProperty.md): Skip-trace a property (by id/esId) to discover its owner and their phone numbers/emails. - [manualSkiptrace](https://goliathdata.com/developers/reference/properties/manualSkiptrace.md): Skip-trace an explicitly-provided owner + mailing address (no property record needed). - [listMyCoverageRequests](https://goliathdata.com/developers/reference/properties/listMyCoverageRequests.md): The org's coverage requests: signal family and county (countyFips), when asked, status, expectedBy (the promise) and liveSince. - [requestCoverage](https://goliathdata.com/developers/reference/properties/requestCoverage.md): Ask for coverage of places ("Cook County, IL"; a county keys to its cell, anything else comes back in gaps) for signals by name (signals, always sent: [] when asking by family), or families picked... - [requestSignalsInMyCounties](https://goliathdata.com/developers/reference/properties/requestSignalsInMyCounties.md): Ask for signal types that are not live yet in every county the org works, as a builder's "Request it" does; the 2-week promise starts now. context names what was being built (workflowGroup:,... - [cancelCoverageRequest](https://goliathdata.com/developers/reference/properties/cancelCoverageRequest.md): Withdraw the org's request for one family in one county (countyFips): the request is deleted, and asking again starts a new one. - [runPropertyComparables](https://goliathdata.com/developers/reference/properties/runPropertyComparables.md): Comparable sales for a property (its id from a property read), as the property page's Comps tab: each comp's facts, distance and price per square foot, and the medians with the subject's implied... ### Workflows - [listWorkflows](https://goliathdata.com/developers/reference/workflows/listWorkflows.md): List the organization's workflow automations (paginated, non-archived by default). - [getWorkflow](https://goliathdata.com/developers/reference/workflows/getWorkflow.md): Fetch one workflow automation by group id: status, versions (a workflow is a stable group holding versioned definitions), the live version, the pending draft and draft validation. channels reads... - [getWorkflowVersionGraph](https://goliathdata.com/developers/reference/workflows/getWorkflowVersionGraph.md): Fetch one workflow VERSION by workflowAutomationId (from getWorkflow.versions/currentVersion/pendingDraft) with its full node/edge graph: the superjson-serialized WorkflowGraph updateWorkflowGraph... - [listWorkflowRuns](https://goliathdata.com/developers/reference/workflows/listWorkflowRuns.md): List runs of one workflow version (by workflowAutomationId), optionally by run status (PENDING | RUNNING | COMPLETED | PAUSED | STOPPED | FAILED | NOT_ENROLLED). - [getContentTemplate](https://goliathdata.com/developers/reference/workflows/getContentTemplate.md): Fetch one reusable template by id: name, type (EMAIL | SMS | NOTE | TASK), body, and folder. - [listContentTemplates](https://goliathdata.com/developers/reference/workflows/listContentTemplates.md): List the organization's reusable templates, optionally filtered by type (EMAIL | SMS | NOTE | TASK) or folderId. - [listContentTemplateFolders](https://goliathdata.com/developers/reference/workflows/listContentTemplateFolders.md): List the organization's shared content-library folders (id, name, parentFolderId, displayOrder) with per-kind template counts and a file count. - [listLibraryFiles](https://goliathdata.com/developers/reference/workflows/listLibraryFiles.md): List the content library's files (Automations → Templates → Files): id, name, description, folderId, contentType. - [listEventWorkflowPayloadSamples](https://goliathdata.com/developers/reference/workflows/listEventWorkflowPayloadSamples.md): The example payloads an EVENT workflow has received or been given (what its sender POSTs), to map trigger fields from. - [listWorkflowGraphRevisions](https://goliathdata.com/developers/reference/workflows/listWorkflowGraphRevisions.md): A workflow's save history, newest first: when, who (source HUMAN, AGENT or SYSTEM; actorName; agentRunId for an agent's save), the version it wrote, and diff: what changed against the save before... - [listWorkflowTables](https://goliathdata.com/developers/reference/workflows/listWorkflowTables.md): The organization's Workflow Tables (not archived), by name: each table's key (what rows are matched on: keyKind, e.g. COUNTY_FIPS, STATE, ZIP, FIELD_PATH, and its fallback levels in keyShape), its... - [getWorkflowTable](https://goliathdata.com/developers/reference/workflows/getWorkflowTable.md): One Workflow Table with its rows, paged by rowLimit (default 100, at most 500) and rowOffset: keep reading while a page comes back full (rowCount excludes the DEFAULT row, which pages like any... - [listWorkflowTableChanges](https://goliathdata.com/developers/reference/workflows/listWorkflowTableChanges.md): A Workflow Table's change history, newest first: who saved what and when, how many columns and rows changed. rowId narrows it to one row. - [previewWorkflowTableLookup](https://goliathdata.com/developers/reference/workflows/previewWorkflowTableLookup.md): Call this before you say which row, or which value, a named contact, property, deal or appointment gets from a table: a county or key guessed from an address is not the answer. - [listWorkflowFolders](https://goliathdata.com/developers/reference/workflows/listWorkflowFolders.md): List the organization's shared workflow-folder tree (id, name, parentFolderId, displayOrder, itemCount). - [getWorkflowStats](https://goliathdata.com/developers/reference/workflows/getWorkflowStats.md): Performance summary for one workflow (by group id), lifetime, dry runs excluded: run counts by outcome (active/completed/paused/stopped/failed), messages sent, reply rate with its... - [getWorkflowVersionStats](https://goliathdata.com/developers/reference/workflows/getWorkflowVersionStats.md): Performance summary for one VERSION (by workflowAutomationId, from getWorkflow.versions), the shape of getWorkflowStats: compare a new version against the one it replaced. - [listWorkflowPerformance](https://goliathdata.com/developers/reference/workflows/listWorkflowPerformance.md): Scoreboard: the org's workflows (paginated, non-archived) each with headline stats: total/active/completed runs, reply rate, and last-run time. - [getWorkflowThrottleUsage](https://goliathdata.com/developers/reference/workflows/getWorkflowThrottleUsage.md): Daily send-limit usage for a throttle-backed workflow (by group id): usedToday vs dailyCap and a per-day history over the last rangeDays (1-90, clamped). - [createWorkflow](https://goliathdata.com/developers/reference/workflows/createWorkflow.md): Create a workflow automation: a new group plus its initial DRAFT version. workflowDomain is CONTACT | DEAL | PROPERTY | APPOINTMENT | EVENT. - [createOrReturnWorkflowDraft](https://goliathdata.com/developers/reference/workflows/createOrReturnWorkflowDraft.md): Idempotent "edit": return the existing DRAFT version under this workflow, or clone the live (or most recently paused) version into a fresh DRAFT. - [patchWorkflowGraph](https://goliathdata.com/developers/reference/workflows/patchWorkflowGraph.md): Edit a workflow version's graph by sending ONLY THE CHANGE (updateWorkflowGraph writes a whole new graph). - [updateWorkflowGraph](https://goliathdata.com/developers/reference/workflows/updateWorkflowGraph.md): Replace a workflow version's node/edge graph AND its triggers (to edit, patchWorkflowGraph). - [renameWorkflow](https://goliathdata.com/developers/reference/workflows/renameWorkflow.md): Rename a workflow version (by workflowAutomationId) and optionally update its description. - [promoteWorkflowDraft](https://goliathdata.com/developers/reference/workflows/promoteWorkflowDraft.md): Ship it: promote the workflow's current DRAFT to ACTIVE (live). - [discardWorkflowDraft](https://goliathdata.com/developers/reference/workflows/discardWorkflowDraft.md): Discard the workflow's current DRAFT version, if any. - [pauseWorkflow](https://goliathdata.com/developers/reference/workflows/pauseWorkflow.md): Pause the ACTIVE version of a workflow: no new runs will start. pauseInFlightRuns=true also pauses runs already in flight; false lets them finish. - [updateWorkflowSendWindow](https://goliathdata.com/developers/reference/workflows/updateWorkflowSendWindow.md): Set the workflow's SENDING SCHEDULE, the hours its messages may go out. - [resumeWorkflow](https://goliathdata.com/developers/reference/workflows/resumeWorkflow.md): Resume the most-recently-paused version of a workflow, and wake the runs the workflow pause parked (getWorkflow.runsPausedWithWorkflow counts them): each continues at the step it had reached, and... - [duplicateWorkflow](https://goliathdata.com/developers/reference/workflows/duplicateWorkflow.md): Duplicate a workflow into a fresh group with the given name, as a paused/draft copy that never starts by itself. - [deleteWorkflow](https://goliathdata.com/developers/reference/workflows/deleteWorkflow.md): Delete a workflow (the UI's "Delete"): archives the group, pauses any active version and PERMANENTLY stops its in-flight runs; everyone mid-sequence drops out and restoring the workflow does not... - [restoreWorkflow](https://goliathdata.com/developers/reference/workflows/restoreWorkflow.md): Undo deleteWorkflow: bring a deleted (archived) workflow back to the list, by group id, to edit again. - [triggerWorkflowRun](https://goliathdata.com/developers/reference/workflows/triggerWorkflowRun.md): Manually start one run of a workflow's ACTIVE version against a record. recordId must match the workflow's domain: a contactId for CONTACT workflows, propertyId for PROPERTY, dealId for DEAL,... - [enrollInWorkflow](https://goliathdata.com/developers/reference/workflows/enrollInWorkflow.md): Enroll MANY contacts in one CONTACT workflow's ACTIVE version: the app's bulk "Add to workflow" on the Contacts table. - [pauseWorkflowRun](https://goliathdata.com/developers/reference/workflows/pauseWorkflowRun.md): Pause one in-flight run (PENDING or RUNNING → PAUSED). - [resumeWorkflowRun](https://goliathdata.com/developers/reference/workflows/resumeWorkflowRun.md): Resume one paused run (PAUSED → PENDING) and kick its executor. - [stopWorkflowRun](https://goliathdata.com/developers/reference/workflows/stopWorkflowRun.md): Permanently stop one run: PENDING, RUNNING or PAUSED (terminal: a stopped run cannot be resumed). - [resumeWorkflowVersion](https://goliathdata.com/developers/reference/workflows/resumeWorkflowVersion.md): Resume a specific PAUSED version (by workflowAutomationId), pausing the active sibling first. - [bulkPauseWorkflowRuns](https://goliathdata.com/developers/reference/workflows/bulkPauseWorkflowRuns.md): Pause many runs at once by explicit id (cap 500). - [bulkResumeWorkflowRuns](https://goliathdata.com/developers/reference/workflows/bulkResumeWorkflowRuns.md): Resume many paused runs at once by explicit id (cap 500). - [restoreWorkflowVersionAsDraft](https://goliathdata.com/developers/reference/workflows/restoreWorkflowVersionAsDraft.md): Roll back: copy an OLDER version (workflowAutomationId from getWorkflow.versions) into the DRAFT, then publish it with promoteWorkflowDraft. - [rewriteWorkflowDraftTextStep](https://goliathdata.com/developers/reference/workflows/rewriteWorkflowDraftTextStep.md): The publish dialog's "Rewrite for me": reword one DRAFT text step to lower its carrier-filter risk, saved on the draft. - [addLibraryFileFromArtifact](https://goliathdata.com/developers/reference/workflows/addLibraryFileFromArtifact.md): Add a file the person attached (or you made) to the content library by its artifactId, under a name, with an optional description and folderId (listContentTemplateFolders). - [updateLibraryFile](https://goliathdata.com/developers/reference/workflows/updateLibraryFile.md): Rename a library file or change its description (fileId from listLibraryFiles); description null clears it. - [moveLibraryFile](https://goliathdata.com/developers/reference/workflows/moveLibraryFile.md): File a library file into a folder (listContentTemplateFolders), or folderId null for the root. - [deleteLibraryFile](https://goliathdata.com/developers/reference/workflows/deleteLibraryFile.md): Take a file out of the library for good (its name and description go). - [recordEventWorkflowPayloadSample](https://goliathdata.com/developers/reference/workflows/recordEventWorkflowPayloadSample.md): Save an example payload (a JSON object, what the sender would POST) on an EVENT workflow, so its fields can be mapped before anything arrives. - [deleteEventWorkflowPayloadSample](https://goliathdata.com/developers/reference/workflows/deleteEventWorkflowPayloadSample.md): Delete one pasted example payload for good (sampleId from listEventWorkflowPayloadSamples). - [updateWorkflowPriority](https://goliathdata.com/developers/reference/workflows/updateWorkflowPriority.md): Set a workflow's priority, which orders its runs and sends against the org's other workflows (higher wins): 1.25 Low, 1.5 Normal (the default), 1.75 High; any other value is refused. - [resumeRunsPausedWithWorkflow](https://goliathdata.com/developers/reference/workflows/resumeRunsPausedWithWorkflow.md): Wake the runs a workflow pause left parked (getWorkflow runsPausedWithWorkflow) on a workflow that is live again; each restarts at the step it reached and its messages go out. - [moveAndResumeParkedRuns](https://goliathdata.com/developers/reference/workflows/moveAndResumeParkedRuns.md): Restart the runs a publish paused on a workflow (getWorkflow runsParkedByPublish; mostly publishes before 2026-10-23, which paused everyone in flight): moves up to limit (at most 200) of them onto... - [previewWorkflowAiText](https://goliathdata.com/developers/reference/workflows/previewWorkflowAiText.md): Preview what an AI text step with this systemPrompt would write to 1 to 5 contacts, through the real generation path. - [createContentTemplate](https://goliathdata.com/developers/reference/workflows/createContentTemplate.md): Create a reusable template. type is EMAIL | SMS | NOTE | TASK | TASK_SET. - [applyTaskTemplate](https://goliathdata.com/developers/reference/workflows/applyTaskTemplate.md): Run a TASK template against a contact: creates one task, assigned to the acting user, linked to the contact (and any dealIds). - [applyTaskSet](https://goliathdata.com/developers/reference/workflows/applyTaskSet.md): Run a whole TASK_SET against a contact: creates every step as a task in one call, all assigned to the acting user and linked to the contact (and any dealIds). - [updateContentTemplate](https://goliathdata.com/developers/reference/workflows/updateContentTemplate.md): Update a template by id (name, body, subject). - [deleteContentTemplate](https://goliathdata.com/developers/reference/workflows/deleteContentTemplate.md): Delete a template by id; returns the remaining templates. - [moveContentTemplateToFolder](https://goliathdata.com/developers/reference/workflows/moveContentTemplateToFolder.md): Move a template into a folder by id. - [createContentTemplateFolder](https://goliathdata.com/developers/reference/workflows/createContentTemplateFolder.md): Create a template folder. - [renameContentTemplateFolder](https://goliathdata.com/developers/reference/workflows/renameContentTemplateFolder.md): Rename a template folder by id. - [moveContentTemplateFolder](https://goliathdata.com/developers/reference/workflows/moveContentTemplateFolder.md): Move a template folder under another, or pass parentFolderId null for the root. - [deleteContentTemplateFolder](https://goliathdata.com/developers/reference/workflows/deleteContentTemplateFolder.md): Delete a template folder by id. - [saveWorkflowTable](https://goliathdata.com/developers/reference/workflows/saveWorkflowTable.md): Create a Workflow Table (workflowTableId omitted) or replace an existing one's name, description and columns. - [saveWorkflowTableRows](https://goliathdata.com/developers/reference/workflows/saveWorkflowTableRows.md): Create or replace rows (rows: a row is replaced WHOLE, never merged) and delete rows (deleteRowIds) of one table in a single write; a deleted row or a replaced cell is gone for good, so this needs... - [deleteWorkflowTable](https://goliathdata.com/developers/reference/workflows/deleteWorkflowTable.md): Archive a Workflow Table. - [createWorkflowFolder](https://goliathdata.com/developers/reference/workflows/createWorkflowFolder.md): Create an empty workflow folder, optionally nested under parentFolderId, and return its id. - [moveWorkflowToFolder](https://goliathdata.com/developers/reference/workflows/moveWorkflowToFolder.md): Move a workflow into a folder by folderId (from listWorkflowFolders), or folderId null to ungroup it. - [moveWorkflowFolder](https://goliathdata.com/developers/reference/workflows/moveWorkflowFolder.md): Move a workflow folder under another folder, or pass parentFolderId null to move it to the root. - [renameWorkflowFolder](https://goliathdata.com/developers/reference/workflows/renameWorkflowFolder.md): Rename a workflow folder by folderId. - [deleteWorkflowFolder](https://goliathdata.com/developers/reference/workflows/deleteWorkflowFolder.md): Delete a workflow folder by folderId. - [reorderWorkflowFolders](https://goliathdata.com/developers/reference/workflows/reorderWorkflowFolders.md): Persist the display order for one sibling set. - [setSkipTraceDailyCap](https://goliathdata.com/developers/reference/workflows/setSkipTraceDailyCap.md): Set the ORGANIZATION's daily cap on property-signal skip-trace workflow runs: the dailyCap getWorkflowThrottleUsage reports, shared by every PROPERTY_SIGNAL_SKIP_TRACE workflow in the org. ### Communications - [listCommunicationChannels](https://goliathdata.com/developers/reference/communications/listCommunicationChannels.md): What can I send from? All the organization's phone lines (each with its user and canSendSms) and your mailboxes; your lines have user.id = currentUser.id. "My number" to text from or give a... - [getSendingLimits](https://goliathdata.com/developers/reference/communications/getSendingLimits.md): How much can we text and email today? Per line, brand (team) and mailbox: used / cap / remaining today (text segments; null cap = no limit; a mailbox also meters recipients, and the tighter of its... - [getMeetingTranscript](https://goliathdata.com/developers/reference/communications/getMeetingTranscript.md): The full speaker-by-speaker transcript behind a meeting-summary note, as a PAGEABLE window of ordered { speaker, text } utterances. - [listMeetingSummaries](https://goliathdata.com/developers/reference/communications/listMeetingSummaries.md): The organization's notetaker calls created after after, in any status, oldest first: each call's status (COMPLETED and FAILED are terminal), summary note id and text (null when the key owner may... - [renderContentTemplate](https://goliathdata.com/developers/reference/communications/renderContentTemplate.md): Render a content template against a contact: collapse [a|b] spintax and substitute merge fields: the CONTACT vocabulary updateWorkflowGraph lists ({{firstName}}, {{contactPropertyAddress}},... - [getSendConsentAttestation](https://goliathdata.com/developers/reference/communications/getSendConsentAttestation.md): Whether the organization's send consent attestation stands: an org admin's one-time statement that every contact the organization texts or emails through the developer API consented. - [getTextingRegistrationStatus](https://goliathdata.com/developers/reference/communications/getTextingRegistrationStatus.md): The organization's A2P 10DLC texting registration, STATUS ONLY: each brand (status, statusLabel, useCaseLabel) and its sending campaigns (sendReady true = approved and able to text;... - [sendText](https://goliathdata.com/developers/reference/communications/sendText.md): Send an SMS to a phone number (E.164, e.g. +13235550100; an unparseable number is rejected up front with INVALID_PHONE_NUMBER) as the key owner. - [sendEmail](https://goliathdata.com/developers/reference/communications/sendEmail.md): Send an email as the key owner through their connected Gmail/Outlook mailbox. - [clearChannelSuppression](https://goliathdata.com/developers/reference/communications/clearChannelSuppression.md): Lift an organization-wide opt-out (suppressChannel's undo): the value can be texted, called or emailed again on that medium, on every contact carrying it. - [clearContactDoNotContact](https://goliathdata.com/developers/reference/communications/clearContactDoNotContact.md): Take one contact off Do Not Contact, as the contact page's toggle does, so texts, calls, emails and workflows reach them again. - [suppressChannel](https://goliathdata.com/developers/reference/communications/suppressChannel.md): Value-level opt-out: block a phone number or email address for your organization on one medium (SMS, VOICE or EMAIL). - [setSendConsentAttestation](https://goliathdata.com/developers/reference/communications/setSendConsentAttestation.md): Attest (attested: true) or withdraw (false) the organization's send consent: the org admin who owns this key states, once for the whole organization, that every contact it texts or emails through... - [getCallWorkspaceSettings](https://goliathdata.com/developers/reference/communications/getCallWorkspaceSettings.md): The dialer's settings (Settings → Calls): auto-advance, the after-call actions in order, callCardFieldIds (contact custom fields shown on the call card) and callerIdTableColumnId; plus a person's... - [updateCallOutcome](https://goliathdata.com/developers/reference/communications/updateCallOutcome.md): Record or correct a call's outcome (disposition) and its note (at most 280 characters), as the dialer's outcome gate does. - [renameVoicemailTemplate](https://goliathdata.com/developers/reference/communications/renameVoicemailTemplate.md): Rename a voicemail drop (templateId from getCallWorkspaceSettings). - [reorderVoicemailTemplates](https://goliathdata.com/developers/reference/communications/reorderVoicemailTemplates.md): Set the order of a person's voicemail drops: items are { id, displayOrder } for that userId. - [deleteVoicemailTemplate](https://goliathdata.com/developers/reference/communications/deleteVoicemailTemplate.md): Delete a voicemail drop. - [setCallerIdTableColumn](https://goliathdata.com/developers/reference/communications/setCallerIdTableColumn.md): Set the PHONE_LINE Workflow Table column the dialer reads each contact's outbound caller ID from (listWorkflowTables), or null to stop. - [reorderAfterCallActions](https://goliathdata.com/developers/reference/communications/reorderAfterCallActions.md): Order the after-call actions the dialer offers: items list every kind once with its displayOrder. - [setCallCardFields](https://goliathdata.com/developers/reference/communications/setCallCardFields.md): Replace the contact custom fields shown on the call card (at most 8, in order). ### Conversations - [listInboxThreads](https://goliathdata.com/developers/reference/conversations/listInboxThreads.md): The inbox: text conversations, calls and email threads in ONE most-recent-first feed, the read for questions that name no contact ("did they text back", "what is unread"; listContactActivities... - [getTextThreadMessages](https://goliathdata.com/developers/reference/conversations/getTextThreadMessages.md): The messages of ONE text conversation, with full bodies, newest first by default. - [listContactTextThreads](https://goliathdata.com/developers/reference/conversations/listContactTextThreads.md): Every text thread ONE contact has, across the org lines the key owner may see. - [getEmailThread](https://goliathdata.com/developers/reference/conversations/getEmailThread.md): Every message in one email thread, with full plain-text bodies, OLDEST FIRST (ordered by internalDate ascending): so the latest reply is the LAST element, not the first. - [getCallRecording](https://goliathdata.com/developers/reference/conversations/getCallRecording.md): One call's RECORDING and TRANSCRIPT, plus the outcome logged for it: a time-limited signed audio URL (recordingUrl), the speaker-by-speaker transcript ({ speaker, text, start, end }), the AI... - [markInboxThreadsRead](https://goliathdata.com/developers/reference/conversations/markInboxThreadsRead.md): Mark inbox rows READ (isRead: true) or UNREAD (false), the app inbox's read/unread. - [setInboxThreadStarred](https://goliathdata.com/developers/reference/conversations/setInboxThreadStarred.md): Star (starred: true) or unstar a TEXT thread for everyone in the organization, so it shows under the inbox's Starred filter (listInboxThreads starredOnly). textConversationId is a MESSAGE row's id. - [setInboxThreadHandled](https://goliathdata.com/developers/reference/conversations/setInboxThreadHandled.md): Mark a TEXT thread HANDLED, the inbox's "no reply needed": it leaves Needs reply (channel NEEDS_RESPONSE) for everyone in the organization until the contact texts again. textConversationId is a... - [dismissInboxItem](https://goliathdata.com/developers/reference/conversations/dismissInboxItem.md): Dismiss one inbox row, the app inbox's Dismiss: it is hidden from the inbox of the line or mailbox it belongs to, and listInboxThreads no longer returns it. itemId is the row's id and itemType its... ### Phone Numbers - [searchAvailablePhoneNumbers](https://goliathdata.com/developers/reference/phone-numbers/searchAvailablePhoneNumbers.md): Search Twilio for buyable phone numbers, optionally narrowed by areaCode (a 3-digit US area code). - [getVoiceTrustSummary](https://goliathdata.com/developers/reference/phone-numbers/getVoiceTrustSummary.md): One org-wide picture of caller-trust registration: the carrier registration that keeps outbound calls from showing as "Spam Likely". accountState is chosen by loudest call to action, not by... - [getPhoneRouting](https://goliathdata.com/developers/reference/phone-numbers/getPhoneRouting.md): Who answers an inbound call or text: the call routing the Automations Map's Phone calls area shows, and who gets a new contact. orgDefaultRingPolicy is the default every line follows unless it has... - [getPhoneLineRingPolicy](https://goliathdata.com/developers/reference/phone-numbers/getPhoneLineRingPolicy.md): One line's own ring policy (its override of the org default), in getPhoneRouting's shape; null when the line follows the default. phoneLineId from getPhoneRouting or listCommunicationChannels. - [setOrgDefaultRingPolicy](https://goliathdata.com/developers/reference/phone-numbers/setOrgDefaultRingPolicy.md): Replace the org's default call routing (every line without its own): humanStage (targetKind, ringSeconds 5 to 60, its target, an optional schedule) then aiStage (AI employees whose calls are on,... - [setPhoneLineRingPolicy](https://goliathdata.com/developers/reference/phone-numbers/setPhoneLineRingPolicy.md): Replace one line's own call routing, shaped as setOrgDefaultRingPolicy's (read it with getPhoneLineRingPolicy first). policy null deletes it and the line follows the org default. - [provisionPhoneNumber](https://goliathdata.com/developers/reference/phone-numbers/provisionPhoneNumber.md): Buy a phone number from Twilio (a RECURRING monthly charge) and assign it to targetUserId. - [getDialingPool](https://goliathdata.com/developers/reference/phone-numbers/getDialingPool.md): The org's bulk-dialing rotation: each line (id, number, label), its calls today against its daily limit and restUntil, and the day's room. - [getMyDialingRoom](https://goliathdata.com/developers/reference/phone-numbers/getMyDialingRoom.md): Can the key owner start a call list now? null: they have no phone line to call from (an admin assigns them a number). - [addNumbersToDialingPool](https://goliathdata.com/developers/reference/phone-numbers/addNumbersToDialingPool.md): Put numbers the org already owns (listCommunicationChannels) into the dialer's rotation. - [removeNumbersFromDialingPool](https://goliathdata.com/developers/reference/phone-numbers/removeNumbersFromDialingPool.md): Take numbers out of the rotation; they stay owned. - [restDialingPoolNumber](https://goliathdata.com/developers/reference/phone-numbers/restDialingPoolNumber.md): Bench one rotation line for the standard rest window: it returns on its own at restUntil (say the date). - [unrestDialingPoolNumber](https://goliathdata.com/developers/reference/phone-numbers/unrestDialingPoolNumber.md): Return a benched line to the rotation now, whoever benched it. - [setPhoneLineLabel](https://goliathdata.com/developers/reference/phone-numbers/setPhoneLineLabel.md): Name a phone line ("Facebook campaign"), or label null to clear it. - [setPhoneLineRunsOnMetaAds](https://goliathdata.com/developers/reference/phone-numbers/setPhoneLineRunsOnMetaAds.md): Mark a tracking number as one the org runs only on Meta ads (its calls are attributed there), or false to clear it. - [buyDialingPoolNumbers](https://goliathdata.com/developers/reference/phone-numbers/buyDialingPoolNumbers.md): Buy phone numbers straight into the bulk-dialing rotation: each is a RECURRING monthly charge. ### Notifications - [listNotifications](https://goliathdata.com/developers/reference/notifications/listNotifications.md): List your in-app notifications (the bell feed), newest first. - [getNotificationCounts](https://goliathdata.com/developers/reference/notifications/getNotificationCounts.md): Unread and read counts for your own notification feed (the badge numbers). - [getAvailableNotificationTypes](https://goliathdata.com/developers/reference/notifications/getAvailableNotificationTypes.md): The catalog of notification types you can filter by: each with its notificationType (the exact string to pass as notificationTypeFilter on listNotifications / getNotificationCounts), a human... - [markNotificationsRead](https://goliathdata.com/developers/reference/notifications/markNotificationsRead.md): Mark specific notifications read or unread by id. - [setEmailDigestCadence](https://goliathdata.com/developers/reference/notifications/setEmailDigestCadence.md): When your notification emails go out: AS_IT_HAPPENS (one email a few minutes after a notification) or DAILY (one email each morning at 8am in your timezone; AI hand-offs and workflow pages still... - [markAllNotificationsRead](https://goliathdata.com/developers/reference/notifications/markAllNotificationsRead.md): Mark your WHOLE notification feed read (isSeen: true) or unread (false). userId must be your own (getMyProfile currentUser.id); any other is refused. - [markContactNotificationsRead](https://goliathdata.com/developers/reference/notifications/markContactNotificationsRead.md): Mark every one of your notifications about one contact read. - [deleteNotifications](https://goliathdata.com/developers/reference/notifications/deleteNotifications.md): Delete notifications from your feed for good, by id (listNotifications). - [skipOnToday](https://goliathdata.com/developers/reference/notifications/skipOnToday.md): "Not now": the row leaves the key owner's Today until their next local day, or sooner when something newer happens (anchorAt: when the row's event happened). subjectGrn is _ of what the... - [clearOnToday](https://goliathdata.com/developers/reference/notifications/clearOnToday.md): "Dealt with": the row leaves the key owner's Today until something newer than anchorAt happens to it. subjectGrn is _ of what the row is about (TextConversation, EmailThread, Deal,... - [hideOnToday](https://goliathdata.com/developers/reference/notifications/hideOnToday.md): "Don't show this again" on the key owner's Today, until unhideOnToday. subjectGrn is _ of what the row is about (TextConversation, EmailThread, Deal, Call, Task); kind is TODAY. - [markWrongOnToday](https://goliathdata.com/developers/reference/notifications/markWrongOnToday.md): "This is wrong": a hide with the person's reason and an optional note (at most 280 characters). subjectGrn is _ of what the row is about (TextConversation, EmailThread, Deal, Call,... - [unhideOnToday](https://goliathdata.com/developers/reference/notifications/unhideOnToday.md): Show a row again: undoes a skip, hide or "this is wrong". subjectGrn is _ of what the row is about (TextConversation, EmailThread, Deal, Call, Task); kind is TODAY. - [hideTaskSourceOnToday](https://goliathdata.com/developers/reference/notifications/hideTaskSourceOnToday.md): Hide from the key owner's Today every task one workflow (WorkflowGroup_) or AI employee (Agent_) made. - [listCatchUpCards](https://goliathdata.com/developers/reference/notifications/listCatchUpCards.md): The key owner's Catch up deck, ranked as the app deals it: each card's id, kind, the sentence it asks (ask, else title), its rows (bundleRows, each defaultChecked) and suggestionIds. nextCursor... - [decideCatchUpCard](https://goliathdata.com/developers/reference/notifications/decideCatchUpCard.md): Decide one HARVEST or BUNDLE card (family; the others are answered through their own operations) as the decision bar does, on the person's word: verb ACCEPT or DISMISS, shownIds every row the card... - [undoCatchUpDecision](https://goliathdata.com/developers/reference/notifications/undoCatchUpDecision.md): Take back a decideCatchUpCard: the same cardId and verb, suggestionIds the rows it decided (its ticked rows less remainingIds), and for an ACCEPT setAsideIds its unticked shownIds (only rows it... ### Forms - [listForms](https://goliathdata.com/developers/reference/forms/listForms.md): The org's lead-capture forms (embed forms): name, slug, status (DRAFT | ACTIVE | INACTIVE), lifetime submissions, public URL, folderId. - [getForm](https://goliathdata.com/developers/reference/forms/getForm.md): Fetch one lead-capture form by id - full configuration including fieldConfig (the page-and-field document: either a flat array of fields for a single-page form, or a { fields, steps,... - [listFormSubmissions](https://goliathdata.com/developers/reference/forms/listFormSubmissions.md): List form submissions (leads), newest first, optionally filtered to one form via formId. - [getFormSubmission](https://goliathdata.com/developers/reference/forms/getFormSubmission.md): Fetch one form submission (lead) by id - its submitted field values (submittedData) and the linked CRM contactId. - [getFormAnalytics](https://goliathdata.com/developers/reference/forms/getFormAnalytics.md): Conversion funnel for one form over a date range - views, starts, submits, the start/submit/submit-of-started rates (0-1 fractions), median seconds-to-submit, plus a per-day time series. startDate... - [getFormTrafficSources](https://goliathdata.com/developers/reference/forms/getFormTrafficSources.md): Where a form's traffic and submissions come from - breakdowns by traffic source, device class, and location, each with views, submits, and the submit rate. - [listFormActivity](https://goliathdata.com/developers/reference/forms/listFormActivity.md): Recent per-session activity for one form, newest first, cursor-paginated via after. - [getFormActiveTime](https://goliathdata.com/developers/reference/forms/getFormActiveTime.md): Daily active-engagement time on one form over a date range - per day: session count and active-millisecond percentiles (p50/p90), split by submitted vs abandoned sessions. startDate and endDate... - [listFormActivityLocations](https://goliathdata.com/developers/reference/forms/listFormActivityLocations.md): Approximate geo coordinates of recent sessions for one form, for plotting a lead map. - [getFormRoutingDistribution](https://goliathdata.com/developers/reference/forms/getFormRoutingDistribution.md): Lead-assignment distribution for one form's round-robin pool - the number of leads routed to each assigned user. userId maps to a teammate from listTeammates. - [createForm](https://goliathdata.com/developers/reference/forms/createForm.md): Create a lead-capture form. - [updateForm](https://goliathdata.com/developers/reference/forms/updateForm.md): Update a lead-capture form by id. - [deleteForm](https://goliathdata.com/developers/reference/forms/deleteForm.md): HARD-DELETE a lead-capture form by id. - [createFormContactLink](https://goliathdata.com/developers/reference/forms/createFormContactLink.md): A link to an ACTIVE form for one contact, opening prefilled with their details; their answers land on their contact. url for an email's link, shortUrl for a text. - [duplicateForm](https://goliathdata.com/developers/reference/forms/duplicateForm.md): Copy a form: its fields, steps and settings, never its submissions or analytics. name defaults to " copy". ### Billing - [getCreditPrices](https://goliathdata.com/developers/reference/billing/getCreditPrices.md): Fixed credit packs for EVERY credit type. - [getCreditsPurchaseUrl](https://goliathdata.com/developers/reference/billing/getCreditsPurchaseUrl.md): The in-app Billing > Credits page URL where a human buys credits. - [getSeatsPurchaseUrl](https://goliathdata.com/developers/reference/billing/getSeatsPurchaseUrl.md): The in-app Billing page URL where a human buys extra seats. - [getPhoneNumbersPurchaseUrl](https://goliathdata.com/developers/reference/billing/getPhoneNumbersPurchaseUrl.md): The in-app Team & Phones page URL where a human registers and buys phone numbers. - [getAddOnPrices](https://goliathdata.com/developers/reference/billing/getAddOnPrices.md): The monthly price of one extra seat, in cents, live from Stripe. - [getAiCreditUsage](https://goliathdata.com/developers/reference/billing/getAiCreditUsage.md): Why the AI employees stopped, and what AI use costs: burn over a trailing window (windowDays 1..90, default 30), balanceCredits, outOfCredits, planAllowance. - [checkBillingAction](https://goliathdata.com/developers/reference/billing/checkBillingAction.md): The check the app runs before a skip trace, export or email verification of count records. - [getPlanCatalog](https://goliathdata.com/developers/reference/billing/getPlanCatalog.md): Every plan on sale: monthly and annual (whole-year) price, and what each includes per month. - [getBillingSummary](https://goliathdata.com/developers/reference/billing/getBillingSummary.md): Read the organization's plan, subscription lifecycle, seat utilization, feature limits and credit balances. - [getCreditUsageByType](https://goliathdata.com/developers/reference/billing/getCreditUsageByType.md): What used the credits this billing period, per credit type: series[].totalUnits for AI_CREDITS, SMS_CREDITS (outbound text segments), CALLING_MINUTES, SKIPTRACE, EMAIL_VERIFICATION and... ### Team - [listTeammates](https://goliathdata.com/developers/reference/team/listTeammates.md): Fuzzy-search ACTIVE teammates by name, email or phone (optional searchTerm; omit it for an alphabetical page). - [listTeamMembers](https://goliathdata.com/developers/reference/team/listTeamMembers.md): List EVERY member of your organization with their membership facts: the roster. - [getTeammatesByIds](https://goliathdata.com/developers/reference/team/getTeammatesByIds.md): Resolve teammate USER IDS to names: pass userIds, get back id, firstName, lastName, email for each. - [countOutboundTexts](https://goliathdata.com/developers/reference/team/countOutboundTexts.md): HOW MANY TEXTS WENT OUT in a time window: one call, exact, live (not a nightly snapshot). - [getTeamCallStats](https://goliathdata.com/developers/reference/team/getTeamCallStats.md): Per-member CALL COUNTS AND TALK TIME in a time window: one call, exact, live (not a nightly snapshot). - [getMemberActivity](https://goliathdata.com/developers/reference/team/getMemberActivity.md): WHAT ONE PERSON DID in a time window ("what did I do today", "how was my week", "what did Sam get done yesterday") in ONE call: their own texts (sent/delivered/failed), calls (outbound, inbound,... - [listTeamInvites](https://goliathdata.com/developers/reference/team/listTeamInvites.md): List the organization's team invitations: pending (isAlive: true) and spent/revoked (isAlive: false), single-use and permanent; acceptUrl is a full link. - [createTeamInvite](https://goliathdata.com/developers/reference/team/createTeamInvite.md): Create a team-member invitation. userType: ADMIN or MEMBER (default MEMBER). - [revokeTeamInvite](https://goliathdata.com/developers/reference/team/revokeTeamInvite.md): Revoke a team invitation by id: the one this chat created, else match it in listTeamInvites. - [resendTeamInvite](https://goliathdata.com/developers/reference/team/resendTeamInvite.md): Re-send a team invitation by id (from listTeamInvites): the same invitation email goes out again to the same address. - [emailPermanentTeamInvite](https://goliathdata.com/developers/reference/team/emailPermanentTeamInvite.md): Email the organization's PERMANENT (reusable) invite link to 1-50 addresses per request; duplicates are sent once. - [changeTeamMemberRole](https://goliathdata.com/developers/reference/team/changeTeamMemberRole.md): Change a teammate's ROLE, the team page's Change Role: ADMIN (every permission, and the role every ADMIN-scoped operation needs; moving to it drops the member's permission settings) or MEMBER... - [removeTeamMember](https://goliathdata.com/developers/reference/team/removeTeamMember.md): Remove a teammate from the team, the team page's Remove from team. - [restoreTeamMember](https://goliathdata.com/developers/reference/team/restoreTeamMember.md): Restore a removed (SUSPENDED) teammate to the team, the team page's Restore to team. - [getTeamMemberCapabilities](https://goliathdata.com/developers/reference/team/getTeamMemberCapabilities.md): A teammate's permissions, as Manage permissions on their row shows them: every capability they HOLD (one missing is one they do not have). userId comes from listTeamMembers. - [grantTeamMemberCapability](https://goliathdata.com/developers/reference/team/grantTeamMemberCapability.md): Turn ONE permission on for a teammate, a switch in Manage permissions on their row. - [revokeTeamMemberCapability](https://goliathdata.com/developers/reference/team/revokeTeamMemberCapability.md): Turn ONE permission off for a teammate, the same switch and the same capabilities as grantTeamMemberCapability, which turns it back on. - [getTeamAnalyticsOverview](https://goliathdata.com/developers/reference/team/getTeamAnalyticsOverview.md): Team performance (SEVEN_DAYS | FOURTEEN_DAYS | THIRTY_DAYS | YEAR_TO_DATE; default THIRTY_DAYS): totals, deltas, per-agent rows. - [getTeamActivityTimeseries](https://goliathdata.com/developers/reference/team/getTeamActivityTimeseries.md): Daily team activity rows for a reporting period (same period values as getTeamAnalyticsOverview): calls, texts, emails, tasks, appointments, active agents, and new leads per day. - [getGoalPlan](https://goliathdata.com/developers/reference/team/getGoalPlan.md): Your goals for the month containing periodStartDate (YYYY-MM-DD): draftPlan (being edited) and activePlan (published), either null. - [createGoalPlan](https://goliathdata.com/developers/reference/team/createGoalPlan.md): Open a DRAFT goal plan for the month containing periodStartDate, seeded with the active plan's commission goals; an existing draft is returned instead. - [upsertCommissionGoal](https://goliathdata.com/developers/reference/team/upsertCommissionGoal.md): Set a commission target on a DRAFT plan: targetCents (> 0, cents), metric EARNED | TOTAL, pipelineId (null = all pipelines). - [upsertPersonalGoal](https://goliathdata.com/developers/reference/team/upsertPersonalGoal.md): Add (no id) or edit (id) a personal goal on a DRAFT plan: title, optional description and displayOrder. goalPlanId/goalId from getGoalPlan. - [deletePersonalGoal](https://goliathdata.com/developers/reference/team/deletePersonalGoal.md): Delete a personal goal from a DRAFT plan for good; updatePersonalGoalStatus ARCHIVED keeps it. goalPlanId/goalId from getGoalPlan. - [updatePersonalGoalStatus](https://goliathdata.com/developers/reference/team/updatePersonalGoalStatus.md): Mark a personal goal ACTIVE, COMPLETED or ARCHIVED, on a draft or active plan (not an archived one). goalPlanId/goalId from getGoalPlan. - [publishGoalPlan](https://goliathdata.com/developers/reference/team/publishGoalPlan.md): Publish a DRAFT plan (planId from getGoalPlan): it becomes the month's active plan, the one Agent Performance tracks, and the previous active plan is archived. - [getTeammateGoalPlan](https://goliathdata.com/developers/reference/team/getTeammateGoalPlan.md): A teammate's plan (userId, ADMIN; the key owner must be an org admin who sees the team directory): getGoalPlan for them. - [createTeammateGoalPlan](https://goliathdata.com/developers/reference/team/createTeammateGoalPlan.md): A teammate's plan (userId, ADMIN; the key owner must be an org admin who sees the team directory): createGoalPlan for them. - [upsertTeammateCommissionGoal](https://goliathdata.com/developers/reference/team/upsertTeammateCommissionGoal.md): A teammate's plan (userId, ADMIN; the key owner must be an org admin who sees the team directory): upsertCommissionGoal for them; ids from getTeammateGoalPlan. - [upsertTeammatePersonalGoal](https://goliathdata.com/developers/reference/team/upsertTeammatePersonalGoal.md): A teammate's plan (userId, ADMIN; the key owner must be an org admin who sees the team directory): upsertPersonalGoal for them; ids from getTeammateGoalPlan. - [deleteTeammatePersonalGoal](https://goliathdata.com/developers/reference/team/deleteTeammatePersonalGoal.md): A teammate's plan (userId, ADMIN; the key owner must be an org admin who sees the team directory): deletePersonalGoal for them (for good; ARCHIVED status keeps it); ids from getTeammateGoalPlan. - [updateTeammatePersonalGoalStatus](https://goliathdata.com/developers/reference/team/updateTeammatePersonalGoalStatus.md): A teammate's plan (userId, ADMIN; the key owner must be an org admin who sees the team directory): updatePersonalGoalStatus for them; ids from getTeammateGoalPlan. - [publishTeammateGoalPlan](https://goliathdata.com/developers/reference/team/publishTeammateGoalPlan.md): A teammate's plan (userId, ADMIN; the key owner must be an org admin who sees the team directory): publishGoalPlan for them; confirm with the user first. - [listTeams](https://goliathdata.com/developers/reference/team/listTeams.md): The organization's teams (groups of teammates a contact or form can be given to), newest first, with their members; search narrows by name. - [createTeam](https://goliathdata.com/developers/reference/team/createTeam.md): Create a team (name, optional description, emoji, color, memberUserIds). - [updateTeam](https://goliathdata.com/developers/reference/team/updateTeam.md): Edit a team (teamId from listTeams); omitted fields are untouched. memberUserIds (active teammates, listTeamMembers) REPLACES the whole member list. - [setTeamMembers](https://goliathdata.com/developers/reference/team/setTeamMembers.md): Set a team's members. memberUserIds (active teammates, listTeamMembers) REPLACES the whole member list. - [deleteTeam](https://goliathdata.com/developers/reference/team/deleteTeam.md): Delete a team for good. ### Partnerships - [listPartnerships](https://goliathdata.com/developers/reference/partnerships/listPartnerships.md): List every partnership your organization has with another organization (ACTIVE, PENDING and TERMINATED) always viewed from your side: partnerOrg is the OTHER organization, and its id is the... - [listPendingPartnershipInvites](https://goliathdata.com/developers/reference/partnerships/listPendingPartnershipInvites.md): List the partnership invitations OTHER organizations have sent you that are still waiting on your answer (awaitingCurrentOrgResponse is always true here). - [canShareWithPartners](https://goliathdata.com/developers/reference/partnerships/canShareWithPartners.md): True when your organization has at least one ACTIVE partnership in a sending direction (SEND_ONLY or BIDIRECTIONAL from your side): i.e. there is a partner your organization could share leads with. - [lookupPartnerOrg](https://goliathdata.com/developers/reference/partnerships/lookupPartnerOrg.md): Resolve a prospective partner organization by exactly one of an admin's phone number or email. - [createPartnershipInvite](https://goliathdata.com/developers/reference/partnerships/createPartnershipInvite.md): Send a partnership invitation to another organization (partnerOrgId from lookupPartnerOrg). direction is SEND_ONLY, RECEIVE_ONLY, or BIDIRECTIONAL (whose leads flow to whom). permittedUserIds... - [acceptPartnershipInvite](https://goliathdata.com/developers/reference/partnerships/acceptPartnershipInvite.md): Accept a pending partnership invitation from another organization (partnerOrgId from listPendingPartnershipInvites). permittedUserIds optionally limits which of your users are visible to the... - [rejectPartnershipInvite](https://goliathdata.com/developers/reference/partnerships/rejectPartnershipInvite.md): Reject a pending partnership invitation the other organization sent you (partnerOrgId from listPendingPartnershipInvites). - [cancelPartnershipInvite](https://goliathdata.com/developers/reference/partnerships/cancelPartnershipInvite.md): Cancel a pending partnership invitation your organization initiated (partnerOrgId from listPartnerships, status PENDING), before the partner has accepted it. - [terminatePartnership](https://goliathdata.com/developers/reference/partnerships/terminatePartnership.md): End an active partnership (partnerOrgId from listPartnerships); either party may. - [updatePartnershipPermittedUsers](https://goliathdata.com/developers/reference/partnerships/updatePartnershipPermittedUsers.md): Update which of your organization's users are visible to a partner when they send leads (partnerOrgId). ### Account - [getIntegrationSetupUrls](https://goliathdata.com/developers/reference/account/getIntegrationSetupUrls.md): In-app settings page URLs where a human connects an email account (Google/Microsoft) or sets up Twilio phone numbers for calling/SMS. - [getMyProfile](https://goliathdata.com/developers/reference/account/getMyProfile.md): Fetch the key owner's own profile (id, name, email, phone number (personal, via updateMyProfile; lines: listCommunicationChannels), profile picture URL) plus WHO THEY ARE IN THE ORGANIZATION and... - [getMyCapabilities](https://goliathdata.com/developers/reference/account/getMyCapabilities.md): The key owner's own permissions: CHECK THIS BEFORE OFFERING OR ATTEMPTING A GATED ACTION, or saying why one is unavailable. - [getOrganizationAreasOfOperation](https://goliathdata.com/developers/reference/account/getOrganizationAreasOfOperation.md): The organization's markets: regions and drawn polygons; null until set. - [listDirectMailLetters](https://goliathdata.com/developers/reference/account/listDirectMailLetters.md): The letters on contacts you can see (Automations → Letters), newest first: totalCount, then a page (limit default 50, offset) of contactName, campaignLabel, workflowName, mode, status (QUEUED,... - [updateMyProfile](https://goliathdata.com/developers/reference/account/updateMyProfile.md): Update the key owner's own profile. - [listIntegrations](https://goliathdata.com/developers/reference/account/listIntegrations.md): Every integration on the app's Integrations page and whether it is CONNECTED, in one read: currentUser.connectedEmailIntegrations (the key owner's own Google/Microsoft mailboxes; email is per... - [updateOrganizationAreasOfOperation](https://goliathdata.com/developers/reference/account/updateOrganizationAreasOfOperation.md): Replace the organization's markets: {version: 1, regions, polygons, updatedAt}, a region {kind: "county"|"city"|"zip", fips|cityId|zip, label} (searchCounties/searchCities). - [disconnectSlack](https://goliathdata.com/developers/reference/account/disconnectSlack.md): Disconnect the organization's Slack workspace (the Integrations page's Slack Disconnect). - [disconnectCallTools](https://goliathdata.com/developers/reference/account/disconnectCallTools.md): Disconnect CallTools: revokes the organization's CallTools key and the webhook automations Goliath created there, so dispositions stop syncing. - [disconnectSmrtPhone](https://goliathdata.com/developers/reference/account/disconnectSmrtPhone.md): Disconnect the smrtPhone dialer for the organization; its calls stop syncing. - [disconnectDialer](https://goliathdata.com/developers/reference/account/disconnectDialer.md): Disconnect a campaign dialer, provider ENZO or READYMODE, with EVERY campaign the organization linked to it (listIntegrations shows them); their calls stop syncing. - [disconnectFacebookLeadAds](https://goliathdata.com/developers/reference/account/disconnectFacebookLeadAds.md): Disconnect Facebook Lead Ads for the key owner's own Facebook account. - [disconnectDirectMail](https://goliathdata.com/developers/reference/account/disconnectDirectMail.md): Disconnect one direct-mail provider connection by connectionId (from listIntegrations directMailConnectionQuery.list). - [disconnectPhoneEnrichmentProvider](https://goliathdata.com/developers/reference/account/disconnectPhoneEnrichmentProvider.md): Disconnect a phone-enrichment provider by providerKey (provider.key from listIntegrations phoneEnrichmentQuery.providers, e.g. Trestle); phone checks through it stop. - [setSuggestionAudience](https://goliathdata.com/developers/reference/account/setSuggestionAudience.md): Set who contact suggestion cards go to: WHOLE_TEAM or POINT_PERSON. - [getLineIntakeAssignments](https://goliathdata.com/developers/reference/account/getLineIntakeAssignments.md): Each phone line's own intake assignment (who gets the contacts its inbound traffic creates); null when the line follows the org default (getPhoneRouting's defaultInboundIntakePolicy). - [getMetaPageIntakeAssignments](https://goliathdata.com/developers/reference/account/getMetaPageIntakeAssignments.md): Each Facebook Page's own intake assignment (who gets the contacts its Lead Ads create), through the key owner's own Facebook sign-in as listIntegrations reads the Pages; null for a Page nobody has... - [getWorkflowIntakeAssignment](https://goliathdata.com/developers/reference/account/getWorkflowIntakeAssignment.md): One EVENT workflow's intake assignment (who owns a contact its find/create step creates); assignmentPolicy null when it has none, workflowGroup null when the id is not one of the org's workflows. - [setIntakeAssignment](https://goliathdata.com/developers/reference/account/setIntakeAssignment.md): Replace who gets the contacts an owner's inbound traffic creates: assigneeUserIds (in order; 2+ rotate), participants, teams, tags, AI employees attached (agentAssigneeIds) and workflows fired... - [clearIntakeAssignment](https://goliathdata.com/developers/reference/account/clearIntakeAssignment.md): Delete an owner's intake assignment for good (its people, teams, employees, workflows and rotation place); a line then falls back to the org default, and an ORG clear deletes that default, so a... - [getOrganizationSettings](https://goliathdata.com/developers/reference/account/getOrganizationSettings.md): Your organization's profile and org-wide settings in one read: name, booking-link slug, websiteUrl, timezone (null = never set, not UTC), alwaysExcludeDncTexts (texts skip National DNC numbers),... - [setMyTimezone](https://goliathdata.com/developers/reference/account/setMyTimezone.md): Set the key owner's own time zone (an IANA id such as "America/Chicago"); null or omitted CLEARS it, so their times fall back to the organization's zone (resolvedTimezone says which zone applies now). - [renameOrganization](https://goliathdata.com/developers/reference/account/renameOrganization.md): Rename the organization. - [setOrganizationTimezone](https://goliathdata.com/developers/reference/account/setOrganizationTimezone.md): Set the organization's own clock: an IANA zone the product schedules in ("America/Chicago"; EST, CST, MST, AZ, PST and HST are accepted and normalized). - [setOrganizationSlug](https://goliathdata.com/developers/reference/account/setOrganizationSlug.md): Set the organization's booking-link slug: lowercase letters, numbers and hyphens, not starting or ending with a hyphen, at most 100 characters. - [setOrganizationTextDncSkip](https://goliathdata.com/developers/reference/account/setOrganizationTextDncSkip.md): Turn "Always skip National DNC numbers when texting" on or off. - [setOrganizationAiLineHeadStart](https://goliathdata.com/developers/reference/account/setOrganizationAiLineHeadStart.md): How long, in seconds (0 to 3600), a person sharing a line with an AI employee gets to answer a new text before the AI replies. - [setOrganizationTextReplyLinePolicy](https://goliathdata.com/developers/reference/account/setOrganizationTextReplyLinePolicy.md): Which line a contact's text composer opens on: USER_PRIMARY_LINE (the sender's own line) or LAST_THREAD_LINE (the line the contact last talked to, which widens who may text from a line). - [setOrganizationCallLinePolicy](https://goliathdata.com/developers/reference/account/setOrganizationCallLinePolicy.md): Which line a manual dial to a contact defaults to: ASK_BEFORE_DIALING (ask when the contact last called on another line), USER_PRIMARY_LINE (the caller's own line) or LAST_CALL_LINE (the contact's... - [setOrganizationInboxDefaultView](https://goliathdata.com/developers/reference/account/setOrganizationInboxDefaultView.md): What the inbox shows before a person chooses: INDIVIDUAL (their own lines) or TEAM (every line, for members who may view all phones; it grants no one that permission). - [setOrganizationOutboundPause](https://goliathdata.com/developers/reference/account/setOrganizationOutboundPause.md): "Pause everything": paused: true stops every automated outbound message (workflow texts and emails, AI employee texts, emails and calls, drips, mail) until it is turned off; queued work waits and... - [setOrganizationLeadRouting](https://goliathdata.com/developers/reference/account/setOrganizationLeadRouting.md): Who gets the new leads a property-signal skip trace creates: active members' user ids (listTeammates). ### Coverage - [getCoverageCells](https://goliathdata.com/developers/reference/coverage/getCoverageCells.md): The Coverage page for a whole state (stateAbbr, e.g. TX) or up to 300 named counties (countyFips, five digits): one row per county and signal type (FORECLOSURE, PREFORECLOSURE, PROBATE,... - [getCoverageAvailability](https://goliathdata.com/developers/reference/coverage/getCoverageAvailability.md): Whether each named signal type (a property signal type, e.g. FORECLOSURE or TAX_DELINQUENT) is live across your organization's counties (its markets): LIVE, BUILDING, REQUESTED, NOT_REQUESTED... ### Scheduled Tasks - [listScheduledTasks](https://goliathdata.com/developers/reference/scheduled-tasks/listScheduledTasks.md): Every scheduled task in your organization (yours first, then teammates', newest first), each a chat that runs Ask Goliath on a schedule as its owner: title, status (ACTIVE, PAUSED, PAUSED_ERRORS... - [getScheduledTask](https://goliathdata.com/developers/reference/scheduled-tasks/getScheduledTask.md): One scheduled task by id (listScheduledTasks): its instruction (what Ask Goliath is told on every run), cronExpression and timezone (a one-off has oneOffAt), abilities (actions its runs may take... - [createScheduledTask](https://goliathdata.com/developers/reference/scheduled-tasks/createScheduledTask.md): Schedule Ask Goliath to run instruction as the key owner: give exactly one of cronExpression (recurring, 5 fields) or fireAt (once), read in timezone (IANA). - [updateScheduledTask](https://goliathdata.com/developers/reference/scheduled-tasks/updateScheduledTask.md): Change a scheduled task; only what you send changes. timing is { cronExpression or fireAt, timezone }, exactly one of the two. clearExpiresAt: true removes its end (do not send it with expiresAt). - [pauseScheduledTask](https://goliathdata.com/developers/reference/scheduled-tasks/pauseScheduledTask.md): Pause a scheduled task: it stops running until resumed. - [resumeScheduledTask](https://goliathdata.com/developers/reference/scheduled-tasks/resumeScheduledTask.md): Resume a paused task from its next occurrence; missed runs are not made up. - [deleteScheduledTask](https://goliathdata.com/developers/reference/scheduled-tasks/deleteScheduledTask.md): Delete a scheduled task for good (its chat stays). ### Automation Map - [getAutomationMap](https://goliathdata.com/developers/reference/automation-map/getAutomationMap.md): Your organization's Automations Map. - [listAutomationMapVersions](https://goliathdata.com/developers/reference/automation-map/listAutomationMapVersions.md): The Map's version history, newest first (pageId from getAutomationMap): each version's number, note, when, who, and bySession (Ask Goliath wrote it rather than a person). - [getAutomationMapVersion](https://goliathdata.com/developers/reference/automation-map/getAutomationMapVersion.md): One earlier version of the Map (pageId, version), with the story it was written with. - [restoreAutomationMapVersion](https://goliathdata.com/developers/reference/automation-map/restoreAutomationMapVersion.md): Put an earlier Map version back, as the Map's Versions menu does: it is copied forward as the new current version, so nothing is lost and the step can be undone the same way. ### Ask Goliath - [getAgentTurn](https://goliathdata.com/developers/reference/ask-goliath/getAgentTurn.md): One message sent to Ask Goliath (conversationId, turnId): status RUNNING, WAITING_FOR_CALLER (answer questions with answerAgentQuestions), COMPLETED (a card only Goliath answers is inAppCard),... - [listAgentConversations](https://goliathdata.com/developers/reference/ask-goliath/listAgentConversations.md): The key owner's own Ask Goliath chats, newest first, with appName (the key that last talked in it). - [startAgentConversation](https://goliathdata.com/developers/reference/ask-goliath/startAgentConversation.md): Start a new Ask Goliath chat as the key owner with its first message; it shows in their chat list as "via" this key's name. - [prepareAgentConversation](https://goliathdata.com/developers/reference/ask-goliath/prepareAgentConversation.md): A voice assistant warming Ask Goliath up while the person is still speaking, before startAgentConversation with spoken. - [sendAgentMessage](https://goliathdata.com/developers/reference/ask-goliath/sendAgentMessage.md): Send a message in one of the key owner's chats (conversationId), as if they typed it. - [answerAgentQuestions](https://goliathdata.com/developers/reference/ask-goliath/answerAgentQuestions.md): Answer the questions the latest reply ended on (a question or an approval) as the key owner's click would: answers maps each question id to a label, a list of labels, free text, or {"other": "text"}. - [cancelAgentTurn](https://goliathdata.com/developers/reference/ask-goliath/cancelAgentTurn.md): Stop the reply to one message (conversationId, turnId); changes it already made stay made. - [submitFeedback](https://goliathdata.com/developers/reference/ask-goliath/submitFeedback.md): Send our team a BUG report, FEATURE_REQUEST or QUESTION as the key owner: a one-line title, the message (10+ characters) and optional details. ### Crm Import - [importContact](https://goliathdata.com/developers/reference/crm-import/importContact.md): Create-or-get a contact migrated from an external system. - [importContactNote](https://goliathdata.com/developers/reference/crm-import/importContactNote.md): Create-or-get a historical note on a contact, attributed to a real member of the organization (authorUserId). - [importDeal](https://goliathdata.com/developers/reference/crm-import/importDeal.md): Create-or-get a deal migrated from an external system. ### Memory - [addMemoryEntries](https://goliathdata.com/developers/reference/memory/addMemoryEntries.md): Add conversation records from another system to your memory, idempotent on externalId. ### Files - [listFiles](https://goliathdata.com/developers/reference/files/listFiles.md): The Files list, newest first: uploads (imports (status, type, file name, rows, who and when; the id is the fileProcessingTaskId for getUploadReport) and downloads (standalone exports) the id is... - [getUploadReport](https://goliathdata.com/developers/reference/files/getUploadReport.md): One upload's report: what its report sheet shows: rows in the file, how many contacts or properties it created, matched to existing records, restored, merged, skipped, failed or duplicated, and... - [listUploadReportRows](https://goliathdata.com/developers/reference/files/listUploadReportRows.md): The rows of one upload's report in one bucket (ALL_ROWS, CREATED, MATCHED, RESTORED, MERGED_AFTER_IMPORT, DUPLICATE_ROWS, SKIPPED, FAILED): the row number, its outcome and reason, the original CSV... - [getExportReport](https://goliathdata.com/developers/reference/files/getExportReport.md): One export's report, by dataExportId (a listFiles downloads id, or the one a bulk task returns): its type, rows, the saved filter it was run from, and its skip-trace and enrichment outcomes and spend. - [renameDataExport](https://goliathdata.com/developers/reference/files/renameDataExport.md): Rename an export's file. - [deleteDataExport](https://goliathdata.com/developers/reference/files/deleteDataExport.md): Dismiss a FAILED standalone export from the Files list (the row is kept for the record). - [deletePendingUpload](https://goliathdata.com/developers/reference/files/deletePendingUpload.md): PERMANENTLY remove an upload that is still waiting for review (not yet imported). - [listExportConfigurations](https://goliathdata.com/developers/reference/files/listExportConfigurations.md): The org's saved export presets (the download dialog's row shapes): id, name, description, and which one is the default the dialog opens with. - [setDefaultExportConfiguration](https://goliathdata.com/developers/reference/files/setDefaultExportConfiguration.md): Make one export preset (listExportConfigurations id) the org's default in the download dialog, for everyone. - [deleteExportConfiguration](https://goliathdata.com/developers/reference/files/deleteExportConfiguration.md): Delete an export preset for the whole org, for good (listExportConfigurations id). - [renameUploadedFile](https://goliathdata.com/developers/reference/files/renameUploadedFile.md): Rename an uploaded file (listFiles uploads[].file.id, or a deal's or contact's file). - [exportContacts](https://goliathdata.com/developers/reference/files/exportContacts.md): Export contacts to a spreadsheet, the download dialog's Start. - [skipTraceContacts](https://goliathdata.com/developers/reference/files/skipTraceContacts.md): Bulk skip trace contacts for phones and emails. - [exportProperties](https://goliathdata.com/developers/reference/files/exportProperties.md): Export properties (esIds) to a spreadsheet. - [skipTraceAndExportProperties](https://goliathdata.com/developers/reference/files/skipTraceAndExportProperties.md): Bulk skip trace properties (esIds) and export owners, phones and emails to a spreadsheet. - [skipTraceAndCreateContactsFromProperties](https://goliathdata.com/developers/reference/files/skipTraceAndCreateContactsFromProperties.md): Bulk skip trace properties (esIds) and make a contact for each owner, into an export list, plus contactListIds and enrolled in contactWorkflowIds (which can text or email them). ### Spaces - [listSpaceRoots](https://goliathdata.com/developers/reference/spaces/listSpaceRoots.md): Library's roots (files and folders only; Team's templates, forms, contracts and tables: listContentTemplates, listForms, listContractTemplates, listWorkflowTables). - [listSpaceFolder](https://goliathdata.com/developers/reference/spaces/listSpaceFolder.md): One folder's files and folders only (a root when folderId is omitted). - [getSpaceItem](https://goliathdata.com/developers/reference/spaces/getSpaceItem.md): One folder or file by id, with its path, owner, creator, current version and what you may do to it. - [searchSpaceItems](https://goliathdata.com/developers/reference/spaces/searchSpaceItems.md): Find folders and files by NAME (case-insensitive substring) across everything you can see: at most 50, most recently changed first. - [getSpaceTextContent](https://goliathdata.com/developers/reference/spaces/getSpaceTextContent.md): The text of a text file (Markdown, JSON, CSV, HTML, code, plain text): up to 2 MB, truncated when cut. - [getSpaceTextLines](https://goliathdata.com/developers/reference/spaces/getSpaceTextLines.md): A text file's lines, numbered, a page at a time (N| line; up to 12000 characters a page from startLine, totalLines and endLine say where you are). - [readSpaceSheet](https://goliathdata.com/developers/reference/spaces/readSpaceSheet.md): A spreadsheet's cells (.xlsx, CSV, TSV) by A1 range (any size, any sheet) instead of reading it whole: range B2:F40, C7, A:C (whole columns) or 5:9 (whole rows), default every filled cell; sheet... - [searchSpaceText](https://goliathdata.com/developers/reference/spaces/searchSpaceText.md): Find words INSIDE one text file: the numbered lines (N| line) holding any of terms (case-insensitive, matches inside longer words), with contextLines (default 2) around each and … between blocks:... - [listSpacesSharedWithMe](https://goliathdata.com/developers/reference/spaces/listSpacesSharedWithMe.md): The "Shared with me" view: folders and files teammates shared with you directly, newest first. - [listRecentSpaceItems](https://goliathdata.com/developers/reference/spaces/listRecentSpaceItems.md): The "Recent" view: files you can see (pages and documents included), most recently CHANGED first, limit of them (default 100, at most 200), each with createdAt and createdBy. "What did I make... - [listSpaceTrash](https://goliathdata.com/developers/reference/spaces/listSpaceTrash.md): The "Trash" view: what was trashed (by anyone) that you can see, with trashedAt. - [listSpaceItemVersions](https://goliathdata.com/developers/reference/spaces/listSpaceItemVersions.md): A file's saved versions, newest first: at most the newest 200: number, size, who saved it, and which is current. - [listSpaceItemActivity](https://goliathdata.com/developers/reference/spaces/listSpaceItemActivity.md): A folder or file's history, newest first (only the latest 50 events, so an older event's absence proves nothing: created, renamed, moved, edited, shared, trashed, restored, downloaded, attached)... - [getSpaceAccessList](https://goliathdata.com/developers/reference/spaces/getSpaceAccessList.md): A folder or file's audience (ORGANIZATION = everyone in the org, OWNER = the owner of My files, RESTRICTED = only people granted access, here or on a parent folder, SYSTEM = everyone, read-only)... - [searchSpaces](https://goliathdata.com/developers/reference/spaces/searchSpaces.md): One search across everything the Library rail reaches (FILES (folders and files), LIBRARY (templates, contracts, contract templates, forms, tables, pages) and DATA (uploads, downloads)) matching... - [listSpaceContactFiles](https://goliathdata.com/developers/reference/spaces/listSpaceContactFiles.md): Records › Contact files: attachments and voicemails contacts sent or received, newest first. - [listSpaceCalls](https://goliathdata.com/developers/reference/spaces/listSpaceCalls.md): Records › Calls: the organization's calls, newest first: direction, when, how long, whether recorded, the contact, status and disposition. - [listMemoryShelves](https://goliathdata.com/developers/reference/spaces/listMemoryShelves.md): Memory: the shelves you may open (PERSON (yours), TEAM (the organization's), EMPLOYEE and CONTACT (only the contacts the key owner may open in the CRM)) and how many subjects each list shelf holds... - [listMemorySubjects](https://goliathdata.com/developers/reference/spaces/listMemorySubjects.md): Memory: one list shelf's subjects (EMPLOYEE or CONTACT: the AI employees or contacts Goliath remembers things about; contacts only as the CRM lets the key owner open them), newest first, with how... - [getMemorySubjectNotes](https://goliathdata.com/developers/reference/spaces/getMemorySubjectNotes.md): Memory: one subject's notes (shelf PERSON with no subjectId is yours, TEAM is the organization's, otherwise the subject's id) in reading order (rules, preferences, decisions, procedures, facts …),... - [createSpaceFolder](https://goliathdata.com/developers/reference/spaces/createSpaceFolder.md): Create a folder at a root (My files or Team; folderId omitted) or inside a folder you can edit. - [createSpaceTextFile](https://goliathdata.com/developers/reference/spaces/createSpaceTextFile.md): Save text as a new file (a report, notes, a JSON or CSV export, a memo) in a folder you can edit. - [saveSpaceTextFile](https://goliathdata.com/developers/reference/spaces/saveSpaceTextFile.md): Save new text as the next version of a text file you can edit (earlier versions are kept and can be restored in the app). - [insertSpaceTextLines](https://goliathdata.com/developers/reference/spaces/insertSpaceTextLines.md): Insert lines into a text file by line number (from getSpaceTextLines), every existing line left exactly as it was (headings, an intro, a summary) as a new version, like a save. beforeLine 1 is the... - [editSpaceTextLines](https://goliathdata.com/developers/reference/spaces/editSpaceTextLines.md): Reorganize or rewrite part of a text file by line number (from getSpaceTextLines), as one new version like a save: each edit replaces a range startLine-endLine with text (empty deletes it), MOVES... - [editSpaceSheetCells](https://goliathdata.com/developers/reference/spaces/editSpaceSheetCells.md): Change cells of a spreadsheet (.xlsx, CSV, TSV) by A1 address as one new version, without re-sending the sheet: each of edits writes values (rows of cells) right and down from its start cell (a... - [filterSpaceSheet](https://goliathdata.com/developers/reference/spaces/filterSpaceSheet.md): A filtered list from a spreadsheet as a NEW CSV beside it, every row read on the server. - [renameSpaceItem](https://goliathdata.com/developers/reference/spaces/renameSpaceItem.md): Rename a folder or file you can edit. - [moveSpaceItems](https://goliathdata.com/developers/reference/spaces/moveSpaceItems.md): Move up to 200 items into a folder or a root (destination.folderId omitted), all or nothing. - [copySpaceItem](https://goliathdata.com/developers/reference/spaces/copySpaceItem.md): Copy a FILE into a folder or root you can edit. - [copyUploadedFileToSpace](https://goliathdata.com/developers/reference/spaces/copyUploadedFileToSpace.md): Copy an upload's original file (listFiles uploads[].file.id) into a folder or root you can edit, as Uploads' "Copy to My files" does: a new file of your own, independent of the upload. - [fileLibraryItemsOnContact](https://goliathdata.com/developers/reference/spaces/fileLibraryItemsOnContact.md): Put Library items on a contact's Files & Photos, as the contact's Attach › From Library does: a snapshot copy of each file (up to 20, 300 MB each), and a PAGE as its PDF printed now as you see it. - [fileLibraryItemsOnDeal](https://goliathdata.com/developers/reference/spaces/fileLibraryItemsOnDeal.md): fileLibraryItemsOnContact for a deal's files: a snapshot copy of each Library file, a page as its PDF. - [savePagePdf](https://goliathdata.com/developers/reference/spaces/savePagePdf.md): Save a PAGE as a PDF file in Library ("turn this into a PDF", "give it to me as a PDF"): printed now as you see it, saved where the files you make for this person go (their chosen folder, else My... - [setAgentFilesFolder](https://goliathdata.com/developers/reference/spaces/setAgentFilesFolder.md): Choose where the files you make in this person's chats are saved for them: a folder they can edit (folderId), or null for the root of My files, the default. - [trashSpaceItems](https://goliathdata.com/developers/reference/spaces/trashSpaceItems.md): Move up to 200 items (folders with everything in them) to the trash. - [restoreSpaceItems](https://goliathdata.com/developers/reference/spaces/restoreSpaceItems.md): Restore trashed items to where they were: exactly what was trashed together comes back. - [describeSpaceItem](https://goliathdata.com/developers/reference/spaces/describeSpaceItem.md): Set (or clear, with description null) the short description shown under a folder or file you can edit. - [restoreSpaceItemVersion](https://goliathdata.com/developers/reference/spaces/restoreSpaceItemVersion.md): Make an older version of a file you can edit current again, as a NEW version: nothing is lost; the version it replaces stays in the history. - [setSpaceAccessMode](https://goliathdata.com/developers/reference/spaces/setSpaceAccessMode.md): RESTRICTED closes a folder or file (and everything in it) to all but its owner and the people it is shared with; INHERIT opens it back to the audience of the folder it is in, which can WIDEN who... - [setSpaceGrant](https://goliathdata.com/developers/reference/spaces/setSpaceGrant.md): Share a folder or file (and everything in it) with one teammate (userId, an active member of your organization) as VIEWER, EDITOR or MANAGER, or stop sharing with role null. - [deleteSpaceItemsForever](https://goliathdata.com/developers/reference/spaces/deleteSpaceItemsForever.md): PERMANENTLY delete items that are already in the trash: rows, every version and the stored bytes. - [addMemoryNote](https://goliathdata.com/developers/reference/spaces/addMemoryNote.md): Memory: add a note to a shelf the key owner may open, as a person stated it, pinned. - [editMemoryNote](https://goliathdata.com/developers/reference/spaces/editMemoryNote.md): Memory: correct a note's words (noteId from getMemorySubjectNotes). - [pinMemoryNote](https://goliathdata.com/developers/reference/spaces/pinMemoryNote.md): Memory: pin (pinned true) or unpin a note. - [forgetMemoryNote](https://goliathdata.com/developers/reference/spaces/forgetMemoryNote.md): Memory: forget a note, with an optional reason. - [restoreMemoryNote](https://goliathdata.com/developers/reference/spaces/restoreMemoryNote.md): Memory: bring a forgotten note back (noteId from getMemorySubjectNotes with retired: true). - [getMemoryDreamLog](https://goliathdata.com/developers/reference/spaces/getMemoryDreamLog.md): Memory: what dreaming (the nightly pass that merges, rewrites and retires notes) did to one subject, only the newest limit entries (at most 50; no paging back, hasMore says older ones exist). - [undoMemoryDream](https://goliathdata.com/developers/reference/spaces/undoMemoryDream.md): Memory: undo one dreaming change (eventId from getMemoryDreamLog): what it retired or merged comes back, what it wrote is forgotten. - [queueMemoryDream](https://goliathdata.com/developers/reference/spaces/queueMemoryDream.md): Memory: queue one dreaming pass now for the key owner's own PERSON shelf (no subjectId), outside the nightly run: a model run that spends, at most $0.50, so it needs the person's approval. ### Employees - [listEmployees](https://goliathdata.com/developers/reference/employees/listEmployees.md): The organization's AI employees: id, name, job title, status (ACTIVE = working, INACTIVE = hired but switched off), the template it started from, whether it can answer calls, and how many contacts... - [getEmployee](https://goliathdata.com/developers/reference/employees/getEmployee.md): One AI employee in full. abilities is what it can do RIGHT NOW, resolved (a tool missing from the stored config follows its default, and most defaults are on, so read abilities, never infer from... - [getEmployeeCaseload](https://goliathdata.com/developers/reference/employees/getEmployeeCaseload.md): The contacts one AI employee is on, newest attachment first, offset-paged (offset, limit; total is the full count). - [listEmployeeChannelOptions](https://goliathdata.com/developers/reference/employees/listEmployeeChannelOptions.md): What an AI employee can be bound to right now: availableMailboxes (connected Gmail or Outlook inboxes shared with the organization that no employee owns yet; the id attachEmployeeMailbox takes)... - [listEmployeeSuggestions](https://goliathdata.com/developers/reference/employees/listEmployeeSuggestions.md): An AI employee's pending suggestion cards, newest first: edits it proposes to its own instructions (action), with how sure it is (confidence). - [listEmployeeRevisions](https://goliathdata.com/developers/reference/employees/listEmployeeRevisions.md): An AI employee's saved versions, newest first (offset-paged; advance by nextOffset). - [createEmployee](https://goliathdata.com/developers/reference/employees/createEmployee.md): Hire an AI employee. - [updateEmployeeConfig](https://goliathdata.com/developers/reference/employees/updateEmployeeConfig.md): Change an AI employee's configuration. - [updateEmployeeIdentity](https://goliathdata.com/developers/reference/employees/updateEmployeeIdentity.md): Rename an AI employee or change its job title or avatar, nothing else (an omitted field is kept; an empty title clears it). - [setEmployeeDailyCaps](https://goliathdata.com/developers/reference/employees/setEmployeeDailyCaps.md): Set an AI employee's own daily caps, which bound what it spends: dailyRunCap (live runs a day) and dailyCallCap (connected calls a day). - [restoreEmployeeRevision](https://goliathdata.com/developers/reference/employees/restoreEmployeeRevision.md): Put an AI employee back to a saved version (revisionId from listEmployeeRevisions): its instructions, settings, name and job title as that version held them (the avatar is kept, and a setting that... - [setEmployeeStatus](https://goliathdata.com/developers/reference/employees/setEmployeeStatus.md): Switch an AI employee on (ACTIVE) or off (INACTIVE). - [attachEmployeeToContacts](https://goliathdata.com/developers/reference/employees/attachEmployeeToContacts.md): Put an AI employee on contacts (at most 200 ids per call; send more in further calls). - [detachEmployeeFromContacts](https://goliathdata.com/developers/reference/employees/detachEmployeeFromContacts.md): Take an AI employee off contacts (at most 200 ids per call). - [runEmployeesOnContacts](https://goliathdata.com/developers/reference/employees/runEmployeesOnContacts.md): Put AI employees on contacts and wake each pairing once (runNow, default true), and/or on a schedule (cron, timezone, maxRuns; no denser than daily). message (max 2000 chars) is an internal... - [removeEmployeesFromContacts](https://goliathdata.com/developers/reference/employees/removeEmployeesFromContacts.md): Take AI employees off contacts: they stop working them and their schedules are dropped; the history stays. - [attachEmployeeMailbox](https://goliathdata.com/developers/reference/employees/attachEmployeeMailbox.md): Give an AI employee a mailbox to email from and be woken by (mailboxId from listEmployeeChannelOptions): a connected inbox, shared with the organization, with a live connection, that no other... - [detachEmployeeMailbox](https://goliathdata.com/developers/reference/employees/detachEmployeeMailbox.md): Take a mailbox off an AI employee (an id from getEmployee mailboxes): it stops emailing from it and is no longer woken by mail to it. - [detachEmployeePhoneLine](https://goliathdata.com/developers/reference/employees/detachEmployeePhoneLine.md): Release a phone line an AI employee still holds from before lines were shared (an id from getEmployee legacyPhoneLines). - [setEmployeeTriggerForms](https://goliathdata.com/developers/reference/employees/setEmployeeTriggerForms.md): Set which forms wake an AI employee when someone submits one. formIds REPLACES the set (ids from listEmployeeChannelOptions; every one must be this organization's); [] means no form wakes it. - [setEmployeeDefaultAssignees](https://goliathdata.com/developers/reference/employees/setEmployeeDefaultAssignees.md): Who becomes the owner of a contact an AI employee works when the contact has no owner. mode decides what assigneeUserIds holds (teammate user ids, listTeamMembers): TEAM_RANDOM (the default, any... - [deleteEmployee](https://goliathdata.com/developers/reference/employees/deleteEmployee.md): Delete an AI employee, the employee page's Fire. - [acceptEmployeeSuggestion](https://goliathdata.com/developers/reference/employees/acceptEmployeeSuggestion.md): Accept one of an AI employee's suggestion cards (listEmployeeSuggestions): its edit lands on the employee's instructions, as the employee page's Accept does. outcome APPLIED, RETIRED (the... - [dismissEmployeeSuggestion](https://goliathdata.com/developers/reference/employees/dismissEmployeeSuggestion.md): Dismiss one of an AI employee's suggestion cards (listEmployeeSuggestions) with a reason (NOT_RELEVANT, WRONG_TONE, WRONG_FACTS, ALREADY_DONE or OTHER). - [commentOnEmployeeSuggestion](https://goliathdata.com/developers/reference/employees/commentOnEmployeeSuggestion.md): Comment on one of an AI employee's suggestion cards ("keep the opener shorter"). - [createEmployeeAnswerWorkflow](https://goliathdata.com/developers/reference/employees/createEmployeeAnswerWorkflow.md): Create the DRAFT workflow that hands an employee its contacts' inbound texts (on its lines, else the org's) or emails (its mailboxes, else any). - [getContactEmployees](https://goliathdata.com/developers/reference/employees/getContactEmployees.md): The AI employees on one contact, as the contact page's card shows them. aiEmployees[].id is the attachment id setEmployeeSchedule and clearEmployeeSchedule take (agentId is the employee); status... - [listContactReplyDrafts](https://goliathdata.com/developers/reference/employees/listContactReplyDrafts.md): Retired (#41897): always returns an empty list. - [assignEmployeeToContact](https://goliathdata.com/developers/reference/employees/assignEmployeeToContact.md): Put one AI employee on one contact, optionally on a schedule, the contact card's Add. - [setEmployeeSchedule](https://goliathdata.com/developers/reference/employees/setEmployeeSchedule.md): Replace (or add) the schedule of one employee on one contact (attachmentId from getContactEmployees). - [clearEmployeeSchedule](https://goliathdata.com/developers/reference/employees/clearEmployeeSchedule.md): Drop the schedule of one employee on one contact (attachmentId from getContactEmployees). - [stopEmployeeRuns](https://goliathdata.com/developers/reference/employees/stopEmployeeRuns.md): Stop what one AI employee is doing on one contact right now (getContactEmployees' isWorkingNow). - [cancelEmployeeFollowUp](https://goliathdata.com/developers/reference/employees/cancelEmployeeFollowUp.md): Cancel a follow-up an AI employee booked on a contact before it runs (followUpId: a FOLLOW_UP row's id from getContactEmployees' upcomingAgentRuns). - [discardEmployeeReplyDraft](https://goliathdata.com/developers/reference/employees/discardEmployeeReplyDraft.md): Retired (#41897): always refused, since no reply is held any more. ### Contact Imports - [startContactImport](https://goliathdata.com/developers/reference/contact-imports/startContactImport.md): Start importing contacts from a spreadsheet the person attached to the chat. - [authorContactImportMapping](https://goliathdata.com/developers/reference/contact-imports/authorContactImportMapping.md): Bring an import from startContactImport to a ready mapping when it was not ready yet (transformerAuthoringState IN_PROGRESS, or hasAuthoredTransformer false). - [reviseContactImportMapping](https://goliathdata.com/developers/reference/contact-imports/reviseContactImportMapping.md): Change how an import maps the spreadsheet’s columns, in plain words: message is the change the person asked for (for example "the Owner 2 column is a second contact name, not a note" or "put the... - [previewContactImport](https://goliathdata.com/developers/reference/contact-imports/previewContactImport.md): The first rows of an import as the contacts they will become, in the app’s own fields: name, phones, emails, property addresses, mailing addresses, tags, lists, deals, and custom fields (every... - [confirmContactImport](https://goliathdata.com/developers/reference/contact-imports/confirmContactImport.md): Import every row of the spreadsheet as contacts: the step the Import page’s Import button runs. - [getContactImport](https://goliathdata.com/developers/reference/contact-imports/getContactImport.md): The status of an import: status (CREATED and AUTHORING_TRANSFORMER = not confirmed yet, PENDING_PROCESSING and PROCESSING = importing, COMPLETED, FAILED, NOT_ENOUGH_BALANCE), totalRows, the... - [getContactImportRowFindings](https://goliathdata.com/developers/reference/contact-imports/getContactImportRowFindings.md): The rows of an import whose phone the import cannot store (not a full US number): they come in without that phone. unstorablePhoneRowIndexes are 0-based, so row N is index + 1; checkedRows is how... ### Library File Runs - [startLibraryFileRun](https://goliathdata.com/developers/reference/library-file-runs/startLibraryFileRun.md): Start a run on a Library file (a .csv, .xlsx or .xls spreadsheet; spaceItemId from the chat trailer or searchSpaceItems): a skip trace finds owner phones and emails, a tag puts its properties on a... - [mapLibraryFileRun](https://goliathdata.com/developers/reference/library-file-runs/mapLibraryFileRun.md): Map a run's columns with the import mapper (up to a few minutes). skipTrace is true for a SKIPTRACE run and false for TAG_PROPERTIES. - [reviseLibraryFileRun](https://goliathdata.com/developers/reference/library-file-runs/reviseLibraryFileRun.md): Change how a run maps the spreadsheet's columns, in the person's words (message), then read previewLibraryFileRun again. skipTrace is true for a SKIPTRACE run and false for TAG_PROPERTIES. - [previewLibraryFileRun](https://goliathdata.com/developers/reference/library-file-runs/previewLibraryFileRun.md): The first rows of a mapped run as it reads them: for a skip trace each row's lookups (inputs: whose owner, at which address), for a tag the properties. - [confirmLibraryFileRun](https://goliathdata.com/developers/reference/library-file-runs/confirmLibraryFileRun.md): Run it: the step the Files review's confirm runs. ### Call Lists - [listCallLists](https://goliathdata.com/developers/reference/call-lists/listCallLists.md): The call lists you can open: your own and the ones shared with your team, newest first (at most 50). - [getCallList](https://goliathdata.com/developers/reference/call-lists/getCallList.md): One call list with its progress, plus one page of its contacts in dial order: each slot's position, status (PENDING = still to call, IN_PROGRESS = being dialed, COMPLETED, SKIPPED with... - [getCallListDialLink](https://goliathdata.com/developers/reference/call-lists/getCallListDialLink.md): The in-app link that opens a call list in the dialer, where a person presses Start: dialPath is a path inside the app (/contacts?callListId=…). - [createCallList](https://goliathdata.com/developers/reference/call-lists/createCallList.md): Build a call list from contact ids, dialed in the order given (duplicates collapse). - [createCallListFromContactFilter](https://goliathdata.com/developers/reference/call-lists/createCallListFromContactFilter.md): Build a call list from a saved CONTACT filter (filterId from listContactFilters): the contacts it matches for you right now, in the filter's order, up to 10,000. - [addCallListContacts](https://goliathdata.com/developers/reference/call-lists/addCallListContacts.md): Add contacts to the end of a call list, so they are called after everyone already on it. - [removeCallListContacts](https://goliathdata.com/developers/reference/call-lists/removeCallListContacts.md): Take contacts off a call list before they are called: their slots close as skipped by hand (skipReason USER), so the list keeps its record. - [renameCallList](https://goliathdata.com/developers/reference/call-lists/renameCallList.md): Rename a call list. - [endCallList](https://goliathdata.com/developers/reference/call-lists/endCallList.md): Archive a call list: it moves to ENDED, stays readable with its outcomes, and can no longer be dialed or edited. - [deleteCallList](https://goliathdata.com/developers/reference/call-lists/deleteCallList.md): Delete a call list: it disappears from Call lists for everyone. ### Contracts - [listContractTemplates](https://goliathdata.com/developers/reference/contracts/listContractTemplates.md): The organization's contract templates: name, category, status (only a PUBLISHED one with a currentVersionNumber can be sent), signer roles in signing order, and the records a send asks for (uses:... - [listContracts](https://goliathdata.com/developers/reference/contracts/listContracts.md): The organization's contracts, newest first (at most 200), with status and who signed. held marks a workflow or AI employee send waiting on a blank required value (getHeldContractDraft). - [listContactContracts](https://goliathdata.com/developers/reference/contracts/listContactContracts.md): A contact's contracts (as Contact A or another signer), newest first, at most 50. - [listDealContracts](https://goliathdata.com/developers/reference/contracts/listDealContracts.md): A deal's contracts, held drafts included, newest first, at most 50. - [getContract](https://goliathdata.com/developers/reference/contracts/getContract.md): One contract: its values, each signer's status (viewed, signed, declined with their reason, a deliveryProblem when their link never arrived) and short-lived PDF links (signedPdfUrl once everyone... - [getContractSendDraft](https://goliathdata.com/developers/reference/contracts/getContractSendDraft.md): Step 1 of preparing a contract: a PUBLISHED template filled for one contact (optionally a deal, and contactBId for a co-seller). - [getHeldContractDraft](https://goliathdata.com/developers/reference/contracts/getHeldContractDraft.md): A held contract (a workflow or AI employee send stopped on a blank required value) reopened to fill in, shaped as getContractSendDraft. - [previewContract](https://goliathdata.com/developers/reference/contracts/previewContract.md): The filled PDF a contract would be (pdfUrl, short-lived) and any values that overflow their box or cannot print. - [previewContractMessages](https://goliathdata.com/developers/reference/contracts/previewContractMessages.md): What the first signers would be sent: the signing email's words (email) and the text (text), each null when no first signer is reached that way, worded by the send's own code. - [prepareContract](https://goliathdata.com/developers/reference/contracts/prepareContract.md): Step 2: freeze a contract READY to send, with its unsigned PDF. - [archiveContractTemplate](https://goliathdata.com/developers/reference/contracts/archiveContractTemplate.md): Take a template out of the list and the pickers (status ARCHIVED). - [unarchiveContractTemplate](https://goliathdata.com/developers/reference/contracts/unarchiveContractTemplate.md): Put an archived template back in the list and the pickers, as it was. - [keepContractAsTemplate](https://goliathdata.com/developers/reference/contracts/keepContractAsTemplate.md): Keep a one-off contract as a template under a name and category: it joins the template list and pickers. templateId is the contract's own (listContracts, listContactContracts, listDealContracts). - [sendContract](https://goliathdata.com/developers/reference/contracts/sendContract.md): Send a READY contract (prepareContract) for signature: the first signers in signing order get their links by email or text, and it becomes SENT. - [remindContract](https://goliathdata.com/developers/reference/contracts/remindContract.md): Email a fresh link to every signer whose turn it is; their earlier links stop working. expectedRevisionNumber as sendContract. - [completeContract](https://goliathdata.com/developers/reference/contracts/completeContract.md): Retry completing a contract whose last signature is in (sealing the signed PDF), or file and email a completed contract's signed copy to everyone again. - [voidContract](https://goliathdata.com/developers/reference/contracts/voidContract.md): Void a sent contract: every signing link stops working and the signers who were sent one are told, with reason (kept on the evidence chain). - [correctContract](https://goliathdata.com/developers/reference/contracts/correctContract.md): Correct a sent contract on the same template version, contact and deal: input.contract as prepareContract takes it with the changes, reason (emailed to the signers whose link stops working, and... - [issueContractSigningLink](https://goliathdata.com/developers/reference/contracts/issueContractSigningLink.md): A working signing link for ONE signer whose turn it is (recipientId: getContract's recipients[].id), returned once for you to pass to that signer yourself.