Data Access Tools

Overview

Data Access tools are the backbone of every workflow. Before you can update a widget, edit a chatbot, or check campaign stats, you typically need to find the resource first. These two tools give you read-only access to every resource type in your organization.

Permission required:Copilot.DataAccess

list_records

Lists records of a specific resource type in your organization. Returns a summary view of each record (not full details — use get_record for that).

Parameters

Parameter	Type	Required	Description
`table`	string	Yes	The resource type to list. See available types below.
`limit`	number	No	How many records to return. Default: 50, max: 300.
`from`	number	No	Pagination offset (conversations only). Default: 0.
`chatbotId`	string	Conditional	Required when listing chatbot documents or conversation starters.
`knowledgebaseId`	string	Conditional	Required when listing KB articles or categories.
`documentationId`	string	Conditional	Required when listing documentation categories or pages.
`category`	string	No	Filter for conversations: `"all"`, `"my-inbox"`, or `"unassigned"`.
`publishedOnly`	boolean	No	Filter for articles and documentation pages — only return published items.

Available Resource Types

Type	What It Lists
`widgets`	Chat widgets
`chatbots`	AI chatbots
`knowledgebase`	Knowledge bases
`chats`	Conversations
`visitors`	Website visitors
`documents`	Chatbot knowledge documents (requires `chatbotId`)
`conversation_starters`	Chatbot conversation starters (requires `chatbotId`)
`articles`	KB articles (requires `knowledgebaseId`)
`categories`	KB categories (requires `knowledgebaseId`)
`documentation`	Documentation portals
`doc_categories`	Documentation categories (requires `documentationId`)
`doc_pages`	Documentation pages (requires `documentationId`)
`contact_groups`	Contact groups with subscriber counts
`contact_segments`	Contact segments
`email_templates`	Email templates
`campaigns`	Email campaigns
`subscribers`	Newsletter subscribers
`outreach`	All outreach items combined (banners, messages, surveys, tours, news)

How It Works

Records are returned sorted by creation date (newest first), except conversations which sort by last update.
The outreach type returns all outreach items grouped by their sub-type (banners, messages, surveys, tours, news).
Pagination is only supported on conversations using the from parameter. Other types simply use limit.

Example Prompts

"Show me all my widgets."
"List my chatbots."
"What conversations are unassigned right now?"
"Show me the documents in my Support Bot chatbot." (uses list_records to find the chatbot first, then lists its documents)
"List all published articles in my Help Center knowledge base." (finds the KB, then lists articles with publishedOnly: true)
"Show me my newsletter contact groups and how many subscribers each has."
"What campaigns have I sent recently?"
"List all my outreach items — banners, surveys, tours, everything."
"Show me my latest 100 conversations."

get_record

Fetches a single record by ID with full details. Returns more information than list_records — for example, full configuration objects, content fields, and related data.

Parameters

Parameter	Type	Required	Description
`table`	string	Yes	The resource type. See available tables below.
`id`	string	Yes	The unique ID of the record to fetch.

Available Resource Types

All the same types as list_records, plus specific outreach sub-types for fetching individual items:

Type	What You Get
`widgets`	Full configuration, theme colors, and linked resources
`chatbots`	Complete AI settings and configuration
`knowledgebase`	Portal details with categories
`documentation`	Portal details with categories
`doc_categories`	Category details including description and publish status
`doc_pages`	Full Markdown content and page hierarchy
`chats`	Full conversation details
`visitors`	Complete visitor profile
`documents`	Full document content
`conversation_starters`	Starter label and prompt
`articles`	Full HTML content
`categories`	Category details and hierarchy
`campaigns`	Full campaign details including email content and recipients
`subscribers`	Subscriber profile and status
`email_templates`	Full template content
`banners`	Content, styling, and trigger rules
`messages`	Content and trigger rules
`surveys`	Survey flow and trigger rules
`tours`	Tour steps and trigger rules
`news`	Full content, cover image, and language

Note: For outreach, use the specific type name (banners, messages, surveys, tours, news) — not the combined outreach type that list_records uses.

How It Works

The record must belong to your organization. Attempts to access records from other organizations will fail.
Returns the complete details of a resource, giving you the full picture of its configuration and content.

Example Prompts

"Show me the full details of my default widget." (lists widgets first, then gets the default one)
"What's the AI configuration on my Support Bot?" (lists chatbots, then gets the specific one)
"Show me the content of my refund policy document." (lists documents, then gets the full content)
"Let me see the full HTML of my Getting Started article." (finds the article, then gets its content)
"What are the trigger rules on my sale banner?" (lists outreach, then gets the banner details)
"Show me the email content and recipients of my March campaign." (gets campaign with full send details)

Common Workflow Patterns

Explore Then Act

Most workflows start with Data Access tools:

List resources to find what exists → list_records
Inspect a specific resource to understand its state → get_record
Modify it using the appropriate management tool → manage_widget, manage_chatbot, etc.

Bulk Review

Use list_records with a higher limit to review many resources at once:

"Show me all 200 of my newsletter contacts."
"List my last 100 conversations."

Cross-Reference

Combine listing from different tables to understand relationships:

"List my widgets and chatbots, then tell me which chatbot is linked to which widget."
"Show me all knowledge bases and their article counts."