{"article":{"id":36130822688279,"url":"https://otterai.zendesk.com/api/v2/help_center/en-us/articles/36130822688279.json","html_url":"https://help.otter.ai/hc/en-us/articles/36130822688279-Otter-ai-Public-API","author_id":1902597107005,"comments_disabled":true,"draft":false,"promoted":false,"position":0,"vote_sum":1,"vote_count":1,"upvote_count":1,"downvote_count":0,"section_id":13352400186391,"created_at":"2025-11-05T18:55:31Z","updated_at":"2026-10-29T20:46:34Z","name":"Otter.ai Public API","title":"Otter.ai Public API","source_locale":"en-us","locale":"en-us","outdated":false,"outdated_locales":[],"edited_at":"2026-10-29T20:46:34Z","user_segment_id":null,"permission_group_id":3069674,"content_tag_ids":["01K9BA5PT4JPJ4N9KRGGD1JMT0"],"label_names":["authentication","public api","webhooks","error response","api objects","bearer","otter api","otter public api","do you have api","what apis do you have","apis available","objects"],"body":"<div class=\"otter-api-doc otter-api-public\">\n<p>Otter.ai’s Public API provides programmatic access to retrieve channels, conversations, transcripts, audio, action items, insights, outlines, and workspace details from your Otter account.</p>\n<div class=\"note plan\">\n<strong>Getting Started:</strong> Otter's Public API is available for all Enterprise workspaces. If you do not see this feature for your workspace, contact your Otter account manager.</div>\n<div data-toc-children=\"true\">\n<h2 id=\"api-fundamentals\" data-toc-section=\"true\">API Fundamentals</h2>\n<p>Essential information for authenticating, paging through results, and understanding usage limits.</p>\n<h2 class=\"api-section-heading\" id=\"authentication\">\n<span class=\"acc-title\">Authentication</span> <span class=\"acc-sub\" data-toc-skip-children=\"true\">Create and manage your API keys</span>\n</h2>\n<div class=\"api-section-body\">\n<p>All API requests require authentication using Bearer token authentication. Follow the steps below to create your <strong>API key. </strong></p>\n<ol>\n<li data-list-item-id=\"e2aebd956601874a48a2969154dfc2786\">Go to <a href=\"https://otter.ai/setting/developer\" target=\"_blank\" rel=\"noopener noreferrer\"><strong>Integrations → Developer</strong></a>.<strong> </strong><br><img src=\"https://help.otter.ai/hc/article_attachments/44608393062679\" width=\"1573\" height=\"866\">\n</li>\n<li data-list-item-id=\"e098ad431c11c8e1e70afc90ec3d8b7d2\">\n<p>Click <strong>Create key.</strong></p>\n<p><img src=\"https://help.otter.ai/hc/article_attachments/36793479454359\" width=\"1217\" height=\"391\"></p>\n</li>\n<li data-list-item-id=\"ec926a83b4e4b04f5133efac50d4437f0\">\n<p>Click <strong>Copy</strong> and store the API key in a safe place.</p>\n<div class=\"note flag\">\n<strong>Note:</strong> This is only visible once. Make sure you copy the API key in this pop-up. If you forget to copy, follow steps 1-3 to create another key.</div>\n<p><img src=\"https://help.otter.ai/hc/article_attachments/36793479455255\" width=\"998\" height=\"506\"></p>\n</li>\n<li data-list-item-id=\"e6f05136c2c70e076cf8f28606f59ff71\">\n<p>The API key can now be used. Follow steps 1-4 to create another API key.</p>\n<div class=\"note flag\">\n<strong>Note</strong>: There is a limit of 2 API keys per user.</div>\n<p><img src=\"https://help.otter.ai/hc/article_attachments/44608393063831\" width=\"1189\" height=\"774\"></p>\n</li>\n</ol>\n<p><strong>Using your API key:</strong></p>\n<p>Include your API key in the Authorization header for every request:</p>\n<pre class=\"language-plaintext\">Authorization: Bearer YOUR_API_KEY</pre>\n<p><strong>✅ Security best practices:</strong></p>\n<ul>\n<li data-list-item-id=\"e07643fac5403ae5f45f2e6fc93714a73\">Never share your API key publicly or commit it to version control</li>\n<li data-list-item-id=\"ed4cc514642bbaabf4b7970efa50ed8f7\">Store API keys securely using environment variables or secrets management</li>\n<li data-list-item-id=\"ea03d6516869e69bebf8625c7399256f7\">Rotate API keys periodically</li>\n</ul>\n</div>\n<h2 class=\"api-section-heading\" id=\"rate-limits\">Rate Limits</h2>\n<div class=\"api-section-body\"><p>Enterprise plan users are currently limited to 10 requests / second. If you exceed your rate limit, you'll receive a <code>429 Too Many Requests</code> response.</p></div>\n<h2 class=\"api-section-heading\" id=\"pagniation\">Pagination</h2>\n<div class=\"api-section-body\">\n<p>List endpoints use cursor-based pagination for efficient data retrieval.</p>\n<h3 id=\"pagniation-response\">Pagination Response</h3>\n<pre class=\"language-json\">{\n  \"meta\": {\n    \"retrieved_at\": \"2025-07-31T12:00:00Z\",\n    \"has_more\": true,\n    \"next_cursor\": \"next_cursor_position\"\n  },\n  \"data\": [ /* array of results */ ]\n}</pre>\n<p><strong>Meta Fields:</strong></p>\n<figure class=\"wysiwyg-table wysiwyg-table-align-left\"><table class=\"schema-table\" style=\"border-color: #2F3941;\">\n<thead><tr>\n<th style=\"border-color: #2F3941; padding: 10px; text-align: left;\">Field</th>\n<th style=\"border-color: #2F3941; padding: 10px; text-align: left;\">Type</th>\n<th style=\"border-color: #2F3941; padding: 10px; text-align: left;\">Description</th>\n</tr></thead>\n<tbody>\n<tr>\n<td style=\"border-color: #2F3941; padding: 10px; text-align: left;\"><code>retrieved_at</code></td>\n<td style=\"border-color: #2F3941; padding: 10px; text-align: left;\">string</td>\n<td style=\"border-color: #2F3941; padding: 10px; text-align: left;\">Timestamp when data was retrieved (ISO 8601 format)</td>\n</tr>\n<tr>\n<td style=\"border-color: #2F3941; padding: 10px; text-align: left;\"><code>has_more</code></td>\n<td style=\"border-color: #2F3941; padding: 10px; text-align: left;\">boolean</td>\n<td style=\"border-color: #2F3941; padding: 10px; text-align: left;\">Whether more pages are available</td>\n</tr>\n<tr>\n<td style=\"border-color: #2F3941; padding: 10px; text-align: left;\"><code>next_cursor</code></td>\n<td style=\"border-color: #2F3941; padding: 10px; text-align: left;\">string (optional)</td>\n<td style=\"border-color: #2F3941; padding: 10px; text-align: left;\">Cursor for the next page</td>\n</tr>\n</tbody>\n</table></figure><h3 id=\"usage\">Usage</h3>\n<p>To retrieve the next page, use the <code>next_cursor</code> value in your next request's <code>cursor</code> query parameter:</p>\n<pre class=\"language-plaintext\">GET /conversations?cursor=next_cursor_position&amp;limit=20</pre>\n<p>Continue paginating until <code>has_more</code> is <code>false</code>.</p>\n</div>\n<h2 id=\"webhooks\">Webhooks</h2>\n<p>Webhooks are the recommended way to build export integrations with Otter. Instead of constantly polling the API to check for new conversations or action items, webhooks push real-time notifications to your application the moment events occur. This makes webhooks ideal for automatically syncing meeting summaries to your CRM, sending action items to project management tools, or triggering custom workflows whenever a transcript is ready. By using webhooks, you'll build more efficient integrations that respond instantly to changes while staying well within API rate limits.</p>\n<div class=\"note tips\">\n<strong>Learn more: </strong>Learn how to set up webhooks with our <a href=\"https://help.otter.ai/hc/articles/35634832371735-Workspace-Webhooks\" target=\"_blank\" rel=\"noopener noreferrer\">workspace webhook documentation</a>.</div>\n<h2 id=\"endpoints\" data-toc-section=\"true\">Endpoints</h2>\n<p>Explore the available API endpoints, grouped by type.</p>\n<h2 class=\"api-section-heading\" id=\"channel\">\n<span class=\"acc-title\">Channel</span> <span class=\"acc-sub\">Endpoints for retrieving channel data</span>\n</h2>\n<div class=\"api-section-body\">\n<p>A <a href=\"https://help.otter.ai/hc/en-us/articles/360049379794-Channels-Overview\" target=\"_blank\" rel=\"noopener noreferrer\">Channel</a> lets you organize Conversations.</p>\n<ul>\n<li class=\"wysiwyg-list-bold\" data-list-item-id=\"e48fb06880259fb79b975ca91a7987cba\"><a href=\"#h_01KBNSJXP21NDHMWSCB2GMFBPZ\"><code><strong>GET /channels</strong></code></a></li>\n<li class=\"wysiwyg-list-bold\" data-list-item-id=\"e2cf08ff7b480adc8fb05aae81817cee7\"><a href=\"#h_01KPXY6D3SMX8TR052B9C3TZM5\"><code><strong>GET /channels/{id}/members</strong></code></a></li>\n</ul>\n<h3 id=\"get-channels\"><code><strong>GET /channels</strong></code></h3>\n<p>Use this endpoint to list channels for the authenticated user. Results are returned in alphabetical order by channel name.</p>\n<p><strong>Example Request:</strong></p>\n<pre class=\"language-bash\">curl -X GET \"https://api.otter.ai/v1/channels\" \\\n  -H \"Authorization: Bearer YOUR_API_KEY\"</pre>\n<p><strong>Response:</strong> Returns a <code>ChannelListResponse</code> with channel data.</p>\n<ul>\n<li data-list-item-id=\"ee63c2165ff251d4e01786c0df3e1ccbe\">\n<strong>meta</strong>: Response metadata, including retrieved_at </li>\n<li data-list-item-id=\"e70b1237b67d4284b16b01bc1cc761292\">\n<strong>data</strong>: An array of channel objects</li>\n</ul>\n<pre class=\"language-json\">{\n  \"meta\": {\n    \"retrieved_at\": \"2025-07-31T12:00:00Z\"\n  },\n  \"data\": [\n    {\n      \"id\": \"channel_id\",\n      \"name\": \"backend product meeting\",\n      \"member_count\": 50,\n      \"owner\": {\n        \"id\": \"user_id\",\n        \"name\": \"Jane Doe\",\n        \"first_name\": \"Jane\",\n        \"last_name\": \"Doe\",\n        \"email\": \"Jane@test.com\"\n      },\n      \"discoverability\": \"private\"\n    }\n  ]\n}</pre>\n<p><strong>Channel object:</strong></p>\n<figure class=\"wysiwyg-table\" style=\"width: 100%;\"><table class=\"wysiwyg-table-resized\">\n<colgroup>\n<col style=\"width: 23%;\">\n<col style=\"width: 18%;\">\n<col style=\"width: 59%;\">\n</colgroup>\n<tbody>\n<tr>\n<td style=\"padding: 10px; text-align: left;\"><strong>Field</strong></td>\n<td style=\"padding: 10px; text-align: left;\"><strong>Type</strong></td>\n<td style=\"padding: 10px; text-align: left;\"><strong>Description</strong></td>\n</tr>\n<tr>\n<td style=\"padding: 10px; text-align: left;\">id</td>\n<td style=\"padding: 10px; text-align: left;\">string</td>\n<td style=\"padding: 10px; text-align: left;\">Unique channel identifier</td>\n</tr>\n<tr>\n<td style=\"padding: 10px; text-align: left;\">name</td>\n<td style=\"padding: 10px; text-align: left;\">string</td>\n<td style=\"padding: 10px; text-align: left;\">Name of the channel</td>\n</tr>\n<tr>\n<td style=\"padding: 10px; text-align: left;\">member_count</td>\n<td style=\"padding: 10px; text-align: left;\">integer</td>\n<td style=\"padding: 10px; text-align: left;\">Number of members in the channel</td>\n</tr>\n<tr>\n<td style=\"padding: 10px; text-align: left;\">owner</td>\n<td style=\"padding: 10px; text-align: left;\">User</td>\n<td style=\"padding: 10px; text-align: left;\">Owner of the channel</td>\n</tr>\n<tr>\n<td style=\"padding: 10px; text-align: left;\">discoverability</td>\n<td style=\"padding: 10px; text-align: left;\">string</td>\n<td style=\"padding: 10px; text-align: left;\">Channel visibility setting, such as <code>private</code> or <code>workspace</code> (public)</td>\n</tr>\n</tbody>\n</table></figure><p><strong>Error Response(s):</strong></p>\n<figure class=\"wysiwyg-table\" style=\"width: 100%;\"><table><tbody>\n<tr>\n<td style=\"padding: 10px; text-align: left;\"><strong>Status</strong></td>\n<td style=\"padding: 10px; text-align: left;\"><strong>Description</strong></td>\n</tr>\n<tr>\n<td style=\"padding: 10px; text-align: left;\">400</td>\n<td style=\"padding: 10px; text-align: left;\">Invalid request parameters</td>\n</tr>\n</tbody></table></figure><h3 id=\"get-channel-members\"><code><strong>GET /channels/{id}/members</strong></code></h3>\n<p>Use this endpoint to list all members in a specific channel. Results are returned in alphabetical order by member name.</p>\n<p><strong>Path Parameter:</strong></p>\n<figure class=\"wysiwyg-table wysiwyg-table-align-left\" style=\"width: 100%;\"><table style=\"border-collapse: collapse; border-spacing: 0px;\">\n<thead><tr>\n<th style=\"padding: 10px; text-align: left;\"><strong>Parameter</strong></th>\n<th style=\"padding: 10px; text-align: left;\"><strong>Type</strong></th>\n<th style=\"padding: 10px; text-align: left;\"><strong>Required</strong></th>\n<th style=\"padding: 10px; text-align: left;\"><strong>Description</strong></th>\n</tr></thead>\n<tbody><tr>\n<td style=\"padding: 10px; text-align: left;\">id</td>\n<td style=\"padding: 10px; text-align: left;\">string</td>\n<td style=\"padding: 10px; text-align: left;\">Yes</td>\n<td style=\"padding: 10px; text-align: left;\">Channel ID</td>\n</tr></tbody>\n</table></figure><p><strong>Example Request:</strong></p>\n<pre class=\"language-bash\">curl -X GET \"https://api.otter.ai/v1/channels/{id}/members\" \\\n  -H \"Authorization: Bearer YOUR_API_KEY\"</pre>\n<p><strong>Response: </strong>Returns a <code>ChannelMembersResponse</code> containing a list of users in the channel.</p>\n<ul>\n<li data-list-item-id=\"e3bf932e5e0f0948a9c8f1bf8fef98ef4\">\n<strong>meta:</strong> Response metadata, including retrieved_at</li>\n<li data-list-item-id=\"ef69c04eca838361cc84c76cf06e40f33\">\n<strong>data: </strong>An array of user objects</li>\n</ul>\n<pre class=\"language-json\">{\n  \"meta\": {\n    \"retrieved_at\": \"2026-04-23T18:57:09Z\"\n  },\n  \"data\": [\n    {\n      \"id\": \"a1B2c3D4e5F6g7H8\",\n      \"name\": \"Jane Doe\",\n      \"first_name\": \"Jane\",\n      \"last_name\": \"Doe\",\n      \"email\": \"jane.doe@example.com\"\n    },\n    {\n      \"id\": \"h8G7f6E5d4C3b2A1\",\n      \"name\": \"John Smith\",\n      \"first_name\": \"John\",\n      \"last_name\": \"Smith\",\n      \"email\": \"john.smith@example.com\"\n    },\n    {\n      \"id\": \"z9Y8x7W6v5U4t3S2\",\n      \"name\": \"Alex Johnson\",\n      \"first_name\": \"Alex\",\n      \"last_name\": \"Johnson\",\n      \"email\": \"alex.johnson@example.com\"\n    }\n  ]\n}</pre>\n<p><strong>User Object:</strong></p>\n<figure class=\"wysiwyg-table wysiwyg-table-align-left\" style=\"width: 100%;\"><table style=\"border-collapse: collapse; border-spacing: 0px;\">\n<thead><tr>\n<th style=\"padding: 10px; text-align: left;\"><strong>Field</strong></th>\n<th style=\"padding: 10px; text-align: left;\"><strong>Type</strong></th>\n<th style=\"padding: 10px; text-align: left;\"><strong>Description</strong></th>\n</tr></thead>\n<tbody>\n<tr>\n<td style=\"padding: 10px; text-align: left;\">id</td>\n<td style=\"padding: 10px; text-align: left;\">string</td>\n<td style=\"padding: 10px; text-align: left;\">Unique user identifier</td>\n</tr>\n<tr>\n<td style=\"padding: 10px; text-align: left;\">name</td>\n<td style=\"padding: 10px; text-align: left;\">string</td>\n<td style=\"padding: 10px; text-align: left;\">Full name of the user</td>\n</tr>\n<tr>\n<td style=\"padding: 10px; text-align: left;\">first_name</td>\n<td style=\"padding: 10px; text-align: left;\">string</td>\n<td style=\"padding: 10px; text-align: left;\">User’s first name</td>\n</tr>\n<tr>\n<td style=\"padding: 10px; text-align: left;\">last_name</td>\n<td style=\"padding: 10px; text-align: left;\">string</td>\n<td style=\"padding: 10px; text-align: left;\">User’s last name</td>\n</tr>\n<tr>\n<td style=\"padding: 10px; text-align: left;\">email</td>\n<td style=\"padding: 10px; text-align: left;\">string</td>\n<td style=\"padding: 10px; text-align: left;\">User’s email address</td>\n</tr>\n</tbody>\n</table></figure><p><strong>Error Responses:</strong></p>\n<figure class=\"wysiwyg-table wysiwyg-table-align-left\" style=\"width: 100%;\"><table style=\"border-collapse: collapse; border-spacing: 0px;\">\n<thead><tr>\n<th style=\"padding: 10px; text-align: left;\"><strong>Status</strong></th>\n<th style=\"padding: 10px; text-align: left;\"><strong>Description</strong></th>\n</tr></thead>\n<tbody>\n<tr>\n<td style=\"padding: 10px; text-align: left;\">400</td>\n<td style=\"padding: 10px; text-align: left;\">Invalid request parameters</td>\n</tr>\n<tr>\n<td style=\"padding: 10px; text-align: left;\">404</td>\n<td style=\"padding: 10px; text-align: left;\">Channel not found</td>\n</tr>\n</tbody>\n</table></figure>\n</div>\n<h2 class=\"api-section-heading\" id=\"conversations\">\n<span class=\"acc-title\">Conversations</span> <span class=\"acc-sub\">Endpoints to create, list, and retrieve conversations, including conversation details and audio downloads</span>\n</h2>\n<div class=\"api-section-body\">\n<ul>\n<li data-list-item-id=\"e6d18531e1813aabd3835b949e3e7a9ec\"><a href=\"#h_01KBNSJXPDMZ04JZE8E1FDQRD0\"><code class=\"schema-table\">POST /conversations</code></a></li>\n<li data-list-item-id=\"e3ef25681af72d1c4ca60e7f610dc7baf\"><a href=\"#h_01KBNSJXPHRBYN8T4SMKJ6ARX1\"><code>GET /conversations</code></a></li>\n<li data-list-item-id=\"eb69fbe26e931541cb315e79355f14fb3\"><a href=\"#h_01KBNSJXPNPBZ4J7XEQY634J29\"><code>GET /conversations/{id}</code></a></li>\n<li data-list-item-id=\"ebfc4a40bd01da3719601d7d1f10cf0cb\"><a href=\"#h_01KNMHQX63N90MNTWCVATQVCA4\"><code>GET /conversations/{id}/audio</code></a></li>\n</ul>\n<h3 id=\"post-conversations\"><code><strong>POST /conversations</strong></code></h3>\n<p>Creates a new conversation from a file. This is useful if you are importing calls into Otter, such as from a Dialer.</p>\n<p><strong>Request Body:</strong></p>\n<figure class=\"wysiwyg-table wysiwyg-table-align-left\"><table class=\"schema-table\" style=\"border-color: #2F3941;\">\n<thead><tr>\n<th style=\"border-color: #2F3941; padding: 10px; text-align: left;\">Field</th>\n<th style=\"border-color: #2F3941; padding: 10px; text-align: left;\">Type</th>\n<th style=\"border-color: #2F3941; padding: 10px; text-align: left;\">Required</th>\n<th style=\"border-color: #2F3941; padding: 10px; text-align: left;\">Description</th>\n</tr></thead>\n<tbody>\n<tr>\n<td style=\"border-color: #2F3941; padding: 10px; text-align: left;\"><code>file</code></td>\n<td style=\"border-color: #2F3941; padding: 10px; text-align: left;\">string (URL)</td>\n<td style=\"border-color: #2F3941; padding: 10px; text-align: left;\">Yes</td>\n<td style=\"border-color: #2F3941; padding: 10px; text-align: left;\">URL to the file to process</td>\n</tr>\n<tr>\n<td style=\"border-color: #2F3941; padding: 10px; text-align: left;\"><code>name</code></td>\n<td style=\"border-color: #2F3941; padding: 10px; text-align: left;\">string</td>\n<td style=\"border-color: #2F3941; padding: 10px; text-align: left;\">No</td>\n<td style=\"border-color: #2F3941; padding: 10px; text-align: left;\">Name for the conversation</td>\n</tr>\n</tbody>\n</table></figure><p><strong>Example Request:</strong></p>\n<pre class=\"language-bash\">curl -X POST \"https://api.otter.ai/v1/conversations\" \\\n  -H \"Authorization: Bearer YOUR_API_KEY\" \\\n  -H \"Content-Type: application/json\" \\\n  -d '{\n    \"file\": \"https://example.com/file.mp4\",\n    \"name\": \"Product Launch Meeting\"\n  }'</pre>\n<p><strong>Response:</strong> Returns a <code>ConversationCreateResponse</code> with status.</p>\n<pre class=\"language-json\">{\n \"status\": \"success\",\n \"completed_at\": \"2025-12-01 01:00:00Z\",\n \"file\": \"audio.mp3\"\n}</pre>\n<h3 id=\"get-conversations\"><code><strong>GET /conversations</strong></code></h3>\n<p>Use this endpoint to list conversations for the authenticated user. Results are returned in reverse chronological order (most recent first) and use cursor-based pagination for efficient retrieval. You can optionally include shared conversations or filter results by channel.</p>\n<div class=\"note tips\">\n<strong>Tip</strong>: Use <a href=\"https://help.otter.ai/hc/articles/35634832371735-Workspace-Webhooks\" target=\"_blank\" rel=\"noopener noreferrer\">workspace webhooks</a> to receive Conversation data in real-time!</div>\n<p><strong>Query Parameters:</strong></p>\n<figure class=\"wysiwyg-table wysiwyg-table-align-left\" style=\"width: 100%;\"><table class=\"schema-table wysiwyg-table-resized\" style=\"border-color: #2F3941;\">\n<colgroup>\n<col style=\"width: 24%;\">\n<col style=\"width: 12%;\">\n<col style=\"width: 18%;\">\n<col style=\"width: 46%;\">\n</colgroup>\n<thead><tr>\n<th style=\"padding: 10px; text-align: left;\"><strong>Parameter</strong></th>\n<th style=\"padding: 10px; text-align: left;\"><strong>Type</strong></th>\n<th style=\"padding: 10px; text-align: left;\"><strong>Required</strong></th>\n<th style=\"padding: 10px; text-align: left;\"><strong>Description</strong></th>\n</tr></thead>\n<tbody>\n<tr>\n<td style=\"padding: 10px; text-align: left;\">include_shared</td>\n<td style=\"padding: 10px; text-align: left;\">boolean</td>\n<td style=\"padding: 10px; text-align: left;\">No</td>\n<td style=\"padding: 10px; text-align: left;\">Whether to include conversations shared with the user. Default: false. Automatically set to true if channel_id is provided</td>\n</tr>\n<tr>\n<td style=\"padding: 10px; text-align: left;\">channel_id</td>\n<td style=\"padding: 10px; text-align: left;\">string</td>\n<td style=\"padding: 10px; text-align: left;\">No</td>\n<td style=\"padding: 10px; text-align: left;\">Filter conversations by channel ID. Overrides include_shared</td>\n</tr>\n<tr>\n<td style=\"padding: 10px; text-align: left;\">limit</td>\n<td style=\"padding: 10px; text-align: left;\">integer</td>\n<td style=\"padding: 10px; text-align: left;\">No</td>\n<td style=\"padding: 10px; text-align: left;\">Number of items to return per page. Minimum: 1, Maximum: 20</td>\n</tr>\n<tr>\n<td style=\"padding: 10px; text-align: left;\">cursor</td>\n<td style=\"padding: 10px; text-align: left;\">string</td>\n<td style=\"padding: 10px; text-align: left;\">No</td>\n<td style=\"padding: 10px; text-align: left;\">Cursor for pagination. Use the next_cursor value from the previous response to retrieve the next page</td>\n</tr>\n</tbody>\n</table></figure><p><strong>Example Request:</strong></p>\n<pre class=\"language-bash\">curl -X GET \"https://api.otter.ai/v1/conversations?include_shared=false&amp;channel_id=&amp;limit=20&amp;cursor=\" \\\n  -H \"Authorization: Bearer YOUR_API_KEY\"</pre>\n<p><strong>Response:</strong> Returns a <code>ConversationListResponse</code> with conversation data and pagination metadata.</p>\n<ul>\n<li data-list-item-id=\"efa8fade636245daf8bc6b6e8d2c1efd6\">\n<strong>meta</strong>: Pagination metadata, including retrieved_at, has_more, and next_cursor </li>\n<li data-list-item-id=\"e021a9dc9fdcc38407e285e00679dc8fa\">\n<strong>data</strong>: An array of conversation objects</li>\n</ul>\n<pre class=\"language-json\">{\n  \"meta\": {\n    \"retrieved_at\": \"2025-07-31T12:00:00Z\",\n    \"has_more\": true,\n    \"next_cursor\": \"next_cursor_position\"\n  },\n  \"data\": [\n    {\n      \"id\": \"conversation_id\",\n      \"title\": \"product launch meeting\",\n      \"url\": \"https://otter.ai/u/conversation_id\",\n      \"owner\": {\n        \"id\": \"user_id\",\n        \"name\": \"Jane Doe\",\n        \"first_name\": \"Jane\",\n        \"last_name\": \"Doe\",\n        \"email\": \"Jane@test.com\"\n      },\n      \"created_at\": \"2025-07-31T12:00:00Z\",\n      \"process_status\": {\n        \"abstract_summary\": null,\n        \"action_item\": null,\n        \"outline\": null\n      },\n      \"calendar_guests\": [\n        {\n          \"name\": \"John Doe\",\n          \"email\": \"john@test.com\"\n        }\n      ],\n      \"shared_emails\": [\n        {\n          \"email\": \"hello@example.com\",\n          \"user\": {\n            \"id\": \"user_id\",\n            \"name\": \"Jane Doe\",\n            \"first_name\": \"Jane\",\n            \"last_name\": \"Doe\",\n            \"email\": \"Jane@test.com\"\n          },\n          \"permission\": \"collaborate\"\n        }\n      ],\n      \"shared_channels\": [\n        {\n          \"channel\": {\n            \"id\": \"channel_id\",\n            \"name\": \"backend product meeting\",\n            \"member_count\": 50,\n            \"owner\": {\n              \"id\": \"user_id\",\n              \"name\": \"Jane Doe\",\n              \"first_name\": \"Jane\",\n              \"last_name\": \"Doe\",\n              \"email\": \"Jane@test.com\"\n            },\n            \"discoverability\": \"private\"\n          },\n          \"permission\": \"collaborate\"\n        }\n      ],\n      \"abstract_summary\": \"This meeting discussed the next steps in the project launch\",\n      \"conf_join_url\": \"https://zoom.us/j/1234567890\"\n    }\n  ]\n}</pre>\n<p><strong>Pagination:</strong></p>\n<ul>\n<li data-list-item-id=\"ef2b81c3987cea9a1ab84592234dceaa8\">\n<strong>has_more</strong>: Indicates whether additional results are available </li>\n<li data-list-item-id=\"e8c4a733f2ac43d39ef60443af1ceaa29\">\n<strong>next_cursor</strong>: Use this value in the next request to retrieve the next page</li>\n</ul>\n<p><strong>Conversation object:</strong></p>\n<figure class=\"wysiwyg-table\" style=\"width: 100%;\"><table class=\"wysiwyg-table-resized\">\n<colgroup>\n<col style=\"width: 27%;\">\n<col style=\"width: 22%;\">\n<col style=\"width: 51%;\">\n</colgroup>\n<thead><tr>\n<th style=\"padding: 10px; text-align: left;\"><strong>Field</strong></th>\n<th style=\"padding: 10px; text-align: left;\"><strong>Type</strong></th>\n<th style=\"padding: 10px; text-align: left;\"><strong>Description</strong></th>\n</tr></thead>\n<tbody>\n<tr>\n<td style=\"padding: 10px; text-align: left;\">id</td>\n<td style=\"padding: 10px; text-align: left;\">string</td>\n<td style=\"padding: 10px; text-align: left;\">Unique conversation identifier</td>\n</tr>\n<tr>\n<td style=\"padding: 10px; text-align: left;\">title</td>\n<td style=\"padding: 10px; text-align: left;\">string</td>\n<td style=\"padding: 10px; text-align: left;\">Title of the conversation</td>\n</tr>\n<tr>\n<td style=\"padding: 10px; text-align: left;\">url</td>\n<td style=\"padding: 10px; text-align: left;\">string</td>\n<td style=\"padding: 10px; text-align: left;\">URL to view the conversation in Otter</td>\n</tr>\n<tr>\n<td style=\"padding: 10px; text-align: left;\">owner</td>\n<td style=\"padding: 10px; text-align: left;\">User</td>\n<td style=\"padding: 10px; text-align: left;\">Owner of the conversation</td>\n</tr>\n<tr>\n<td style=\"padding: 10px; text-align: left;\">created_at</td>\n<td style=\"padding: 10px; text-align: left;\">string</td>\n<td style=\"padding: 10px; text-align: left;\">Timestamp when the conversation was created</td>\n</tr>\n<tr>\n<td style=\"padding: 10px; text-align: left;\">process_status</td>\n<td style=\"padding: 10px; text-align: left;\">object</td>\n<td style=\"padding: 10px; text-align: left;\">Processing status for generated data such as summary, action items, and outline</td>\n</tr>\n<tr>\n<td style=\"padding: 10px; text-align: left;\">calendar_guests</td>\n<td style=\"padding: 10px; text-align: left;\">array</td>\n<td style=\"padding: 10px; text-align: left;\">List of calendar guests associated with the conversation</td>\n</tr>\n<tr>\n<td style=\"padding: 10px; text-align: left;\">shared_emails</td>\n<td style=\"padding: 10px; text-align: left;\">array</td>\n<td style=\"padding: 10px; text-align: left;\">List of users or email addresses the conversation is shared with</td>\n</tr>\n<tr>\n<td style=\"padding: 10px; text-align: left;\">shared_channels</td>\n<td style=\"padding: 10px; text-align: left;\">array</td>\n<td style=\"padding: 10px; text-align: left;\">List of channels the conversation is shared with</td>\n</tr>\n<tr>\n<td style=\"padding: 10px; text-align: left;\">abstract_summary</td>\n<td style=\"padding: 10px; text-align: left;\">string</td>\n<td style=\"padding: 10px; text-align: left;\">Generated summary of the conversation</td>\n</tr>\n<tr>\n<td style=\"padding: 10px; text-align: left;\">conf_join_url</td>\n<td style=\"padding: 10px; text-align: left;\">string</td>\n<td style=\"padding: 10px; text-align: left;\">Conferencing join URL associated with the conversation</td>\n</tr>\n</tbody>\n</table></figure><p><strong>Shared channel object:</strong></p>\n<figure class=\"wysiwyg-table wysiwyg-table-align-left\" style=\"width: 100%;\"><table class=\"wysiwyg-table-resized\" style=\"border-collapse: collapse; border-spacing: 0px;\">\n<colgroup>\n<col style=\"width: 27%;\">\n<col style=\"width: 19%;\">\n<col style=\"width: 54%;\">\n</colgroup>\n<thead><tr>\n<th style=\"padding: 10px; text-align: left;\"><strong>Field</strong></th>\n<th style=\"padding: 10px; text-align: left;\"><strong>Type</strong></th>\n<th style=\"padding: 10px; text-align: left;\"><strong>Description</strong></th>\n</tr></thead>\n<tbody>\n<tr>\n<td style=\"padding: 10px; text-align: left;\">id</td>\n<td style=\"padding: 10px; text-align: left;\">string</td>\n<td style=\"padding: 10px; text-align: left;\">Unique channel identifier</td>\n</tr>\n<tr>\n<td style=\"padding: 10px; text-align: left;\">name</td>\n<td style=\"padding: 10px; text-align: left;\">string</td>\n<td style=\"padding: 10px; text-align: left;\">Name of the channel</td>\n</tr>\n<tr>\n<td style=\"padding: 10px; text-align: left;\">member_count</td>\n<td style=\"padding: 10px; text-align: left;\">integer</td>\n<td style=\"padding: 10px; text-align: left;\">Number of members in the channel</td>\n</tr>\n<tr>\n<td style=\"padding: 10px; text-align: left;\">owner</td>\n<td style=\"padding: 10px; text-align: left;\">User</td>\n<td style=\"padding: 10px; text-align: left;\">Owner of the channel</td>\n</tr>\n<tr>\n<td style=\"padding: 10px; text-align: left;\">discoverability</td>\n<td style=\"padding: 10px; text-align: left;\">string</td>\n<td style=\"padding: 10px; text-align: left;\">Channel visibility setting, such as <code>private</code> or <code>workspace</code> (public)</td>\n</tr>\n</tbody>\n</table></figure><p><strong>Error Responses:</strong></p>\n<figure class=\"wysiwyg-table\" style=\"width: 100%;\"><table class=\"wysiwyg-table-resized\">\n<colgroup>\n<col style=\"width: 22%;\">\n<col style=\"width: 78%;\">\n</colgroup>\n<thead><tr>\n<th style=\"padding: 10px; text-align: left;\"><strong>Status</strong></th>\n<th style=\"padding: 10px; text-align: left;\"><strong>Description</strong></th>\n</tr></thead>\n<tbody>\n<tr>\n<td style=\"padding: 10px; text-align: left;\">400</td>\n<td style=\"padding: 10px; text-align: left;\">Invalid filter or pagination parameters</td>\n</tr>\n<tr>\n<td style=\"padding: 10px; text-align: left;\">404</td>\n<td style=\"padding: 10px; text-align: left;\">Channel not found</td>\n</tr>\n</tbody>\n</table></figure><h3 id=\"get-conversation-ids\"><code><strong>GET /conversations/{id}</strong></code></h3>\n<p>Use this endpoint to get the summary and details of a specific conversation. You can optionally include additional conversation data such as action items, insights, outlines, transcript, or all available relationships.</p>\n<div class=\"note tips\">\n<strong>Tip</strong>: Use <a href=\"https://help.otter.ai/hc/articles/35634832371735-Workspace-Webhooks\" target=\"_blank\" rel=\"noopener noreferrer\">workspace webhooks</a> to receive Conversation data in real-time!</div>\n<p><strong>Path Parameters:</strong></p>\n<figure class=\"wysiwyg-table\" style=\"width: 100%;\"><table><tbody>\n<tr>\n<td style=\"padding: 10px; text-align: left;\"><strong>Parameter</strong></td>\n<td style=\"padding: 10px; text-align: left;\"><strong>Type</strong></td>\n<td style=\"padding: 10px; text-align: left;\"><strong>Required</strong></td>\n<td style=\"padding: 10px; text-align: left;\"><strong>Description</strong></td>\n</tr>\n<tr>\n<td style=\"padding: 10px; text-align: left;\">id</td>\n<td style=\"padding: 10px; text-align: left;\">string</td>\n<td style=\"padding: 10px; text-align: left;\">Yes</td>\n<td style=\"padding: 10px; text-align: left;\">Conversation ID</td>\n</tr>\n</tbody></table></figure><p><strong>Query Parameters:</strong></p>\n<figure class=\"wysiwyg-table wysiwyg-table-align-left\" style=\"width: 100%;\"><table class=\"schema-table wysiwyg-table-resized\" style=\"border-color: #2F3941;\">\n<colgroup>\n<col style=\"width: 19%;\">\n<col style=\"width: 11%;\">\n<col style=\"width: 17%;\">\n<col style=\"width: 53%;\">\n</colgroup>\n<tbody>\n<tr>\n<td style=\"padding: 10px; text-align: left;\"><strong>Parameter</strong></td>\n<td style=\"padding: 10px; text-align: left;\"><strong>Type</strong></td>\n<td style=\"padding: 10px; text-align: left;\"><strong>Required</strong></td>\n<td style=\"padding: 10px; text-align: left;\"><strong>Description</strong></td>\n</tr>\n<tr>\n<td style=\"padding: 10px; text-align: left;\">include</td>\n<td style=\"padding: 10px; text-align: left;\">string</td>\n<td style=\"padding: 10px; text-align: left;\">Yes</td>\n<td style=\"padding: 10px; text-align: left;\">Comma-separated list of additional data to include. Options: <code>action_items</code>, <code>insights</code>, <code>outline</code>, <code>transcript</code>, <code>all</code>. If all is specified, all available relationship fields are returned. Example: <code>insights,transcript</code>\n</td>\n</tr>\n</tbody>\n</table></figure><p><strong>Example Request:</strong></p>\n<pre class=\"language-bash\">curl -X GET \"https://api.otter.ai/v1/conversations/{id}?include=action_items\" \\\n  -H \"Authorization: Bearer YOUR_API_KEY\"</pre>\n<ul><li data-list-item-id=\"ef6d7ae01c3aefdcc5fe5288c46a40903\">\n<p><strong>Response:</strong> Returns a <code>ConversationResponse</code> with conversation details and requested relationships.</p>\n<ul>\n<li data-list-item-id=\"e7ff947cb738e2419936fd5b0f961b277\">\n<strong>meta</strong>: Response metadata, including retrieved_at </li>\n<li data-list-item-id=\"e4d73dd1c997dba537d930943aa617ea3\">\n<strong>data</strong>: The conversation object </li>\n<li data-list-item-id=\"ecd29a5f701a47e8dee7e23f24f6d196d\">\n<strong>relationships</strong>: Additional related data returned when requested with the include parameter</li>\n</ul>\n<pre class=\"language-json\">{\n  \"meta\": {\n    \"retrieved_at\": \"2025-07-31T12:00:00Z\"\n  },\n  \"data\": {\n    \"relationships\": {\n      \"action_items\": [\n        {\n          \"id\": \"action_item_id\",\n          \"text\": \"Follow up with the sales team\",\n          \"assignee\": {\n            \"id\": \"user_id\",\n            \"name\": \"Jane Doe\",\n            \"first_name\": \"Jane\",\n            \"last_name\": \"Doe\",\n            \"email\": \"Jane@test.com\"\n          },\n          \"status\": {\n            \"completed\": true,\n            \"created_at\": \"2025-07-31T12:00:00Z\",\n            \"last_modified_at\": \"2025-07-31T12:00:00Z\",\n            \"completed_at\": \"2025-07-31T12:00:00Z\"\n          }\n        }\n      ],\n      \"insights\": null,\n      \"outline\": null,\n      \"transcript\": null,\n      \"custom_prompt\": null\n    },\n    \"id\": \"conversation_id\",\n    \"title\": \"product launch meeting\",\n    \"url\": \"https://otter.ai/u/conversation_id\",\n    \"owner\": {\n      \"id\": \"user_id\",\n      \"name\": \"Jane Doe\",\n      \"first_name\": \"Jane\",\n      \"last_name\": \"Doe\",\n      \"email\": \"Jane@test.com\"\n    },\n    \"created_at\": \"2025-07-31T12:00:00Z\",\n    \"process_status\": {\n      \"abstract_summary\": null,\n      \"action_item\": null,\n      \"outline\": null\n    },\n    \"calendar_guests\": [\n      {\n        \"name\": \"John Doe\",\n        \"email\": \"john@test.com\"\n      }\n    ],\n    \"shared_emails\": [\n      {\n        \"email\": \"hello@example.com\",\n        \"user\": {\n          \"id\": \"user_id\",\n          \"name\": \"Jane Doe\",\n          \"first_name\": \"Jane\",\n          \"last_name\": \"Doe\",\n          \"email\": \"Jane@test.com\"\n        },\n        \"permission\": \"collaborate\"\n      }\n    ],\n    \"shared_channels\": [\n      {\n        \"channel\": {\n          \"id\": \"channel_id\",\n          \"name\": \"backend product meeting\",\n          \"member_count\": 50,\n          \"owner\": {\n            \"id\": \"user_id\",\n            \"name\": \"Jane Doe\",\n            \"first_name\": \"Jane\",\n            \"last_name\": \"Doe\",\n            \"email\": \"Jane@test.com\"\n          },\n          \"discoverability\": \"private\"\n        },\n        \"permission\": \"collaborate\"\n      }\n    ],\n    \"abstract_summary\": \"This meeting discussed the next steps in the project launch\",\n    \"conf_join_url\": \"https://zoom.us/j/1234567890\"\n  }\n}</pre>\n</li></ul>\n<p><strong>Example Request:</strong></p>\n<pre class=\"language-bash\">curl -X GET \"https://api.otter.ai/v1/conversations/conversation_id?include=all\" \\\n  -H \"Authorization: Bearer YOUR_API_KEY\"</pre>\n<ul><li data-list-item-id=\"ed8d02459a5d9df81e6b8129056bdbd08\">\n<p><strong>Response:</strong> Returns a <code>ConversationResponse</code> with conversation details and requested relationships.</p>\n<ul>\n<li data-list-item-id=\"e20fa9d753403b6f12ae07ed0b236fbd3\">\n<strong>meta</strong>: Response metadata, including retrieved_at </li>\n<li data-list-item-id=\"e56468b0851c72895985c4fceb35595fb\">\n<strong>data</strong>: The conversation object </li>\n<li data-list-item-id=\"ec137d3d3dd741b26e5655a89f3bf5bfc\">\n<strong>relationships</strong>: Additional related data returned when requested with the include parameter</li>\n</ul>\n<pre class=\"language-json\">{\n  \"meta\": {\n    \"retrieved_at\": \"2025-10-05T12:00:00Z\"\n  },\n  \"data\": {\n    \"id\": \"conversation_id\",\n    \"title\": \"Customer Discovery Call – ACME Corp\",\n    \"url\": \"https://otter.ai/u/conversation_id\",\n    \"owner\": {\n      \"id\": \"owner_id\",\n      \"name\": \"Jane Doe\",\n      \"first_name\": \"Jane\",\n      \"last_name\": \"Doe\",\n      \"email\": \"jane.doe@example.com\"\n    },\n    \"created_at\": \"2025-10-05T11:55:00Z\",\n    \"process_status\": {\n      \"abstract_summary\": \"finished\",\n      \"action_item\": \"finished\",\n      \"outline\": \"finished\"\n    },\n    \"calendar_guests\": null,\n    \"shared_emails\": [],\n    \"shared_channels\": [\n      {\n        \"channel\": {\n          \"id\": \"channel_id\",\n          \"name\": \"All customer calls\",\n          \"member_count\": 25,\n          \"owner\": {\n            \"id\": \"channel_owner_id\",\n            \"name\": \"John Smith\",\n            \"first_name\": \"John\",\n            \"last_name\": \"Smith\",\n            \"email\": \"john.smith@example.com\"\n          },\n          \"discoverability\": \"workspace\"\n        },\n        \"permission\": \"collaborate\"\n      }\n    ],\n    \"abstract_summary\": \"The team met with ACME Corp to confirm their requirements, discuss pricing options, and align on an evaluation timeline for adopting Otter.ai across their go-to-market team.\",\n    \"conf_join_url\": \"https://zoom.us/j/00000000000\",\n    \"relationships\": {\n      \"action_items\": [\n        {\n          \"id\": \"action_item_id_1\",\n          \"text\": \"Send follow-up email with pricing summary and implementation overview.\",\n          \"assignee\": {\n            \"id\": \"owner_id\",\n            \"name\": \"Jane Doe\",\n            \"first_name\": \"Jane\",\n            \"last_name\": \"Doe\",\n            \"email\": \"jane.doe@example.com\"\n          },\n          \"status\": null\n        },\n        {\n          \"id\": \"action_item_id_2\",\n          \"text\": \"ACME to confirm final user count and preferred contract term.\",\n          \"assignee\": {\n            \"id\": \"customer_contact_id\",\n            \"name\": \"Alex Taylor\",\n            \"first_name\": \"Alex\",\n            \"last_name\": \"Taylor\",\n            \"email\": \"alex.taylor@example.com\"\n          },\n          \"status\": null\n        }\n      ],\n      \"insights\": [\n        {\n          \"topic\": \"Budget\",\n          \"text\": [\n            \"ACME has a preliminary budget in place and is comfortable with a per-seat model as long as usage is clear.\",\n            \"They are open to a flat-rate option if it simplifies internal approvals.\"\n          ]\n        },\n        {\n          \"topic\": \"Authority\",\n          \"text\": [\n            \"Alex Taylor is the main champion, but final approval will come from the VP of Operations.\",\n            \"Security and procurement teams will review the proposal before signature.\"\n          ]\n        },\n        {\n          \"topic\": \"Need\",\n          \"text\": [\n            \"ACME needs automated call summaries for customer meetings and better visibility into team activity.\",\n            \"They want to reduce manual note-taking and ensure consistent follow-up on action items.\"\n          ]\n        },\n        {\n          \"topic\": \"Timeline\",\n          \"text\": [\n            \"They aim to complete evaluation this month and go live at the start of next quarter.\",\n            \"Next internal decision checkpoint is scheduled for next week.\"\n          ]\n        }\n      ],\n      \"outline\": [\n        {\n          \"section\": \"Introductions and Context\",\n          \"text\": [\n            \"Participants introduced themselves and clarified roles.\",\n            \"ACME shared context on their current workflow and challenges with manual note-taking.\"\n          ]\n        },\n        {\n          \"section\": \"Pricing and Rollout Options\",\n          \"text\": [\n            \"The team reviewed per-seat and flat-rate pricing options.\",\n            \"They discussed rollout plans starting with key go-to-market teams and expanding later.\"\n          ]\n        }\n      ],\n      \"transcript\": {\n        \"content\": \"Jane Doe  00:00\\nThanks everyone for joining today. I’d love to understand how your team handles customer calls and where Otter might help.\\n\\nAlex Taylor  00:07\\nRight now we take notes manually, and we often miss details or lose track of follow-ups after the meeting.\\n\\nJane Doe  00:14\\nThat makes sense. Otter can automatically capture the conversation, generate summaries, and highlight key action items.\\n\\nAlex Taylor  00:21\\nThat would be really valuable for us, especially for onboarding new reps and improving consistency.\\n\\nJane Doe  00:28\\nGreat—I'll send a follow-up with pricing options and a proposed rollout timeline.\\n\\nAlex Taylor  00:35\\nSounds good. We'll review internally and get back to you this week.\",\n        \"format\": \"txt\"\n      },\n      \"custom_prompt\": null\n    }\n  }\n}</pre>\n</li></ul>\n<p><strong>Conversation object:</strong></p>\n<figure class=\"wysiwyg-table\" style=\"width: 100%;\"><table class=\"wysiwyg-table-resized\">\n<colgroup>\n<col style=\"width: 29%;\">\n<col style=\"width: 16%;\">\n<col style=\"width: 55%;\">\n</colgroup>\n<tbody>\n<tr>\n<td style=\"padding: 10px; text-align: left;\"><strong>Field</strong></td>\n<td style=\"padding: 10px; text-align: left;\"><strong>Type</strong></td>\n<td style=\"padding: 10px; text-align: left;\"><strong>Description</strong></td>\n</tr>\n<tr>\n<td style=\"padding: 10px; text-align: left;\">id</td>\n<td style=\"padding: 10px; text-align: left;\">string</td>\n<td style=\"padding: 10px; text-align: left;\">Unique conversation identifier</td>\n</tr>\n<tr>\n<td style=\"padding: 10px; text-align: left;\">title</td>\n<td style=\"padding: 10px; text-align: left;\">string</td>\n<td style=\"padding: 10px; text-align: left;\">Title of the conversation</td>\n</tr>\n<tr>\n<td style=\"padding: 10px; text-align: left;\">url</td>\n<td style=\"padding: 10px; text-align: left;\">string</td>\n<td style=\"padding: 10px; text-align: left;\">URL to view the conversation in Otter</td>\n</tr>\n<tr>\n<td style=\"padding: 10px; text-align: left;\">owner</td>\n<td style=\"padding: 10px; text-align: left;\">User</td>\n<td style=\"padding: 10px; text-align: left;\">Owner of the conversation</td>\n</tr>\n<tr>\n<td style=\"padding: 10px; text-align: left;\">created_at</td>\n<td style=\"padding: 10px; text-align: left;\">string</td>\n<td style=\"padding: 10px; text-align: left;\">Timestamp when the conversation was created</td>\n</tr>\n<tr>\n<td style=\"padding: 10px; text-align: left;\">process_status</td>\n<td style=\"padding: 10px; text-align: left;\">object</td>\n<td style=\"padding: 10px; text-align: left;\">Processing status for generated data such as summary, action items, and outline</td>\n</tr>\n<tr>\n<td style=\"padding: 10px; text-align: left;\">calendar_guests</td>\n<td style=\"padding: 10px; text-align: left;\">array</td>\n<td style=\"padding: 10px; text-align: left;\">List of calendar guests associated with the conversation</td>\n</tr>\n<tr>\n<td style=\"padding: 10px; text-align: left;\">shared_emails</td>\n<td style=\"padding: 10px; text-align: left;\">array</td>\n<td style=\"padding: 10px; text-align: left;\">List of users or email addresses the conversation is shared with</td>\n</tr>\n<tr>\n<td style=\"padding: 10px; text-align: left;\">shared_channels</td>\n<td style=\"padding: 10px; text-align: left;\">array</td>\n<td style=\"padding: 10px; text-align: left;\">List of channels the conversation is shared with</td>\n</tr>\n<tr>\n<td style=\"padding: 10px; text-align: left;\">abstract_summary</td>\n<td style=\"padding: 10px; text-align: left;\">string</td>\n<td style=\"padding: 10px; text-align: left;\">Generated summary of the conversation</td>\n</tr>\n<tr>\n<td style=\"padding: 10px; text-align: left;\">conf_join_url</td>\n<td style=\"padding: 10px; text-align: left;\">string</td>\n<td style=\"padding: 10px; text-align: left;\">Conferencing join URL associated with the conversation</td>\n</tr>\n<tr>\n<td style=\"padding: 10px; text-align: left;\">relationships</td>\n<td style=\"padding: 10px; text-align: left;\">object</td>\n<td style=\"padding: 10px; text-align: left;\">Additional related data returned when requested with the include parameter</td>\n</tr>\n</tbody>\n</table></figure><p><strong>Shared channel object:</strong></p>\n<figure class=\"wysiwyg-table wysiwyg-table-align-left\" style=\"width: 100%;\"><table class=\"wysiwyg-table-resized\" style=\"border-collapse: collapse; border-spacing: 0px;\">\n<colgroup>\n<col style=\"width: 23%;\">\n<col style=\"width: 19%;\">\n<col style=\"width: 58%;\">\n</colgroup>\n<thead><tr>\n<th style=\"padding: 10px; text-align: left;\"><strong>Field</strong></th>\n<th style=\"padding: 10px; text-align: left;\"><strong>Type</strong></th>\n<th style=\"padding: 10px; text-align: left;\"><strong>Description</strong></th>\n</tr></thead>\n<tbody>\n<tr>\n<td style=\"padding: 10px; text-align: left;\">id</td>\n<td style=\"padding: 10px; text-align: left;\">string</td>\n<td style=\"padding: 10px; text-align: left;\">Unique channel identifier</td>\n</tr>\n<tr>\n<td style=\"padding: 10px; text-align: left;\">name</td>\n<td style=\"padding: 10px; text-align: left;\">string</td>\n<td style=\"padding: 10px; text-align: left;\">Name of the channel</td>\n</tr>\n<tr>\n<td style=\"padding: 10px; text-align: left;\">member_count</td>\n<td style=\"padding: 10px; text-align: left;\">integer</td>\n<td style=\"padding: 10px; text-align: left;\">Number of members in the channel</td>\n</tr>\n<tr>\n<td style=\"padding: 10px; text-align: left;\">owner</td>\n<td style=\"padding: 10px; text-align: left;\">User</td>\n<td style=\"padding: 10px; text-align: left;\">Owner of the channel</td>\n</tr>\n<tr>\n<td style=\"padding: 10px; text-align: left;\">discoverability</td>\n<td style=\"padding: 10px; text-align: left;\">string</td>\n<td style=\"padding: 10px; text-align: left;\">Channel visibility setting, such as <code>private</code> or <code>workspace</code> (public)</td>\n</tr>\n</tbody>\n</table></figure><p><strong>Error responses:</strong></p>\n<figure class=\"wysiwyg-table\" style=\"width: 100%;\"><table><tbody>\n<tr>\n<td style=\"padding: 10px; text-align: left;\"><strong>Status</strong></td>\n<td style=\"padding: 10px; text-align: left;\"><strong>Description</strong></td>\n</tr>\n<tr>\n<td style=\"padding: 10px; text-align: left;\">404</td>\n<td style=\"padding: 10px; text-align: left;\">Conversation not found</td>\n</tr>\n</tbody></table></figure><h3 id=\"get-conversation-audio\"><code><strong>GET /conversations/{id}/audio</strong></code></h3>\n<p>Use this endpoint to get the MP3 audio download link for a specific conversation.</p>\n<p><strong>Path Parameters:</strong></p>\n<figure class=\"wysiwyg-table\" style=\"width: 100%;\"><table><tbody>\n<tr>\n<td style=\"padding: 10px; text-align: left;\"><strong>Parameter</strong></td>\n<td style=\"padding: 10px; text-align: left;\"><strong>Type</strong></td>\n<td style=\"padding: 10px; text-align: left;\"><strong>Required</strong></td>\n<td style=\"padding: 10px; text-align: left;\"><strong>Description</strong></td>\n</tr>\n<tr>\n<td style=\"padding: 10px; text-align: left;\">id</td>\n<td style=\"padding: 10px; text-align: left;\">string</td>\n<td style=\"padding: 10px; text-align: left;\">Yes</td>\n<td style=\"padding: 10px; text-align: left;\">Conversation ID</td>\n</tr>\n</tbody></table></figure><p><strong>Example Request:</strong></p>\n<pre class=\"language-bash\">curl -X GET \"https://api.otter.ai/v1/conversations/{id}/audio\" \\\n  -H \"Authorization: Bearer YOUR_API_KEY\"</pre>\n<p><strong>Response:</strong></p>\n<p>Returns an AudioResponse containing the MP3 audio download link.</p>\n<ul>\n<li data-list-item-id=\"e7d7077f52becc88e7459568543e7ef94\">\n<strong>meta</strong>: Response metadata, including retrieved_at </li>\n<li data-list-item-id=\"e71f41867e9c988224ff7a2d40022ccd4\">\n<strong>data</strong>: The audio object</li>\n</ul>\n<pre class=\"language-json\">{\n  \"meta\": {\n    \"retrieved_at\": \"2025-07-31T12:00:00Z\"\n  },\n  \"data\": {\n    \"url\": \"https://test.com/audio.mp3\"\n  }\n}</pre>\n<p><strong>Audio Object:</strong></p>\n<figure class=\"wysiwyg-table\" style=\"width: 100%;\"><table><tbody>\n<tr>\n<td style=\"padding: 10px; text-align: left;\"><strong>Field</strong></td>\n<td style=\"padding: 10px; text-align: left;\"><strong>Type</strong></td>\n<td style=\"padding: 10px; text-align: left;\"><strong>Description</strong></td>\n</tr>\n<tr>\n<td style=\"padding: 10px; text-align: left;\">url</td>\n<td style=\"padding: 10px; text-align: left;\">string</td>\n<td style=\"padding: 10px; text-align: left;\">Download URL for the MP3 audio file</td>\n</tr>\n</tbody></table></figure><p><strong>Error Response:</strong></p>\n<figure class=\"wysiwyg-table\" style=\"width: 100%;\"><table><tbody>\n<tr>\n<td style=\"padding: 10px; text-align: left;\"><strong>Status</strong></td>\n<td style=\"padding: 10px; text-align: left;\"><strong>Description</strong></td>\n</tr>\n<tr>\n<td style=\"padding: 10px; text-align: left;\">404</td>\n<td style=\"padding: 10px; text-align: left;\">Conversation not found</td>\n</tr>\n</tbody></table></figure>\n</div>\n<h2 class=\"api-section-heading\" id=\"workspace\">\n<span class=\"acc-title\">Workspace</span> <span class=\"acc-sub\">Endpoints to access workspace details, member usage, and workspace analytics</span>\n</h2>\n<div class=\"api-section-body\">\n<ul>\n<li data-list-item-id=\"e436a8701fac9e87808c12866a169b0ff\"><a href=\"#get-workspace\"><code>GET /workspace</code></a></li>\n<li data-list-item-id=\"e94154be65ab50942bd2bc99b6424d38e\"><a href=\"#get-workspace-analytics\"><code>GET /workspace/{id}/analytics</code></a></li>\n</ul>\n<h3 id=\"get-workspace\"><code><strong>GET /workspace</strong></code></h3>\n<p>Use this endpoint to get the workspace for the authenticated user. The response includes workspace details such as the workspace ID, name, owner, member count, handle, and type.</p>\n<p><strong>Example Request:</strong></p>\n<pre class=\"wysiwyg-code-block\"><code class=\"language-bash\">curl -X GET \"https://api.otter.ai/v1/workspace\" \\\n  -H \"Authorization: Bearer YOUR_API_KEY\"</code></pre>\n<p><strong>Response:</strong></p>\n<p>Returns a WorkspaceGetResponse containing the authenticated user’s workspace details.</p>\n<ul>\n<li data-list-item-id=\"ed84fe91b3e3a83287c5f009bfd765a8a\">\n<strong>meta</strong>: Response metadata, including retrieved_at </li>\n<li data-list-item-id=\"e84de5d0289e94a547f7bea73dbbfa3b2\">\n<strong>data</strong>: The authenticated user’s workspace object</li>\n</ul>\n<pre class=\"wysiwyg-code-block\"><code class=\"language-json\">{\n  \"meta\": {\n    \"retrieved_at\": \"2025-07-31T12:00:00Z\"\n  },\n  \"data\": {\n    \"id\": 42,\n    \"name\": \"workspace name\",\n    \"owner\": {\n      \"id\": \"user_id\",\n      \"name\": \"Jane Doe\",\n      \"first_name\": \"Jane\",\n      \"last_name\": \"Doe\",\n      \"email\": \"Jane@test.com\"\n    },\n    \"member_count\": 50,\n    \"handle\": \"otter.ai\",\n    \"type\": \"business\"\n  }\n}</code></pre>\n<p><strong>Workspace object:</strong></p>\n<figure class=\"wysiwyg-table\" style=\"width: 100%;\"><table style=\"margin-left: 0px; margin-right: auto;\"><tbody>\n<tr>\n<td style=\"padding: 10px; text-align: left;\"><strong>Field</strong></td>\n<td style=\"padding: 10px; text-align: left;\"><strong>Type</strong></td>\n<td style=\"padding: 10px; text-align: left;\"><strong>Description</strong></td>\n</tr>\n<tr>\n<td style=\"padding: 10px; text-align: left;\">id</td>\n<td style=\"padding: 10px; text-align: left;\">integer</td>\n<td style=\"padding: 10px; text-align: left;\">Unique workspace identifier</td>\n</tr>\n<tr>\n<td style=\"padding: 10px; text-align: left;\">name</td>\n<td style=\"padding: 10px; text-align: left;\">string</td>\n<td style=\"padding: 10px; text-align: left;\">Name of the workspace</td>\n</tr>\n<tr>\n<td style=\"padding: 10px; text-align: left;\">owner</td>\n<td style=\"padding: 10px; text-align: left;\">User</td>\n<td style=\"padding: 10px; text-align: left;\">Owner of the workspace</td>\n</tr>\n<tr>\n<td style=\"padding: 10px; text-align: left;\">member_count</td>\n<td style=\"padding: 10px; text-align: left;\">integer</td>\n<td style=\"padding: 10px; text-align: left;\">Number of members in the workspace</td>\n</tr>\n<tr>\n<td style=\"padding: 10px; text-align: left;\">handle</td>\n<td style=\"padding: 10px; text-align: left;\">string</td>\n<td style=\"padding: 10px; text-align: left;\">Workspace handle (e.g., domain or identifier like otter.ai)</td>\n</tr>\n<tr>\n<td style=\"padding: 10px; text-align: left;\">type</td>\n<td style=\"padding: 10px; text-align: left;\">string</td>\n<td style=\"padding: 10px; text-align: left;\">Type of workspace (e.g., business)</td>\n</tr>\n</tbody></table></figure><p><strong>Error responses:</strong></p>\n<figure class=\"wysiwyg-table wysiwyg-table-align-left\"><table><tbody>\n<tr>\n<td style=\"padding: 10px; text-align: left;\"><strong>Status</strong></td>\n<td style=\"padding: 10px; text-align: left;\"><strong>Description</strong></td>\n</tr>\n<tr>\n<td style=\"padding: 10px; text-align: left;\">404</td>\n<td style=\"padding: 10px; text-align: left;\">User not in a workspace</td>\n</tr>\n</tbody></table></figure><h3 id=\"get-workspace-analytics\"><code><strong>GET /workspace/{id}/analytics</strong></code></h3>\n<p>Use this endpoint to retrieve workspace usage analytics for a date range, including total transcribed minutes, conversation counts, current license counts, and per-member usage sorted by name.</p>\n<p><strong>Operation ID:</strong> <code>getWorkspaceAnalytics</code><br><strong>Base URL:</strong> <code>https://api.otter.ai/v1</code></p>\n<p><strong>Path Parameters:</strong></p>\n<figure class=\"wysiwyg-table\" style=\"width: 100%;\"><table style=\"margin-left: 0px; margin-right: auto;\"><tbody>\n<tr>\n<td style=\"padding: 10px; text-align: left;\"><strong>Parameter</strong></td>\n<td style=\"padding: 10px; text-align: left;\"><strong>Type</strong></td>\n<td style=\"padding: 10px; text-align: left;\"><strong>Required</strong></td>\n<td style=\"padding: 10px; text-align: left;\"><strong>Description</strong></td>\n</tr>\n<tr>\n<td style=\"padding: 10px; text-align: left;\"><code>id</code></td>\n<td style=\"padding: 10px; text-align: left;\">string</td>\n<td style=\"padding: 10px; text-align: left;\">Yes</td>\n<td style=\"padding: 10px; text-align: left;\">Workspace ID. Use <code>GET /workspace</code> to retrieve your workspace details, including its ID.</td>\n</tr>\n</tbody></table></figure><p><strong>Query Parameters:</strong></p>\n<figure class=\"wysiwyg-table\" style=\"width: 100%;\"><table style=\"margin-left: 0px; margin-right: auto;\"><tbody>\n<tr>\n<td style=\"padding: 10px; text-align: left;\"><strong>Parameter</strong></td>\n<td style=\"padding: 10px; text-align: left;\"><strong>Type</strong></td>\n<td style=\"padding: 10px; text-align: left;\"><strong>Required</strong></td>\n<td style=\"padding: 10px; text-align: left;\"><strong>Description</strong></td>\n</tr>\n<tr>\n<td style=\"padding: 10px; text-align: left;\"><code>start_date</code></td>\n<td style=\"padding: 10px; text-align: left;\">string (date)</td>\n<td style=\"padding: 10px; text-align: left;\">No</td>\n<td style=\"padding: 10px; text-align: left;\">Inclusive start date in <code>yyyy-mm-dd</code> format. Omit together with <code>end_date</code> to use the last 30 days. If only <code>start_date</code> is provided, the end of the range defaults to now.</td>\n</tr>\n<tr>\n<td style=\"padding: 10px; text-align: left;\"><code>end_date</code></td>\n<td style=\"padding: 10px; text-align: left;\">string (date)</td>\n<td style=\"padding: 10px; text-align: left;\">No</td>\n<td style=\"padding: 10px; text-align: left;\">Inclusive end date in <code>yyyy-mm-dd</code> format. Cannot be provided without <code>start_date</code>.</td>\n</tr>\n<tr>\n<td style=\"padding: 10px; text-align: left;\"><code>timezone</code></td>\n<td style=\"padding: 10px; text-align: left;\">string</td>\n<td style=\"padding: 10px; text-align: left;\">No</td>\n<td style=\"padding: 10px; text-align: left;\">IANA timezone used to interpret dates, such as <code>America/Los_Angeles</code>. Defaults to the workspace timezone, then <code>America/Los_Angeles</code>.</td>\n</tr>\n</tbody></table></figure><p><strong>Date range behavior:</strong></p>\n<ul>\n<li data-list-item-id=\"e37c6b91cb3c351c0eb7031da732f94b2\">Omit both dates to retrieve analytics for the last 30 days.</li>\n<li data-list-item-id=\"e6c8de2fddb156a8b776621d5928c4789\">Provide only <code>start_date</code> to use now as the end of the range.</li>\n<li data-list-item-id=\"e50d9944a13d7daac9843b8cbcc5826f7\">Providing only <code>end_date</code> is invalid.</li>\n<li data-list-item-id=\"e7e9c873ca86d703e87ac54f737c281e1\">When both dates are provided, the range is inclusive, from 00:00:00 on the start date through 23:59:59 on the end date in the resolved timezone.</li>\n</ul>\n<div class=\"note flag\">\n<strong>Note:</strong> <code>num_of_minutes</code>, <code>num_of_conversations</code>, and <code>members</code> are scoped to the resolved report window. <code>seats_used</code> and <code>seats_invoiced</code> are current license counts and are not historical values for the report window.</div>\n<p><strong>Example Request:</strong></p>\n<pre class=\"wysiwyg-code-block\"><code class=\"language-bash\">curl -X GET \"https://api.otter.ai/v1/workspace/{id}/analytics?start_date=2026-09-01&amp;end_date=2026-09-30&amp;timezone=America%2FLos_Angeles\" \\\n  -H \"Authorization: Bearer YOUR_API_KEY\"</code></pre>\n<p>Replace <code>{id}</code> with your workspace ID. This GET request has no request body.</p>\n<p><strong>Response:</strong></p>\n<p>A successful request returns <code>200 OK</code> with content type <code>application/json</code> and a <code>WorkspaceAnalyticsResponse</code>.</p>\n<ul>\n<li data-list-item-id=\"e1646c902417a5e6a718dd56ab8327762\">\n<strong>meta</strong>: Response metadata, including <code>retrieved_at</code>\n</li>\n<li data-list-item-id=\"e286cb7531ae7b415fb4ee0c1b72d15f3\">\n<strong>data</strong>: The workspace analytics object for the resolved date range</li>\n</ul>\n<p>The following example uses illustrative values.</p>\n<pre class=\"wysiwyg-code-block\"><code class=\"language-json\">{\n  \"meta\": {\n    \"retrieved_at\": \"2026-10-01T12:00:00Z\"\n  },\n  \"data\": {\n    \"start_date\": \"2026-09-01\",\n    \"end_date\": \"2026-09-30\",\n    \"timezone\": \"America/Los_Angeles\",\n    \"num_of_minutes\": 120,\n    \"num_of_conversations\": 4,\n    \"seats_used\": 1,\n    \"seats_invoiced\": 5,\n    \"members\": [\n      {\n        \"id\": \"hashed_user_id\",\n        \"name\": \"Jane Doe\",\n        \"email\": \"jane@example.com\",\n        \"status\": \"Activated\",\n        \"num_of_conversations\": 4,\n        \"num_of_minutes\": 120,\n        \"average_conversations_per_month\": 4,\n        \"average_minutes_per_conversation\": 30,\n        \"average_minutes_per_month\": 120,\n        \"join_date\": \"2026-08-15\",\n        \"last_activity_at\": \"2026-09-30T18:30:00Z\",\n        \"last_login_at\": \"2026-09-30T16:00:00Z\",\n        \"num_of_ai_chats\": 2,\n        \"num_of_conversations_shared_by_user\": 2,\n        \"num_of_conversations_shared_with_user\": 0,\n        \"num_of_conversations_viewed\": 4\n      }\n    ]\n  }\n}</code></pre>\n<p><strong>Response fields:</strong></p>\n<figure class=\"wysiwyg-table\" style=\"width: 100%;\"><table style=\"margin-left: 0px; margin-right: auto;\"><tbody>\n<tr>\n<td style=\"padding: 10px; text-align: left;\"><strong>Field</strong></td>\n<td style=\"padding: 10px; text-align: left;\"><strong>Type</strong></td>\n<td style=\"padding: 10px; text-align: left;\"><strong>Required</strong></td>\n<td style=\"padding: 10px; text-align: left;\"><strong>Description</strong></td>\n</tr>\n<tr>\n<td style=\"padding: 10px; text-align: left;\"><code>meta</code></td>\n<td style=\"padding: 10px; text-align: left;\">object (CommonMeta)</td>\n<td style=\"padding: 10px; text-align: left;\">Yes</td>\n<td style=\"padding: 10px; text-align: left;\">Response metadata.</td>\n</tr>\n<tr>\n<td style=\"padding: 10px; text-align: left;\"><code>meta.retrieved_at</code></td>\n<td style=\"padding: 10px; text-align: left;\">string (date-time)</td>\n<td style=\"padding: 10px; text-align: left;\">Yes</td>\n<td style=\"padding: 10px; text-align: left;\">Timestamp when the data was retrieved (ISO 8601 format).</td>\n</tr>\n<tr>\n<td style=\"padding: 10px; text-align: left;\"><code>data</code></td>\n<td style=\"padding: 10px; text-align: left;\">object (WorkspaceAnalytics)</td>\n<td style=\"padding: 10px; text-align: left;\">Yes</td>\n<td style=\"padding: 10px; text-align: left;\">Workspace analytics for the resolved report window.</td>\n</tr>\n</tbody></table></figure><p><strong>Workspace analytics object:</strong></p>\n<figure class=\"wysiwyg-table\" style=\"width: 100%;\"><table style=\"margin-left: 0px; margin-right: auto;\"><tbody>\n<tr>\n<td style=\"padding: 10px; text-align: left;\"><strong>Field</strong></td>\n<td style=\"padding: 10px; text-align: left;\"><strong>Type</strong></td>\n<td style=\"padding: 10px; text-align: left;\"><strong>Required</strong></td>\n<td style=\"padding: 10px; text-align: left;\"><strong>Description</strong></td>\n</tr>\n<tr>\n<td style=\"padding: 10px; text-align: left;\"><code>start_date</code></td>\n<td style=\"padding: 10px; text-align: left;\">string (date)</td>\n<td style=\"padding: 10px; text-align: left;\">Yes</td>\n<td style=\"padding: 10px; text-align: left;\">Resolved inclusive start date of the report window (<code>yyyy-mm-dd</code>).</td>\n</tr>\n<tr>\n<td style=\"padding: 10px; text-align: left;\"><code>end_date</code></td>\n<td style=\"padding: 10px; text-align: left;\">string (date)</td>\n<td style=\"padding: 10px; text-align: left;\">Yes</td>\n<td style=\"padding: 10px; text-align: left;\">Resolved inclusive end date of the report window (<code>yyyy-mm-dd</code>).</td>\n</tr>\n<tr>\n<td style=\"padding: 10px; text-align: left;\"><code>timezone</code></td>\n<td style=\"padding: 10px; text-align: left;\">string</td>\n<td style=\"padding: 10px; text-align: left;\">Yes</td>\n<td style=\"padding: 10px; text-align: left;\">IANA timezone used to interpret dates. Defaults to the workspace timezone, then <code>America/Los_Angeles</code>.</td>\n</tr>\n<tr>\n<td style=\"padding: 10px; text-align: left;\"><code>num_of_minutes</code></td>\n<td style=\"padding: 10px; text-align: left;\">number</td>\n<td style=\"padding: 10px; text-align: left;\">Yes</td>\n<td style=\"padding: 10px; text-align: left;\">Total transcribed minutes for workspace members in the report window.</td>\n</tr>\n<tr>\n<td style=\"padding: 10px; text-align: left;\"><code>num_of_conversations</code></td>\n<td style=\"padding: 10px; text-align: left;\">number</td>\n<td style=\"padding: 10px; text-align: left;\">Yes</td>\n<td style=\"padding: 10px; text-align: left;\">Total conversations created by workspace members in the report window.</td>\n</tr>\n<tr>\n<td style=\"padding: 10px; text-align: left;\"><code>seats_used</code></td>\n<td style=\"padding: 10px; text-align: left;\">integer</td>\n<td style=\"padding: 10px; text-align: left;\">Yes</td>\n<td style=\"padding: 10px; text-align: left;\">Current licensed seats in use. Not scoped to the report window.</td>\n</tr>\n<tr>\n<td style=\"padding: 10px; text-align: left;\"><code>seats_invoiced</code></td>\n<td style=\"padding: 10px; text-align: left;\">integer</td>\n<td style=\"padding: 10px; text-align: left;\">Yes</td>\n<td style=\"padding: 10px; text-align: left;\">Current invoiced seat quantity. Not scoped to the report window.</td>\n</tr>\n<tr>\n<td style=\"padding: 10px; text-align: left;\"><code>members</code></td>\n<td style=\"padding: 10px; text-align: left;\">array of WorkspaceAnalyticsMember objects</td>\n<td style=\"padding: 10px; text-align: left;\">Yes</td>\n<td style=\"padding: 10px; text-align: left;\">Per-member usage for the report window, sorted by name.</td>\n</tr>\n</tbody></table></figure><p><strong>Workspace analytics member object:</strong></p>\n<figure class=\"wysiwyg-table\" style=\"width: 100%;\"><table style=\"margin-left: 0px; margin-right: auto;\"><tbody>\n<tr>\n<td style=\"padding: 10px; text-align: left;\"><strong>Field</strong></td>\n<td style=\"padding: 10px; text-align: left;\"><strong>Type</strong></td>\n<td style=\"padding: 10px; text-align: left;\"><strong>Required</strong></td>\n<td style=\"padding: 10px; text-align: left;\"><strong>Description</strong></td>\n</tr>\n<tr>\n<td style=\"padding: 10px; text-align: left;\"><code>id</code></td>\n<td style=\"padding: 10px; text-align: left;\">string</td>\n<td style=\"padding: 10px; text-align: left;\">Yes</td>\n<td style=\"padding: 10px; text-align: left;\">Opaque hashed user ID.</td>\n</tr>\n<tr>\n<td style=\"padding: 10px; text-align: left;\"><code>name</code></td>\n<td style=\"padding: 10px; text-align: left;\">string</td>\n<td style=\"padding: 10px; text-align: left;\">Yes</td>\n<td style=\"padding: 10px; text-align: left;\">Member name.</td>\n</tr>\n<tr>\n<td style=\"padding: 10px; text-align: left;\"><code>email</code></td>\n<td style=\"padding: 10px; text-align: left;\">string (email)</td>\n<td style=\"padding: 10px; text-align: left;\">Yes</td>\n<td style=\"padding: 10px; text-align: left;\">Member email address.</td>\n</tr>\n<tr>\n<td style=\"padding: 10px; text-align: left;\"><code>status</code></td>\n<td style=\"padding: 10px; text-align: left;\">string</td>\n<td style=\"padding: 10px; text-align: left;\">Yes</td>\n<td style=\"padding: 10px; text-align: left;\">Member status: <code>Activated</code>, <code>Deactivated</code>, or <code>Pending</code>.</td>\n</tr>\n<tr>\n<td style=\"padding: 10px; text-align: left;\"><code>num_of_conversations</code></td>\n<td style=\"padding: 10px; text-align: left;\">number</td>\n<td style=\"padding: 10px; text-align: left;\">Yes</td>\n<td style=\"padding: 10px; text-align: left;\">Conversations created by this member in the report window.</td>\n</tr>\n<tr>\n<td style=\"padding: 10px; text-align: left;\"><code>num_of_minutes</code></td>\n<td style=\"padding: 10px; text-align: left;\">number</td>\n<td style=\"padding: 10px; text-align: left;\">Yes</td>\n<td style=\"padding: 10px; text-align: left;\">Minutes transcribed by this member in the report window.</td>\n</tr>\n<tr>\n<td style=\"padding: 10px; text-align: left;\"><code>average_conversations_per_month</code></td>\n<td style=\"padding: 10px; text-align: left;\">number</td>\n<td style=\"padding: 10px; text-align: left;\">Yes</td>\n<td style=\"padding: 10px; text-align: left;\">Average number of conversations per month.</td>\n</tr>\n<tr>\n<td style=\"padding: 10px; text-align: left;\"><code>average_minutes_per_conversation</code></td>\n<td style=\"padding: 10px; text-align: left;\">number</td>\n<td style=\"padding: 10px; text-align: left;\">Yes</td>\n<td style=\"padding: 10px; text-align: left;\">Average transcribed minutes per conversation.</td>\n</tr>\n<tr>\n<td style=\"padding: 10px; text-align: left;\"><code>average_minutes_per_month</code></td>\n<td style=\"padding: 10px; text-align: left;\">number</td>\n<td style=\"padding: 10px; text-align: left;\">Yes</td>\n<td style=\"padding: 10px; text-align: left;\">Average transcribed minutes per month.</td>\n</tr>\n<tr>\n<td style=\"padding: 10px; text-align: left;\"><code>join_date</code></td>\n<td style=\"padding: 10px; text-align: left;\">string (date) or null</td>\n<td style=\"padding: 10px; text-align: left;\">No</td>\n<td style=\"padding: 10px; text-align: left;\">Member join date in the report timezone, or <code>null</code> if unknown.</td>\n</tr>\n<tr>\n<td style=\"padding: 10px; text-align: left;\"><code>last_activity_at</code></td>\n<td style=\"padding: 10px; text-align: left;\">string (date-time) or null</td>\n<td style=\"padding: 10px; text-align: left;\">No</td>\n<td style=\"padding: 10px; text-align: left;\">Most recent conversation creation, conversation view, or annotation timestamp, or <code>null</code> if none.</td>\n</tr>\n<tr>\n<td style=\"padding: 10px; text-align: left;\"><code>last_login_at</code></td>\n<td style=\"padding: 10px; text-align: left;\">string (date-time) or null</td>\n<td style=\"padding: 10px; text-align: left;\">No</td>\n<td style=\"padding: 10px; text-align: left;\">Most recent login timestamp, or <code>null</code> if the member has never logged in.</td>\n</tr>\n<tr>\n<td style=\"padding: 10px; text-align: left;\"><code>num_of_ai_chats</code></td>\n<td style=\"padding: 10px; text-align: left;\">number or null</td>\n<td style=\"padding: 10px; text-align: left;\">No</td>\n<td style=\"padding: 10px; text-align: left;\">AI chats created by this member in the report window, or <code>null</code> if unavailable.</td>\n</tr>\n<tr>\n<td style=\"padding: 10px; text-align: left;\"><code>num_of_conversations_shared_by_user</code></td>\n<td style=\"padding: 10px; text-align: left;\">number or null</td>\n<td style=\"padding: 10px; text-align: left;\">No</td>\n<td style=\"padding: 10px; text-align: left;\">Conversations shared by this member in the report window, or <code>null</code> if unavailable.</td>\n</tr>\n<tr>\n<td style=\"padding: 10px; text-align: left;\"><code>num_of_conversations_shared_with_user</code></td>\n<td style=\"padding: 10px; text-align: left;\">number or null</td>\n<td style=\"padding: 10px; text-align: left;\">No</td>\n<td style=\"padding: 10px; text-align: left;\">Conversations shared with this member in the report window, or <code>null</code> if unavailable.</td>\n</tr>\n<tr>\n<td style=\"padding: 10px; text-align: left;\"><code>num_of_conversations_viewed</code></td>\n<td style=\"padding: 10px; text-align: left;\">number or null</td>\n<td style=\"padding: 10px; text-align: left;\">No</td>\n<td style=\"padding: 10px; text-align: left;\">Conversations viewed by this member in the report window, or <code>null</code> if unavailable.</td>\n</tr>\n</tbody></table></figure><p><strong>Error responses:</strong></p>\n<figure class=\"wysiwyg-table\" style=\"width: 100%;\"><table style=\"margin-left: 0px; margin-right: auto;\"><tbody>\n<tr>\n<td style=\"padding: 10px; text-align: left;\"><strong>Status</strong></td>\n<td style=\"padding: 10px; text-align: left;\"><strong>Description</strong></td>\n</tr>\n<tr>\n<td style=\"padding: 10px; text-align: left;\">400 Bad Request</td>\n<td style=\"padding: 10px; text-align: left;\">Invalid date range, timezone, or workspace ID. This includes providing <code>end_date</code> without <code>start_date</code>.</td>\n</tr>\n<tr>\n<td style=\"padding: 10px; text-align: left;\">403 Forbidden</td>\n<td style=\"padding: 10px; text-align: left;\">Caller is not a workspace admin.</td>\n</tr>\n<tr>\n<td style=\"padding: 10px; text-align: left;\">404 Not Found</td>\n<td style=\"padding: 10px; text-align: left;\">Workspace not found.</td>\n</tr>\n</tbody></table></figure><p>Errors use content type <code>application/json</code> and an <code>ErrorResponse</code> object containing a required <code>errors</code> array. The response schemas are <code>ValidationErrorResponse</code> (400), <code>ForbiddenErrorResponse</code> (403), and <code>NotFoundErrorResponse</code> (404).</p>\n<p><strong>Error response fields:</strong></p>\n<figure class=\"wysiwyg-table\" style=\"width: 100%;\"><table style=\"margin-left: 0px; margin-right: auto;\"><tbody>\n<tr>\n<td style=\"padding: 10px; text-align: left;\"><strong>Field</strong></td>\n<td style=\"padding: 10px; text-align: left;\"><strong>Type</strong></td>\n<td style=\"padding: 10px; text-align: left;\"><strong>Required</strong></td>\n<td style=\"padding: 10px; text-align: left;\"><strong>Description</strong></td>\n</tr>\n<tr>\n<td style=\"padding: 10px; text-align: left;\"><code>errors</code></td>\n<td style=\"padding: 10px; text-align: left;\">array of RequestError objects</td>\n<td style=\"padding: 10px; text-align: left;\">Yes</td>\n<td style=\"padding: 10px; text-align: left;\">Details about the request errors.</td>\n</tr>\n<tr>\n<td style=\"padding: 10px; text-align: left;\"><code>errors[].status</code></td>\n<td style=\"padding: 10px; text-align: left;\">string</td>\n<td style=\"padding: 10px; text-align: left;\">No</td>\n<td style=\"padding: 10px; text-align: left;\">HTTP error status text.</td>\n</tr>\n<tr>\n<td style=\"padding: 10px; text-align: left;\"><code>errors[].code</code></td>\n<td style=\"padding: 10px; text-align: left;\">string</td>\n<td style=\"padding: 10px; text-align: left;\">No</td>\n<td style=\"padding: 10px; text-align: left;\">Specific error code defined by Otter.</td>\n</tr>\n<tr>\n<td style=\"padding: 10px; text-align: left;\"><code>errors[].detail</code></td>\n<td style=\"padding: 10px; text-align: left;\">string</td>\n<td style=\"padding: 10px; text-align: left;\">No</td>\n<td style=\"padding: 10px; text-align: left;\">Description of the error.</td>\n</tr>\n<tr>\n<td style=\"padding: 10px; text-align: left;\"><code>errors[].source</code></td>\n<td style=\"padding: 10px; text-align: left;\">object (RequestErrorSource)</td>\n<td style=\"padding: 10px; text-align: left;\">No</td>\n<td style=\"padding: 10px; text-align: left;\">Information about the request source. May be <code>null</code>, as shown in the example below.</td>\n</tr>\n<tr>\n<td style=\"padding: 10px; text-align: left;\"><code>errors[].source.header</code></td>\n<td style=\"padding: 10px; text-align: left;\">string</td>\n<td style=\"padding: 10px; text-align: left;\">No</td>\n<td style=\"padding: 10px; text-align: left;\">Header information associated with the error.</td>\n</tr>\n<tr>\n<td style=\"padding: 10px; text-align: left;\"><code>errors[].source.parameter</code></td>\n<td style=\"padding: 10px; text-align: left;\">string</td>\n<td style=\"padding: 10px; text-align: left;\">No</td>\n<td style=\"padding: 10px; text-align: left;\">Request parameter information associated with the error.</td>\n</tr>\n<tr>\n<td style=\"padding: 10px; text-align: left;\"><code>errors[].source.pointer</code></td>\n<td style=\"padding: 10px; text-align: left;\">string (URI)</td>\n<td style=\"padding: 10px; text-align: left;\">No</td>\n<td style=\"padding: 10px; text-align: left;\">URI identifying the request source associated with the error.</td>\n</tr>\n</tbody></table></figure><p><strong>Example Error Response (403):</strong></p>\n<pre class=\"wysiwyg-code-block\"><code class=\"language-json\">{\n  \"errors\": [\n    {\n      \"status\": \"Forbidden\",\n      \"code\": \"403\",\n      \"detail\": \"User has no permission\",\n      \"source\": null\n    }\n  ]\n}</code></pre>\n</div>\n<h2 id=\"best-practices\" data-toc-section=\"true\" data-faq-headings=\"true\">👉 Best Practices</h2>\n<div data-toc-skip-children=\"true\"><section class=\"faq-section\"><h2 class=\"api-section-heading\" id=\"rate-limiting-info\">Rate Limiting</h2>\n<div class=\"api-section-body\"><p>Implement appropriate rate limiting in your application to avoid overwhelming the API. Consider implementing exponential backoff for retries.</p></div>\n<h2 class=\"api-section-heading\" id=\"error-handling-info\">Error Handling</h2>\n<div class=\"api-section-body\"><p>Always check for and handle error responses gracefully. Parse the error details to provide meaningful feedback to users.</p></div>\n<h2 class=\"api-section-heading\" id=\"pagniation-info\">Pagination</h2>\n<div class=\"api-section-body\"><p>Use cursor-based pagination for large result sets. Don't attempt to retrieve all data in a single request.</p></div>\n<h2 class=\"api-section-heading\" id=\"selective-loading-info\">Selective Loading</h2>\n<div class=\"api-section-body\"><p>Use the <code>include</code> parameter in conversation endpoints to fetch only the data you need. This reduces response payload size and improves performance.</p></div>\n<h2 class=\"api-section-heading\" id=\"caching-info\">Caching</h2>\n<div class=\"api-section-body\"><p>Cache responses where appropriate to reduce API calls. Consider implementing a caching layer for frequently accessed data.</p></div>\n<h2 class=\"api-section-heading\" id=\"field-selection\">Field Selection</h2>\n<div class=\"api-section-body\"><p>When using the <code>include</code> parameter, only request the fields you actually need rather than using <code>all</code></p></div></section></div>\n</div>\n</div>","user_segment_ids":[]}}