{"article":{"id":28945604097181,"url":"https://scribehow1125.zendesk.com/api/v2/help_center/en-us/articles/28945604097181.json","html_url":"https://support.scribehow.com/hc/en-us/articles/28945604097181-Implementing-the-enterprise-search-API","author_id":19164923853213,"comments_disabled":true,"draft":false,"promoted":false,"position":14,"vote_sum":0,"vote_count":0,"upvote_count":0,"downvote_count":0,"section_id":34344915050141,"created_at":"2025-07-18T13:18:06Z","updated_at":"2026-04-30T01:34:23Z","name":"Implementing the enterprise search API","title":"Implementing the enterprise search API","source_locale":"en-us","locale":"en-us","outdated":false,"outdated_locales":[],"edited_at":"2026-04-30T01:34:23Z","user_segment_id":null,"permission_group_id":5361977926941,"content_tag_ids":[],"label_names":[],"body":"<p><img style=\"height: auto;\" src=\"https://support.scribehow.com/hc/article_attachments/34191404731933\" alt=\"ENT_Tag-Small.png\" width=\"46\" height=\"19\"> </p><p>The Enterprise search API provides programmatic access to search and retrieve documents belonging to your organization. It’s perfect for integrating Scribe’s powerful document search into your applications. </p><p>Key features:</p><ul>\n<li data-list-item-id=\"e26d566aaa0bcdaab68c1c26d7fc4af26\">Document search: Find documents with advanced filtering</li>\n<li data-list-item-id=\"efbdd48b20688d0d26e184f5710007105\">Team management: Access team information for filtering</li>\n<li data-list-item-id=\"e9ea8ada1d34010f7a22412c17580aeb9\">Real-time results: Get up-to-date document information</li>\n</ul><p>The search API is available to Enterprise Grid and Global customers. <a href=\"https://get.scribehow.com/sales/?utm_source=api\" target=\"_blank\" rel=\"noopener noreferrer\">Reach out to Sales</a> if you’re interested in learning more.</p><hr><h5 id=\"h_01K0S2090CDJE36X8T3JXANZ7P\">\n    <div style=\"background-color: #f0f7ff; border-left: 4px solid #0066cc; padding: 12px 16px; border-radius: 4px; margin: 16px 0;\">\n      💡 <strong>Working with Scribe in your AI tools?</strong> The Scribe\n      MCP may be the better option. Learn more\n<a href=\"https://support.scribehow.com/hc/en-us/articles/35221245251485-Scribe-MCP-Server-Dev-Doc\" style=\"text-decoration: underline;\">here</a>\n    </div>\n  </h5><hr><h2 id=\"h_01KNMK425C9GHF29PEZ2NQ5CXG\"><span class=\"wysiwyg-font-size-x-large\">Implementation </span></h2><h3 id=\"h_01K0ETSEMYED5406HPSW36RXP9\"><span class=\"wysiwyg-font-size-large\">Authentication</span></h3><p>All endpoints require a valid API key in the X-API-Key header.</p><h3 id=\"h_01K0ETSEMZPM2BA1DMK6X6JBP3\"><span class=\"wysiwyg-font-size-large\">Getting your API key</span></h3><ol>\n<li data-list-item-id=\"e26156dc619ac9ec462b89572c7ea9623\">Visit <a href=\"https://scribehow.com/settings?tab=apiKey\"><span class=\"wysiwyg-underline\">Scribe settings</span></a>\n</li>\n<li data-list-item-id=\"e5a8f751335a6440235181e0ba0d6f720\">Generate a new API key</li>\n<li data-list-item-id=\"e33027603c9b1d946989c15bf5945e9df\">Copy the key (starts with <code>sc_</code>), you will be only be able to see/copy it once.</li>\n<li data-list-item-id=\"e0024fc4b622d0fabac36d010c4f1d449\">Keep it secure!</li>\n</ol><hr><h2 id=\"h_01K0SWYV0X2E9YM9J59824W9W3\"><span class=\"wysiwyg-font-size-x-large\">API reference</span></h2><h3 id=\"h_01K0ETSEN12T93N2SJV9N2VN2E\"><span class=\"wysiwyg-font-size-large\">Base URL</span></h3><blockquote><p><code>&lt;https://public-api.scribehow.com&gt;</code></p></blockquote><p> </p><h3 id=\"h_01K0ETSEN2QNX8ESWH42DA4P14\"><span class=\"wysiwyg-font-size-large\">Authentication header</span></h3><blockquote><pre class=\"language-auto\">X-API-Key: sc_your_api_key_here</pre></blockquote><hr><h2 id=\"h_01K0SWYV0XEXYT6EDNY67H0VG3\"><span class=\"wysiwyg-font-size-x-large\">Search documents</span></h2><p>Search for documents across your organization with powerful filtering options. Returns a maximum of 15 results per request.</p><p><strong>Endpoint:</strong> <code>POST /v1/search/</code></p><p> </p><h3 id=\"h_01K0ETSEN3V7TRZV6YQCR2AMTW\"><span class=\"wysiwyg-font-size-large\">Request parameters</span></h3><figure class=\"wysiwyg-table\" style=\"width: 87%;\"><table class=\"wysiwyg-table-resized\">\n<colgroup>\n<col style=\"width: 25%;\">\n<col style=\"width: 14%;\">\n<col style=\"width: 16%;\">\n<col style=\"width: 45%;\">\n</colgroup>\n<tbody>\n<tr>\n<td><strong>Parameter</strong></td>\n<td><strong>Type</strong></td>\n<td><strong>Required</strong></td>\n<td><strong>Description</strong></td>\n</tr>\n<tr>\n<td><code>search</code></td>\n<td>string</td>\n<td>✅</td>\n<td>Search terms (minimum 1 character)</td>\n</tr>\n<tr>\n<td><code>type</code></td>\n<td>string</td>\n<td>❌</td>\n<td>Document type: <code>page</code> or <code>scribe</code>\n</td>\n</tr>\n<tr>\n<td><code>team_ids</code></td>\n<td>array</td>\n<td>❌</td>\n<td>List of team IDs to filter by</td>\n</tr>\n<tr>\n<td><code>sort_by</code></td>\n<td>string</td>\n<td>❌</td>\n<td>Sort order (default: <code>relevance</code>)</td>\n</tr>\n<tr>\n<td><code>created_at__gte</code></td>\n<td>string</td>\n<td>❌</td>\n<td>Created after date (ISO-8601)</td>\n</tr>\n<tr>\n<td><code>created_at__lte</code></td>\n<td>string</td>\n<td>❌</td>\n<td>Created before date (ISO-8601)</td>\n</tr>\n<tr>\n<td><code>updated_at__gte</code></td>\n<td>string</td>\n<td>❌</td>\n<td>Updated after date (ISO-8601)</td>\n</tr>\n<tr>\n<td><code>updated_at__lte</code></td>\n<td>string</td>\n<td>❌</td>\n<td>Updated before date (ISO-8601)</td>\n</tr>\n</tbody>\n</table></figure><p> </p><h3 id=\"h_01K0ETSENDV4BVNRZX0HNYZ9VE\"><span class=\"wysiwyg-font-size-large\">Sort options</span></h3><blockquote><ul>\n<li data-list-item-id=\"ee1469e17fccad0ac1e5e67f1f3216c64\">\n<code>relevance</code>Most relevant first (default)</li>\n<li data-list-item-id=\"ea911cdc8f5d99edc3192a6244b71f04c\">\n<code>created_at</code>Oldest first</li>\n<li data-list-item-id=\"e4282a672afebc7f018731e5a8bba0c88\">\n<code>created_at</code>Newest first</li>\n<li data-list-item-id=\"ee4e92de9c50a7f90a4a0440fe6ac7266\">\n<code>updated_at</code>Least recently updated first</li>\n<li data-list-item-id=\"e4e95521b9cc8e17212841691c0c1eb99\">\n<code>updated_at</code>Most recently updated first</li>\n</ul></blockquote><h3 id=\"h_01K0ETSENE889KAVMBNZ70N63V\"> </h3><h3 id=\"h_01K0SWYV0YBASXM8QEDY21Z1KN\"><span class=\"wysiwyg-font-size-large\">Document types</span></h3><blockquote><ul>\n<li data-list-item-id=\"ec8a4a49cd2b37b714880b2fc490a9cb7\">\n<code><strong>page</strong></code> Pages</li>\n<li data-list-item-id=\"e78f49f161106c4c983402411bdf11aa4\">\n<code><strong>scribe</strong></code>Scribe documents</li>\n</ul></blockquote><p> </p><h3 id=\"h_01K0ETSENF220VYH1K2Q34RPBB\"><span class=\"wysiwyg-font-size-large\">Examples</span></h3><p><span class=\"wysiwyg-font-size-medium\">Basic search</span></p><blockquote><pre class=\"language-auto\"># Python\n\nimport requests\n\nresponse = requests.post(\n    \"&lt;https://public-api.scribehow.com/v1/search/&gt;\",\n    headers={\"X-API-Key\": \"sc_your_api_key_here\"},\n    json={\"search\": \"security protocols\"},\n)\ndocuments = response.json()</pre></blockquote><blockquote><pre class=\"language-auto\">// JavaScript\n\nconst response = await fetch('&lt;https://public-api.scribehow.com/v1/search/&gt;', {\n\tmethod: 'POST',\n\theaders: {\n\t\t'X-API-Key': 'sc_your_api_key_here',\n\t\t'Content-Type': 'application/json',\n\t},\n\tbody: JSON.stringify({\n\t\tsearch: 'user authentication'\n\t}),\n});\nconst documents = await response.json();</pre></blockquote><blockquote><pre class=\"language-auto\"># curl\n\ncurl -X POST \"&lt;https://public-api.scribehow.com/v1/search/&gt;\" \\\\\n-H \"Content-Type: application/json\" \\\\\n-H \"X-API-Key: sc_your_api_key_here\" \\\\\n-d '{  \"search\": \"user authentication\"}'</pre></blockquote><p> </p><p><span class=\"wysiwyg-font-size-medium\">Advanced search with filters</span></p><blockquote><pre class=\"language-auto\"># Python\n\nimport requests\n\nresponse = requests.post(\n    \"&lt;https://public-api.scribehow.com/v1/search/&gt;\",\n    headers={\"X-API-Key\": \"sc_your_api_key_here\"},\n    json={\n        \"search\": \"security protocols\",\n        \"type\": \"page\",\n        \"sort_by\": \"-updated_at\",\n        \"created_at__gte\": \"2024-01-01T00:00:00Z\",\n    },\n)\ndocuments = response.json()</pre></blockquote><blockquote><pre class=\"language-auto\">// JavaScript\n\nconst response = await fetch('&lt;https://public-api.scribehow.com/v1/search/&gt;', {\n\tmethod: 'POST',\n\theaders: {\n\t\t'X-API-Key': 'sc_your_api_key_here',\n\t\t'Content-Type': 'application/json',\n\t},\n\tbody: JSON.stringify({\n\t\tsearch: 'security protocols',\n\t\ttype: 'page',\n\t\tsort_by: '-updated_at',\n\t\tcreated_at__gte: '2024-01-01T00:00:00Z',\n\t}),\n});\nconst documents = await response.json();</pre></blockquote><blockquote><pre class=\"language-auto\"># curl\n\ncurl -X POST \"&lt;https://public-api.scribehow.com/v1/search/&gt;\" \\\\\n  -H \"Content-Type: application/json\" \\\\\n  -H \"X-API-Key: sc_your_api_key_here\" \\\\\n  -d '{\n    \"search\": \"security protocols\",\n    \"type\": \"page\",\n    \"sort_by\": \"-updated_at\",\n    \"created_at__gte\": \"2024-01-01T00:00:00Z\"\n  }'</pre></blockquote><p> </p><p><span class=\"wysiwyg-font-size-medium\">Search by team</span></p><blockquote><pre class=\"language-auto\"># Python\n\nimport requests\n\nteam_ids = [\"550e8400-e29b-41d4-a716-446655440000\"]\nresponse = requests.post(\n    \"&lt;https://public-api.scribehow.com/v1/search/&gt;\",\n    headers={\"X-API-Key\": \"sc_your_api_key_here\"},\n    json={\"search\": \"security protocols\", \"team_ids\": team_ids, \"type\": \"scribe\"},\n)\ndocuments = response.json()</pre></blockquote><blockquote><pre class=\"language-auto\">// JavaScript\n\nconst teamIds = ['550e8400-e29b-41d4-a716-446655440000'];\nconst response = await fetch('&lt;https://public-api.scribehow.com/v1/search/&gt;', {\n\tmethod: 'POST',\n\theaders: {\n\t\t'X-API-Key': 'sc_your_api_key_here',\n\t\t'Content-Type': 'application/json',\n\t},\n\tbody: JSON.stringify({\n\t\tsearch: 'security protocols',\n\t\tteam_ids: teamIds,\n\t\ttype: 'scribe',\n\t}),\n});\nconst documents = await response.json();</pre></blockquote><blockquote><pre class=\"language-auto\"># curl\n\ncurl -X POST \"&lt;https://public-api.scribehow.com/v1/search/&gt;\" \\\\\n  -H \"Content-Type: application/json\" \\\\\n  -H \"X-API-Key: sc_your_api_key_here\" \\\\\n  -d '{\n    \"search\": \"security protocols\",\n    \"team_ids\": [\n      \"550e8400-e29b-41d4-a716-446655440000\"\n    ],\n    \"type\": \"scribe\"\n  }'</pre></blockquote><p> </p><h3 id=\"h_01K0ETSENK7HEEVVAS2XV96KTV\"><span class=\"wysiwyg-font-size-large\">Response format (JSON)</span></h3><blockquote><pre class=\"language-auto\">[{\n\t\"id\": \"550e8400-e29b-41d4-a716-446655440000\",\n\t\"name\": \"User Authentication Guide\",\n\t\"description\": \"Complete guide for implementing user authentication\",\n\t\"type\": \"page\",\n\t\"link\": \"&lt;https://scribehow.com/shared/User_Authentication_Guide__abc123&gt;\",\n\t\"team\": {\n\t\t\"id\": \"660e8400-e29b-41d4-a716-446655440001\",\n\t\t\"name\": \"Engineering Team\"\n\t},\n\t\"user_owner\": {\n\t\t\"id\": \"770e8400-e29b-41d4-a716-446655440002\",\n\t\t\"email\": \"john.doe@company.com\",\n\t\t\"name\": \"John Doe\"\n\t},\n\t\"actions\": [{\n\t\t\"id\": \"880e8400-e29b-41d4-a716-446655440003\",\n\t\t\"description\": \"Click the login button\"\n\t}],\n\t\"created_at\": \"2024-01-15T10:30:00Z\",\n\t\"updated_at\": \"2024-02-20T14:45:00Z\"\n}]</pre></blockquote><h2 id=\"h_01K0ETSENKHTQEQJ72Q3RYWJ3G\"> </h2><hr><h2 id=\"h_01K0SWYV0YH9EW1GTYEQVJ21A0\"><span class=\"wysiwyg-font-size-x-large\">List teams</span></h2><p>Get all teams associated with your API key. Use team IDs to filter search results.</p><p><strong>Endpoint:</strong> <code>GET /v1/teams/</code></p><p> </p><h3 id=\"h_01K0ETSENMC5GJHT018JZ87NHC\"><span class=\"wysiwyg-font-size-large\">Examples</span></h3><blockquote><pre class=\"language-auto\"># Python\nimport requests\n\nresponse = requests.get(\n    \"&lt;https://public-api.scribehow.com/v1/teams/&gt;\",\n    headers={\"X-API-Key\": \"sc_your_api_key_here\"},\n)\nteams = response.json()</pre></blockquote><blockquote><pre class=\"language-auto\">// JavaScript\n\nconst response = await fetch('&lt;https://public-api.scribehow.com/v1/teams/&gt;', {\n\theaders: {\n\t\t'X-API-Key': 'sc_your_api_key_here'\n\t},\n});\nconst teams = await response.json();</pre></blockquote><blockquote><pre class=\"language-auto\"># curl\n\ncurl -X GET \"&lt;https://public-api.scribehow.com/v1/teams/&gt;\" \\\\\n  -H \"X-API-Key: sc_your_api_key_here\"</pre></blockquote><h3 id=\"h_01K0ETSENN71KC6PHHK9DP62TC\"> </h3><h3 id=\"h_01K0SWYV0YRC94HF330KW92S0T\"><span class=\"wysiwyg-font-size-large\">Response format (JSON)</span></h3><blockquote><pre class=\"language-cpp\">[\n  {\n\t\t\"id\": \"550e8400-e29b-41d4-a716-446655440000\",\n\t\t\"name\": \"Engineering Team\"\n\t},\n\t{\n\t\t\"id\": \"660e8400-e29b-41d4-a716-446655440001\",\n\t\t\"name\": \"Product Team\"\n\t}\n]</pre></blockquote><h2 id=\"h_01K0ETSENNXGC302H11263W305\"> </h2><hr><h2 id=\"h_01K0SWYV0YBTPH2R6YJW9F05JC\"><span class=\"wysiwyg-font-size-x-large\">Best practices</span></h2><h3 id=\"h_01K0ETSENNY7MYS5YPHMVBY4GY\"><span class=\"wysiwyg-font-size-large\">Search tips</span></h3><ul>\n<li data-list-item-id=\"ed20a7a92136c69f0f0a1ab414e534e67\">Be specific: Use detailed search terms to get the most relevant results from the 15 returned</li>\n<li data-list-item-id=\"ed0880838024c2f5df6fcb8a048092fb9\">Use filters: Combine type and team filters to narrow down results</li>\n<li data-list-item-id=\"e2f79d274824ed2d6860890d1558d566f\">Sort strategically: Use <code>updated_at</code> to find recent content first</li>\n<li data-list-item-id=\"ee288ca74748684de92b007785db4954a\">Note: Maximum 15 results returned per search</li>\n</ul><h3 id=\"h_01K0ETSENPFJN2BXXWC1SJQWWW\"><span class=\"wysiwyg-font-size-large\">Security</span></h3><ul>\n<li data-list-item-id=\"e6a10f747c19965d57af7bbb3caaefae3\">Never expose API keys in client-side code</li>\n<li data-list-item-id=\"e707b0b82d7773b833a1ab5b548e52ddf\">Monitor usage to detect unusual activity</li>\n</ul><hr><h2 id=\"h_01K0SWYV0YK139KV980FN49A01\"><span class=\"wysiwyg-font-size-x-large\">Helpful resources</span></h2><ul>\n    <li>\n      API key management:\n      <a href=\"https://scribehow.com/settings?tab=apiKey\"><span class=\"wysiwyg-underline\">Scribe Settings</span></a>\n    </li>\n    <li>\n      Documentation:\n      <ul>\n        <li>\n          <a href=\"https://public-api.scribehow.com/schema/swagger/\"><span class=\"wysiwyg-underline\">Swagger</span></a>\n        </li>\n        <li>\n          <a href=\"https://public-api.scribehow.com/schema/redoc/\"><span class=\"wysiwyg-underline\">ReDoc</span></a>\n        </li>\n      </ul>\n    </li>\n    <li>\n      View this Scribe for help implementing the API with Copilot:\n      <iframe src=\"https://scribehow.com/embed/Scribe_Search_API_integration_with_Microsoft_Copilot_Agent__sjs1GIfITJ2L5BOUV-66IA?removeLogo=true\" width=\"100%\" height=\"800\" allow=\"fullscreen\" style=\"aspect-ratio: 1 / 1; border: 0; min-height: 480px;\"></iframe>\n    </li>\n  </ul>\n  <li>\n    View this Scribe for help implementing the API with Slack bots:\n    <iframe src=\"https://scribehow.com/embed/Creating_a_Slack_bot_using_Scribes_enterprise_search_API__TCX5RyW6TjKTzJ237t9gaQ?removeLogo=true\" width=\"100%\" height=\"800\" allow=\"fullscreen\" style=\"aspect-ratio: 1 / 1; border: 0; min-height: 480px;\"></iframe>\n  </li><p> </p><p> </p>"}}