Theneo Design Template 2

Getting Started

Introduction

Single Page Template

Customizing

Theneo Web Editor

API Reference

Basics of APIs

Authentication

Rest API Reference

Create customer

Update customer

Retrieve customer

List all customers

Delete customer

Other Templates

This doc in continuous scrolling theme

Roboto continuous scrolling theme

Bloom continuous scrolling

Blank

Sample Documentation

Theneo Theme - Solid

Production

Sandbox

Theneo is the quickest, simplest way to generate high-quality, interactive API docs. Unlock the full potential of AI-powered API documentation: Create stunning, low-maintenance, and engaging docs with a single upload. Theneo streamlines every step of the process, ensuring that your documentation is not only comprehensive but also interactive and user-friendly. 

To create and publish documentation in Theneo, you first need to create a Theneo account. If you don’t have an account yet, you can sign up for free 

When you log into Theneo, start by adding a new project from the homepage. Your project could be an API reference, a developer guide, or any type of documentation you need. Give your project a title, select the appropriate workspace, and you're on your way.

<p class="slate-p " >We’re thrilled to introduce the <strong class="slate-bold">Single Page Template</strong> — a flexible and focused layout option for your documentation. You now have the ability to choose between two layout styles:</p><ul class="slate-ul " ><li class="slate-li " ><div style="position:relative"><strong class="slate-bold">Continuous Scrolling</strong> (best for API references) </div></li><li class="slate-li " ><div style="position:relative"><strong class="slate-bold">Single Page</strong> (best for guides, tutorials, and onboarding flows) </div></li></ul><p class="slate-p " >With this new feature, you can tailor your documentation experience to best suit your content and your readers.</p><p class="slate-p " ></p><div class="slate-hr"><hr contenteditable="false" class="slate-HrElement-hr"/></div><p class="slate-p " ></p><h2 class="slate-h2 " >Benefits of the Single Page Template</h2><ul class="slate-ul " ><li class="slate-li " ><div style="position:relative"><strong class="slate-bold">Modular Layout</strong>
 Each section appears on its own dedicated page, making navigation cleaner and more intuitive. </div></li><li class="slate-li " ><div style="position:relative"><strong class="slate-bold">Improved Performance</strong>
 Only the requested page loads, resulting in faster load times and better performance — especially for large docs. </div></li><li class="slate-li " ><div style="position:relative"><strong class="slate-bold">Clear Navigation &amp; URLs</strong>
 Each section has a unique URL, making deep linking and sharing easier. </div></li><li class="slate-li " ><div style="position:relative"><strong class="slate-bold">Optimized for Guides</strong>
 Perfect for linear, step-by-step content like tutorials, onboarding instructions, or user walkthroughs. </div></li><li class="slate-li " ><div style="position:relative"><strong class="slate-bold">Better Readability</strong>
 Reduces scrolling fatigue and gives readers a more focused reading experience. </div></li></ul><div class="slate-hr"><hr contenteditable="false" class="slate-HrElement-hr"/></div><p class="slate-p " ></p><h2 class="slate-h2 " >How to Activate the Single Page Template</h2><p class="slate-p " >Activating the Single Page Template is quick and easy. Just follow these steps:</p><p class="slate-p " ></p><div class="steps-widget" style="width:100%;
  	min-width:100%;"><div class="steps-wrapper"><div class="steps-content"><h6 class="slate-h6 " >1</h6><h3 class="slate-h3 " >Go to Your Dashboard</h3><p class="slate-p " >Log in to your Theneo dashboard and navigate to the project you want to update. </p><p class="slate-p " ></p></div></div><div class="steps-wrapper"><div class="steps-content"><h6 class="slate-h6 " >2</h6><h3 class="slate-h3 " >Open Project Settings</h3><p class="slate-p " >Click on the <strong class="slate-bold">Settings</strong> tab of your selected project.</p><p class="slate-p " ></p></div></div><div class="steps-wrapper"><div class="steps-content"><h6 class="slate-h6 " >3</h6><h3 class="slate-h3 " >Go to the Features Tab</h3><p class="slate-p " >Inside Project Settings, navigate to the Features tab</p><p class="slate-p " ></p></div></div><div class="steps-wrapper"><div class="steps-content"><h6 class="slate-h6 " >4</h6><h3 class="slate-h3 " >Enable the Single Page Template</h3><p class="slate-p " >Find the toggle labeled Single Page Template and turn it on.</p><p class="slate-p " ></p></div></div></div><p class="slate-p " ></p><p class="slate-p " ></p><div style="width:100%;
	min-width:100%;" class="callout-widget" data-type=info ><div class="callout-icon"><svg width="20" height="20" viewBox="0 0 20 20" fill="none" xmlns="http://www.w3.org/2000/svg"><path d="M10.0628 14.1676C10.2434 14.1676 10.3927 14.1086 10.5107 13.9905C10.6288 13.8725 10.6878 13.7232 10.6878 13.5426V9.77177C10.6878 9.6051 10.6253 9.46274 10.5003 9.34469C10.3753 9.22663 10.2295 9.1676 10.0628 9.1676C9.88227 9.1676 9.73296 9.22663 9.61491 9.34469C9.49685 9.46274 9.43783 9.61205 9.43783 9.7926V13.5634C9.43783 13.7301 9.50033 13.8725 9.62533 13.9905C9.75033 14.1086 9.89616 14.1676 10.0628 14.1676ZM10.0003 7.62594C10.1948 7.62594 10.358 7.56344 10.4899 7.43844C10.6219 7.31344 10.6878 7.15371 10.6878 6.95927C10.6878 6.76482 10.6219 6.59816 10.4899 6.45927C10.358 6.32038 10.1948 6.25094 10.0003 6.25094C9.80588 6.25094 9.64269 6.32038 9.51074 6.45927C9.3788 6.59816 9.31283 6.76482 9.31283 6.95927C9.31283 7.15371 9.3788 7.31344 9.51074 7.43844C9.64269 7.56344 9.80588 7.62594 10.0003 7.62594ZM10.0003 18.3343C8.81977 18.3343 7.72255 18.1225 6.70866 17.6989C5.69477 17.2752 4.81283 16.6884 4.06283 15.9384C3.31283 15.1884 2.72602 14.3065 2.30241 13.2926C1.8788 12.2787 1.66699 11.1815 1.66699 10.0009C1.66699 8.83427 1.8788 7.74399 2.30241 6.7301C2.72602 5.71621 3.31283 4.83427 4.06283 4.08427C4.81283 3.33427 5.69477 2.74399 6.70866 2.31344C7.72255 1.88288 8.81977 1.6676 10.0003 1.6676C11.167 1.6676 12.2573 1.88288 13.2712 2.31344C14.285 2.74399 15.167 3.33427 15.917 4.08427C16.667 4.83427 17.2573 5.71621 17.6878 6.7301C18.1184 7.74399 18.3337 8.83427 18.3337 10.0009C18.3337 11.1815 18.1184 12.2787 17.6878 13.2926C17.2573 14.3065 16.667 15.1884 15.917 15.9384C15.167 16.6884 14.285 17.2752 13.2712 17.6989C12.2573 18.1225 11.167 18.3343 10.0003 18.3343ZM10.0003 17.0843C11.9448 17.0843 13.6114 16.3898 15.0003 15.0009C16.3892 13.612 17.0837 11.9454 17.0837 10.0009C17.0837 8.05649 16.3892 6.38982 15.0003 5.00094C13.6114 3.61205 11.9448 2.9176 10.0003 2.9176C8.05588 2.9176 6.38921 3.61205 5.00033 5.00094C3.61144 6.38982 2.91699 8.05649 2.91699 10.0009C2.91699 11.9454 3.61144 13.612 5.00033 15.0009C6.38921 16.3898 8.05588 17.0843 10.0003 17.0843Z" fill="#3960B4"></path></svg></div><div ><p class="slate-p " >For configuraing the social media links please go to your banding configuration <a href="https://app.theneo.io/branding" target="_self">https://app.theneo.io/branding</a></p><p class="slate-p " ></p><div style="text-align:left"><img src="https://d24lr4zqs1tgqh.cloudfront.net/b0734156-7148-4e0c-bfef-c6b563ac3a1d.png" style="
              width:919px;
	            height:265px;
	            aspect-ratio:919 / 265"
         /></div></div></div><p class="slate-p " ></p><p class="slate-p " ></p><div class="slate-hr"><hr contenteditable="false" class="slate-HrElement-hr"/></div><h2 class="slate-h2 " >Switching Back</h2><p class="slate-p " >If you ever want to switch back to the Continuous Scrolling layout, simply return to the <strong class="slate-bold">Features</strong> tab and toggle off the Single Page Template. Your content will automatically return to the scrolling layout without data loss.</p><p class="slate-p " ></p>

 — a flexible and focused layout option for your documentation. You now have the ability to choose between two layout styles:

With this new feature, you can tailor your documentation experience to best suit your content and your readers.

Activating the Single Page Template is quick and easy. Just follow these steps:

If you ever want to switch back to the Continuous Scrolling layout, simply return to the 

 tab and toggle off the Single Page Template. Your content will automatically return to the scrolling layout without data loss.

<p class="slate-p slate-indent-0" style="0px">In Theneo, you have complete control over the look and feel of your documentation. This is achieved through an extensive set of color customization options that cater to every aspect of your project&apos;s interface. Here&apos;s a detailed overview of what you can configure:</p><div style="text-align:center"><img src="https://theneo-prod-public.s3.us-east-1.amazonaws.com/9279c0b0-329f-477b-81d6-0ab122a6a987.webp" style="
              width:1062px;
	            height:597px;
	            aspect-ratio:1062 / 597"
         /></div><h3 class="slate-h3 " >General Settings:</h3><ul class="slate-ul " ><li class="slate-li " ><div style="position:relative"><span style="color:var(--tw-prose-bold)"><strong class="slate-bold">Logos</strong></span>: Upload separate logos for light and dark modes, ensuring clear visibility regardless of theme. Ideal dimensions are provided for optimal display.</div></li><li class="slate-li " ><div style="position:relative"><span style="color:var(--tw-prose-bold)"><strong class="slate-bold">Favicon</strong></span>: Customize the small icon that appears in browser tabs and bookmarks to make your site easily identifiable.</div></li><li class="slate-li " ><div style="position:relative"><span style="color:var(--tw-prose-bold)"><strong class="slate-bold">Logo Hyperlink</strong></span>: Direct users to your desired URL through the logo in your documentation.</div></li><li class="slate-li " ><div style="position:relative"><span style="color:var(--tw-prose-bold)"><strong class="slate-bold">Attribution</strong></span>: Toggle the &quot;Powered by Theneo&quot; attribution on or off to match your branding preferences.</div></li><li class="slate-li " ><div style="position:relative"><span style="color:var(--tw-prose-bold)"><strong class="slate-bold">Document Font</strong></span>: Select from a variety of fonts to maintain consistency across your documentation.</div></li></ul><p class="slate-p " ></p><h3 class="slate-h3 " >Color Customization of the published view projects:</h3><h4 class="slate-h4 " >Global Settings:</h4><ul class="slate-ul " ><li class="slate-li " ><div style="position:relative"><strong class="slate-bold">Body Text</strong>: Set the text color for readability.</div></li><li class="slate-li " ><div style="position:relative"><strong class="slate-bold">Section Headings: </strong>Highlight section titles.</div></li><li class="slate-li " ><div style="position:relative"><strong class="slate-bold">Background:</strong> Choose a primary background color.</div></li><li class="slate-li " ><div style="position:relative"><strong class="slate-bold">Accents:</strong> Customize borders and outlines.</div></li><li class="slate-li " ><div style="position:relative"><strong class="slate-bold">Buttons:</strong> Define button colors.</div></li><li class="slate-li " ><div style="position:relative"><strong class="slate-bold">Links:</strong> Customize hyperlink colors.
</div></li></ul><h4 class="slate-h4 " >Left Sidebar Menu:</h4><ul class="slate-ul " ><li class="slate-li " ><div style="position:relative"><strong class="slate-bold">Item Colors:</strong> Set colors for menu items and active selection.</div></li><li class="slate-li " ><div style="position:relative"><strong class="slate-bold">Background:</strong> Choose a sidebar background color.</div></li></ul><p class="slate-p " ></p><h4 class="slate-h4 " >Widget Cards:</h4><ul class="slate-ul " ><li class="slate-li " ><div style="position:relative"><strong class="slate-bold">Code Snippet Card:</strong> Customize the header and body colors for request, response, and object example cards.</div></li><li class="slate-li " ><div style="position:relative"><strong class="slate-bold">Base URL Card:</strong> Set header and body background colors.</div></li></ul><div class="slate-hr"><hr contenteditable="false" class="slate-HrElement-hr"/></div><p class="slate-p " ></p><h3 class="slate-h3 " >Custom CSS and JavaScript</h3><p class="slate-p " >Custom CSS and JavaScript offer powerful tools to personalize and enhance your Theneo documentation, giving you full control over its appearance and functionality. This feature allows you to create a highly branded, interactive, and tailored user experience.</p><h4 class="slate-h4 " >Benefits:</h4><ul class="slate-ul " ><li class="slate-li " ><div style="position:relative"><strong class="slate-bold">Enhanced Personalization</strong>: Customize the visual style to perfectly align with your brand.</div></li><li class="slate-li " ><div style="position:relative"><strong class="slate-bold">Extended Functionality</strong>: Implement advanced features or third-party integrations using JavaScript.</div></li><li class="slate-li " ><div style="position:relative"><strong class="slate-bold">Improved User Experience</strong>: Optimize layout, navigation, and interactions for a more user-friendly and branded interface.</div></li></ul><p class="slate-p " ></p>

In Theneo, you have complete control over the look and feel of your documentation. This is achieved through an extensive set of color customization options that cater to every aspect of your project's interface. Here's a detailed overview of what you can configure:

Color Customization of the published view projects:

Custom CSS and JavaScript offer powerful tools to personalize and enhance your Theneo documentation, giving you full control over its appearance and functionality. This feature allows you to create a highly branded, interactive, and tailored user experience.

<p class="slate-p " >Theneo&apos;s web editor is a rich and intuitive platform, equipped with a variety of widgets that enrich the documentation experience. These widgets add depth and clarity to your API documentation, making it more engaging and informative. You can easily access these widgets by simply going to a new line in the editor and typing /, which brings up the widget options.</p><p class="slate-p " >Additionally, Theneo&apos;s live collaboration feature enables real-time teamwork, allowing multiple users to simultaneously edit, comment, and review documentation. This streamlines the editing process, reduces bottlenecks, and fosters seamless collaboration across teams. Whether you&apos;re working in the same room or across different time zones, live collaboration ensures that everyone stays aligned and up to date on changes.</p><p class="slate-p " >Let&apos;s take a look at the widgets available:</p><p class="slate-p " ></p><h3 class="slate-h3 " >Code Block</h3><p class="slate-p " >Perfect for displaying code snippets, helping users und/erstand implementation details in different programming languages. </p><p class="slate-p " >Here&apos;s an example of a formatted code snippet in JavaScript:</p><div class="code-block-wrapper"  style="width:100%;min-width:100%" ><div class="code-block-header">JavaScript</div><pre class="slate-CodeBlockElement slate-code_block"><textarea id="publishedPageCodeblock" style="display:none !important; visibility: hidden; opacity: 0; width: 1px; height: 1px;" type="hidden"> </textarea><code class="language-javascript keep-markup drop-tokens"><div class="slate-code_line"><div class="slate-code_line"><div class="slate-code_line">const city = &quot;London&quot;;
const apiKey = &quot;your_api_key_here&quot;;</div><div class="slate-code_line">fetch(https://api.openweathermap.org/data/2.5/weather?q=${city}&amp;appid=${apiKey}&amp;units=metric)
.then(res =&gt; res.json())
.then(data =&gt; {
console.log(data.main.temp + &quot;°C&quot;);
});</div></div></div></code></pre></div><p class="slate-p " ></p><h3 class="slate-h3 " >Callout</h3><div style="width:100%;
	min-width:100%;" class="callout-widget" data-type=info ><div class="callout-icon"><svg width="20" height="20" viewBox="0 0 20 20" fill="none" xmlns="http://www.w3.org/2000/svg"><path d="M10.0628 14.1676C10.2434 14.1676 10.3927 14.1086 10.5107 13.9905C10.6288 13.8725 10.6878 13.7232 10.6878 13.5426V9.77177C10.6878 9.6051 10.6253 9.46274 10.5003 9.34469C10.3753 9.22663 10.2295 9.1676 10.0628 9.1676C9.88227 9.1676 9.73296 9.22663 9.61491 9.34469C9.49685 9.46274 9.43783 9.61205 9.43783 9.7926V13.5634C9.43783 13.7301 9.50033 13.8725 9.62533 13.9905C9.75033 14.1086 9.89616 14.1676 10.0628 14.1676ZM10.0003 7.62594C10.1948 7.62594 10.358 7.56344 10.4899 7.43844C10.6219 7.31344 10.6878 7.15371 10.6878 6.95927C10.6878 6.76482 10.6219 6.59816 10.4899 6.45927C10.358 6.32038 10.1948 6.25094 10.0003 6.25094C9.80588 6.25094 9.64269 6.32038 9.51074 6.45927C9.3788 6.59816 9.31283 6.76482 9.31283 6.95927C9.31283 7.15371 9.3788 7.31344 9.51074 7.43844C9.64269 7.56344 9.80588 7.62594 10.0003 7.62594ZM10.0003 18.3343C8.81977 18.3343 7.72255 18.1225 6.70866 17.6989C5.69477 17.2752 4.81283 16.6884 4.06283 15.9384C3.31283 15.1884 2.72602 14.3065 2.30241 13.2926C1.8788 12.2787 1.66699 11.1815 1.66699 10.0009C1.66699 8.83427 1.8788 7.74399 2.30241 6.7301C2.72602 5.71621 3.31283 4.83427 4.06283 4.08427C4.81283 3.33427 5.69477 2.74399 6.70866 2.31344C7.72255 1.88288 8.81977 1.6676 10.0003 1.6676C11.167 1.6676 12.2573 1.88288 13.2712 2.31344C14.285 2.74399 15.167 3.33427 15.917 4.08427C16.667 4.83427 17.2573 5.71621 17.6878 6.7301C18.1184 7.74399 18.3337 8.83427 18.3337 10.0009C18.3337 11.1815 18.1184 12.2787 17.6878 13.2926C17.2573 14.3065 16.667 15.1884 15.917 15.9384C15.167 16.6884 14.285 17.2752 13.2712 17.6989C12.2573 18.1225 11.167 18.3343 10.0003 18.3343ZM10.0003 17.0843C11.9448 17.0843 13.6114 16.3898 15.0003 15.0009C16.3892 13.612 17.0837 11.9454 17.0837 10.0009C17.0837 8.05649 16.3892 6.38982 15.0003 5.00094C13.6114 3.61205 11.9448 2.9176 10.0003 2.9176C8.05588 2.9176 6.38921 3.61205 5.00033 5.00094C3.61144 6.38982 2.91699 8.05649 2.91699 10.0009C2.91699 11.9454 3.61144 13.612 5.00033 15.0009C6.38921 16.3898 8.05588 17.0843 10.0003 17.0843Z" fill="#3960B4"></path></svg></div><div ><p class="slate-p " >Draws focus to important information, tips, or warnings, ensuring key messages are not missed.</p></div></div><p class="slate-p " ></p><h3 class="slate-h3 " >Single Card</h3><a href="https://app.theneo.io/theneo-design-template-2/sample-documentation/api-reference/basics-of-apis" target="_top" class=card-anchor><div class="card-box" style="width:100%;"><img src=https://d24lr4zqs1tgqh.cloudfront.net/dc6636a3-dee3-4b3d-8128-5890a76b93b9.svg class=card-icon></img><div ><h3 class="slate-h3 " >Card Title</h3><p class="slate-p " >This is how the card widget appears, with an icon, title and link. Clicking on this card will take you to the Basics of APIs section.</p></div></div></a><p class="slate-p " ></p><h3 class="slate-h3 " >Double Card</h3><div class=card-group-box style="width:100%; min-width:540px;"><div class="card-box"><img src=https://theneo-prod-public.s3.us-east-1.amazonaws.com/eb368ce2-86d3-4b28-9571-87a8a13556b7.svg class=card-icon></img><div ><h3 class="slate-h3 " >Card Title</h3><p class="slate-p " >Add description here</p></div></div><div class="card-box"><img src=https://theneo-prod-public.s3.us-east-1.amazonaws.com/27ffc643-5ef2-43d3-8408-db06896570b2.svg class=card-icon></img><div ><h3 class="slate-h3 " >Card Title</h3><p class="slate-p " >Add description here</p></div></div></div><p class="slate-p " ></p><h3 class="slate-h3 " >Triple Card</h3><div class=card-group-box style="width:100%; min-width:540px;"><div class="card-box"><img src=https://theneo-prod-public.s3.us-east-1.amazonaws.com/cba1b876-b776-4722-bc36-e15b407da20b.svg class=card-icon></img><div ><h3 class="slate-h3 " >Card Title</h3><p class="slate-p " >Add description here</p></div></div><div class="card-box"><img src=https://theneo-prod-public.s3.us-east-1.amazonaws.com/52045112-12e3-40aa-bac0-0dbeb800d45b.svg class=card-icon></img><div ><h3 class="slate-h3 " >Card Title</h3><p class="slate-p " >Add description here</p></div></div><div class="card-box"><img src=https://theneo-prod-public.s3.us-east-1.amazonaws.com/914d92af-56b0-4cdb-9983-d89da4d34ebd.svg class=card-icon></img><div ><h3 class="slate-h3 " >Card Title</h3><p class="slate-p " >Add description here</p></div></div></div><p class="slate-p " ></p><h3 class="slate-h3 " >Card Grid</h3><div class=card-group-box style="width:100%; min-width:540px;"><div class="card-box"><img src=https://theneo-prod-public.s3.us-east-1.amazonaws.com/c5642a4b-d9e9-43c1-8e88-0c803abba2aa.svg class=card-icon></img><div ><h3 class="slate-h3 " >Card Title</h3><p class="slate-p " >Add description here</p></div></div><div class="card-box"><img src=https://theneo-prod-public.s3.us-east-1.amazonaws.com/6fa6cfd5-d582-4745-bdcd-2f26bbc4350d.svg class=card-icon></img><div ><h3 class="slate-h3 " >Card Title</h3><p class="slate-p " >Add description here</p></div></div><div class="card-box"><img src=https://theneo-prod-public.s3.us-east-1.amazonaws.com/f2e566b0-741a-4870-a713-a98e4c324021.svg class=card-icon></img><div ><h3 class="slate-h3 " >Card Title</h3><p class="slate-p " >Add description here</p></div></div><div class="card-box"><img src=https://theneo-prod-public.s3.us-east-1.amazonaws.com/ec8b2319-8cc4-4431-8edf-7c24944c6afb.svg class=card-icon></img><div ><h3 class="slate-h3 " >Card Title</h3><p class="slate-p " >Add description here</p></div></div></div><p class="slate-p " ></p><h3 class="slate-h3 " >Accordion</h3><div class="accordions-widget " style="width:100%"><details class="accordion-item"><summary class=accordion-header><div class=accordion-title><h3>🚀 Getting Started with the Accordion Widget</h3></div><div class=accordion-toggle><svg fill=none height=8 viewBox="0 0 12 8"width=12><path d="M11.3278 0.792629C11.1872 0.795955 11.0535 0.854737 10.956 0.956171L5.99972 5.91242L1.04347 0.956171C0.993767 0.90508 0.93433 0.86447 0.868669 0.836738C0.803007 0.809006 0.732454 0.794716 0.661176 0.794712C0.555079 0.79474 0.4514 0.826409 0.363395 0.885669C0.27539 0.94493 0.207057 1.02909 0.167133 1.12739C0.12721 1.22569 0.117509 1.33366 0.139271 1.4375C0.161033 1.54135 0.213269 1.63634 0.289301 1.71034L5.62264 7.04367C5.72266 7.14365 5.85829 7.19982 5.99972 7.19982C6.14114 7.19982 6.27678 7.14365 6.3768 7.04367L11.7101 1.71034C11.7876 1.63586 11.8407 1.53972 11.8626 1.43451C11.8845 1.32931 11.8741 1.21995 11.8328 1.12076C11.7915 1.02157 11.7212 0.937165 11.6311 0.878615C11.541 0.820064 11.4353 0.790094 11.3278 0.792629Z"fill=#141719 fill-opacity=0.84 /></svg></div></summary><div class="accordion-content"><div class="slate-div"></div><p class="slate-p " >Welcome to the Accordion Widget! This feature helps keep your content organized and user-friendly. Below are some key details you can include inside an accordion:</p><p class="slate-p " >📌 <strong class="slate-bold">Key Features:</strong></p><ul class="slate-ul " ><li class="slate-li " ><div style="position:relative">Expandable and collapsible sections</div></li><li class="slate-li " ><div style="position:relative">Supports text, images, callouts, and code blocks</div></li><li class="slate-li " ><div style="position:relative">Ideal for FAQs, step-by-step guides, and technical documentation</div></li></ul></div></details></div><p class="slate-p " ></p><h3 class="slate-h3 " >Accordion Group</h3><div class="accordions-widget multi" style="width:100%"><details class="accordion-item"><summary class=accordion-header><div class=accordion-title><h3>📌 What is API Documentation?</h3></div><div class=accordion-toggle><svg fill=none height=8 viewBox="0 0 12 8"width=12><path d="M11.3278 0.792629C11.1872 0.795955 11.0535 0.854737 10.956 0.956171L5.99972 5.91242L1.04347 0.956171C0.993767 0.90508 0.93433 0.86447 0.868669 0.836738C0.803007 0.809006 0.732454 0.794716 0.661176 0.794712C0.555079 0.79474 0.4514 0.826409 0.363395 0.885669C0.27539 0.94493 0.207057 1.02909 0.167133 1.12739C0.12721 1.22569 0.117509 1.33366 0.139271 1.4375C0.161033 1.54135 0.213269 1.63634 0.289301 1.71034L5.62264 7.04367C5.72266 7.14365 5.85829 7.19982 5.99972 7.19982C6.14114 7.19982 6.27678 7.14365 6.3768 7.04367L11.7101 1.71034C11.7876 1.63586 11.8407 1.53972 11.8626 1.43451C11.8845 1.32931 11.8741 1.21995 11.8328 1.12076C11.7915 1.02157 11.7212 0.937165 11.6311 0.878615C11.541 0.820064 11.4353 0.790094 11.3278 0.792629Z"fill=#141719 fill-opacity=0.84 /></svg></div></summary><div class="accordion-content"><div class="slate-div"></div><p class="slate-p " >API documentation provides a detailed guide on how to interact with an API, including endpoint details, request/response formats, authentication methods, and usage examples.</p><p class="slate-p " >💡 <strong class="slate-bold">Why is it Important?</strong></p><ul class="slate-ul " ><li class="slate-li " ><div style="position:relative">Helps developers understand API functionality </div></li><li class="slate-li " ><div style="position:relative">Improves integration efficiency </div></li><li class="slate-li " ><div style="position:relative">Ensures consistency in API usage </div></li></ul></div></details><details class="accordion-item"><summary class=accordion-header><div class=accordion-title><h3> 🔑  How to Authenticate API Requests</h3></div><div class=accordion-toggle><svg fill=none height=8 viewBox="0 0 12 8"width=12><path d="M11.3278 0.792629C11.1872 0.795955 11.0535 0.854737 10.956 0.956171L5.99972 5.91242L1.04347 0.956171C0.993767 0.90508 0.93433 0.86447 0.868669 0.836738C0.803007 0.809006 0.732454 0.794716 0.661176 0.794712C0.555079 0.79474 0.4514 0.826409 0.363395 0.885669C0.27539 0.94493 0.207057 1.02909 0.167133 1.12739C0.12721 1.22569 0.117509 1.33366 0.139271 1.4375C0.161033 1.54135 0.213269 1.63634 0.289301 1.71034L5.62264 7.04367C5.72266 7.14365 5.85829 7.19982 5.99972 7.19982C6.14114 7.19982 6.27678 7.14365 6.3768 7.04367L11.7101 1.71034C11.7876 1.63586 11.8407 1.53972 11.8626 1.43451C11.8845 1.32931 11.8741 1.21995 11.8328 1.12076C11.7915 1.02157 11.7212 0.937165 11.6311 0.878615C11.541 0.820064 11.4353 0.790094 11.3278 0.792629Z"fill=#141719 fill-opacity=0.84 /></svg></div></summary><div class="accordion-content"><div class="slate-div"></div><p class="slate-p " ><strong class="slate-bold">API Authentication Methods:</strong></p><ol class="slate-ol " ><li class="slate-li " ><div style="position:relative"><strong class="slate-bold">API Key:</strong> Include an API key in the request headers. </div></li><li class="slate-li " ><div style="position:relative"><strong class="slate-bold">OAuth 2.0:</strong> Authenticate via access tokens. </div></li><li class="slate-li " ><div style="position:relative"><strong class="slate-bold">JWT Tokens:</strong> Secure authentication with signed tokens. </div></li></ol><p class="slate-p " >💡 <strong class="slate-bold">Example API Key Authentication:</strong></p><div class="code-block-wrapper"  style="width:100%;min-width:100%" ><div class="code-block-header">CURL</div><pre class="slate-CodeBlockElement slate-code_block"><textarea id="publishedPageCodeblock" style="display:none !important; visibility: hidden; opacity: 0; width: 1px; height: 1px;" type="hidden"> </textarea><code class="language-shell keep-markup drop-tokens"><div class="slate-code_line"><div class="slate-code_line">curl -H &quot;Authorization: Bearer YOUR_API_KEY&quot; https://api.example.com/data</div></div></code></pre></div><p class="slate-p " ></p></div></details><details class="accordion-item"><summary class=accordion-header><div class=accordion-title><h3>⚠️ Common API Errors</h3></div><div class=accordion-toggle><svg fill=none height=8 viewBox="0 0 12 8"width=12><path d="M11.3278 0.792629C11.1872 0.795955 11.0535 0.854737 10.956 0.956171L5.99972 5.91242L1.04347 0.956171C0.993767 0.90508 0.93433 0.86447 0.868669 0.836738C0.803007 0.809006 0.732454 0.794716 0.661176 0.794712C0.555079 0.79474 0.4514 0.826409 0.363395 0.885669C0.27539 0.94493 0.207057 1.02909 0.167133 1.12739C0.12721 1.22569 0.117509 1.33366 0.139271 1.4375C0.161033 1.54135 0.213269 1.63634 0.289301 1.71034L5.62264 7.04367C5.72266 7.14365 5.85829 7.19982 5.99972 7.19982C6.14114 7.19982 6.27678 7.14365 6.3768 7.04367L11.7101 1.71034C11.7876 1.63586 11.8407 1.53972 11.8626 1.43451C11.8845 1.32931 11.8741 1.21995 11.8328 1.12076C11.7915 1.02157 11.7212 0.937165 11.6311 0.878615C11.541 0.820064 11.4353 0.790094 11.3278 0.792629Z"fill=#141719 fill-opacity=0.84 /></svg></div></summary><div class="accordion-content"><div class="slate-div"></div><ul class="slate-ul " ><li class="slate-li " ><div style="position:relative"><strong class="slate-bold">400 Bad Request:</strong> Invalid request syntax. </div></li><li class="slate-li " ><div style="position:relative"><strong class="slate-bold">401 Unauthorized:</strong> Missing or invalid authentication. </div></li><li class="slate-li " ><div style="position:relative"><strong class="slate-bold">404 Not Found:</strong> Requested resource doesn’t exist. </div></li><li class="slate-li " ><div style="position:relative"><strong class="slate-bold">500 Internal Server Error:</strong> Unexpected issue on the server. </div></li></ul><p class="slate-p " >💡 <strong class="slate-bold">How to Fix Errors?</strong></p><ul class="slate-ul " ><li class="slate-li " ><div style="position:relative">Double-check request parameters and headers. </div></li><li class="slate-li " ><div style="position:relative">Ensure authentication credentials are correct. </div></li><li class="slate-li " ><div style="position:relative">Review API documentation for required inputs</div></li></ul></div></details></div><p class="slate-p " ></p><h3 class="slate-h3 " >Steps</h3><h4 class="slate-h4 " >How to Add a Steps Widget</h4><div class="steps-widget" style="width:100%;
  	min-width:100%;"><div class="steps-wrapper"><div class="steps-content"><h6 class="slate-h6 " >1</h6><h4 class="slate-h4 " >First Step</h4><p class="slate-p " >Navigate to the point in your text where you want to insert the Steps widget.</p></div></div><div class="steps-wrapper"><div class="steps-content"><h6 class="slate-h6 " >2</h6><h4 class="slate-h4 " >Second Step</h4><p class="slate-p " >Type <code class="slate-code">/Steps</code> on a new line.</p><div style="text-align:left"><img src="https://theneo-prod-public.s3.us-east-1.amazonaws.com/4e4ab6be-c9c7-4ae3-8f93-91e0f762aa9b.png" style="
              width:379px;
	            height:371px;
	            aspect-ratio:379 / 371"
         /></div></div></div><div class="steps-wrapper"><div class="steps-content"><h6 class="slate-h6 " >3</h6><h4 class="slate-h4 " >Third Step</h4><p class="slate-p " >Select the Steps option that appears.</p><p class="slate-p " ></p></div></div></div><p class="slate-p " ></p><h3 class="slate-h3 " >Table</h3><div class="table-container" style="width:100%;
  min-width:100%;"><table class="slate-table" style="min-width:100%"><div class="published-table-header" style="width:100%;min-width:100%;"><div style="width:0px;">Feature</div><div style="width:375px;">Description</div><div style="width:0px;">Available</div></div><colgroup ><col style="width:initial"><col style="width:375px"><col style="width:initial"></colgroup><tbody class="slate-TableElement-tbody"><tr class="slate-tr " ><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >Authentication</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >Secure user login with OAuth2.0</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >Yes</p></td></div></tr><tr class="slate-tr " ><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >Rate Limiting</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >Limits the number of requests per hour</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >Yes</p></td></div></tr><tr class="slate-tr " ><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >Data Export</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >Ability to export data in various formats</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >No</p></td></div></tr><tr class="slate-tr " ><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >Real-time Updates</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >Provides live updates without refreshing</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >Yes</p></td></div></tr><tr class="slate-tr " ><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >Multi-Language Support</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >Documentation available in multiple languages</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >Coming Soon</p></td></div></tr></tbody></table></div><p class="slate-p " ></p>

Theneo's web editor is a rich and intuitive platform, equipped with a variety of widgets that enrich the documentation experience. These widgets add depth and clarity to your API documentation, making it more engaging and informative. You can easily access these widgets by simply going to a new line in the editor and typing /, which brings up the widget options.

Additionally, Theneo's live collaboration feature enables real-time teamwork, allowing multiple users to simultaneously edit, comment, and review documentation. This streamlines the editing process, reduces bottlenecks, and fosters seamless collaboration across teams. Whether you're working in the same room or across different time zones, live collaboration ensures that everyone stays aligned and up to date on changes.

Let's take a look at the widgets available:

Perfect for displaying code snippets, helping users und/erstand implementation details in different programming languages. 

Here's an example of a formatted code snippet in JavaScript:

Feature

Description

Available

<p class="slate-p slate-indent-0" style="0px">Theneo offers a comprehensive and flexible selection of API formats and collection types to meet diverse integration and development needs. Our platform supports various API formats, such as REST, SOAP, GraphQL, and Async APIs, each designed for specific use cases and requirements. We also provide compatibility with multiple API specification collections, ensuring smooth integration and an efficient development process.</p><p class="slate-p " ></p><h3 class="slate-h3 " >HTTP Methods</h3><p class="slate-p " >HTTP methods, or verbs, denote actions performed on resources. Theneo APIs support various HTTP methods:</p><ul class="slate-ul " ><li class="slate-li " ><div style="position:relative"><strong class="slate-bold">GET:</strong> Retrieve a representation of a specific resource.</div><ul class="slate-ul " ><li class="slate-li " ><div style="position:relative">Example: Retrieving transaction details.</div></li></ul></li><li class="slate-li " ><div style="position:relative"><strong class="slate-bold">POST:</strong> Submit data to create a new resource or trigger a state change.</div><ul class="slate-ul " ><li class="slate-li " ><div style="position:relative">Example: Creating a new customer profile.</div></li></ul></li><li class="slate-li " ><div style="position:relative"><strong class="slate-bold">PUT:</strong> Replace all representations of a target resource with the provided payload.</div><ul class="slate-ul " ><li class="slate-li " ><div style="position:relative">Example: Updating a subscription plan.</div></li></ul></li><li class="slate-li " ><div style="position:relative"><strong class="slate-bold">DELETE:</strong> Remove a specified resource.</div><ul class="slate-ul " ><li class="slate-li " ><div style="position:relative">Example: Deleting a stored card.</div></li></ul></li><li class="slate-li " ><div style="position:relative"><strong class="slate-bold">PATCH:</strong> Apply partial modifications to a resource.</div><ul class="slate-ul " ><li class="slate-li " ><div style="position:relative">Example: Changing the status of an existing order.</div></li></ul></li></ul><p class="slate-p " ></p><h3 class="slate-h3 " >Parameters</h3><p class="slate-p " >Parameters allow customization of API requests and responses. Theneo APIs support four types of parameters:</p><ul class="slate-ul " ><li class="slate-li " ><div style="position:relative"><strong class="slate-bold">Path Parameters:</strong> Integral parts of the endpoint URL, identifying specific resources.</div></li><li class="slate-li " ><div style="position:relative"><strong class="slate-bold">Query Parameters:</strong> Appended to the endpoint URL to filter or paginate results.</div></li><li class="slate-li " ><div style="position:relative"><strong class="slate-bold">Request Body Parameters:</strong> Included in the request body, transmitting data to the API server.</div></li><li class="slate-li " ><div style="position:relative"><strong class="slate-bold">Response Body Parameters:</strong> Represent data returned by the server in response to a request.</div></li></ul><p class="slate-p " ></p><h3 class="slate-h3 " >HTTP Status Codes</h3><p class="slate-p " >HTTP status codes communicate the outcome of client requests. Theneo employs HTTP status codes categorized into the following classes:</p><ul class="slate-ul " ><li class="slate-li " ><div style="position:relative"><strong class="slate-bold">Success (200):</strong> The request was successfully processed.</div><ul class="slate-ul " ><li class="slate-li " ><div style="position:relative">Example: Successfully retrieved a resource or completed an action.</div></li></ul></li><li class="slate-li " ><div style="position:relative"><strong class="slate-bold">400 (Bad Request):</strong> The server could not understand the request due to invalid syntax.</div><ul class="slate-ul " ><li class="slate-li " ><div style="position:relative">Example: Missing required parameters in the request.</div></li></ul></li><li class="slate-li " ><div style="position:relative"><strong class="slate-bold">401 (Unauthorized):</strong> Authentication is required and has failed or has not yet been provided.</div><ul class="slate-ul " ><li class="slate-li " ><div style="position:relative">Example: Invalid or missing API key.</div></li></ul></li><li class="slate-li " ><div style="position:relative"><strong class="slate-bold">402 (Request Failed):</strong> The parameters were valid but the request failed.</div><ul class="slate-ul " ><li class="slate-li " ><div style="position:relative">Example: Insufficient funds or expired credit card.</div></li></ul></li><li class="slate-li " ><div style="position:relative"><strong class="slate-bold">403 (Forbidden):</strong> The client does not have access rights to the content.</div><ul class="slate-ul " ><li class="slate-li " ><div style="position:relative">Example: Attempting to access a resource without the necessary permissions.</div></li></ul></li><li class="slate-li " ><div style="position:relative"><strong class="slate-bold">404 (Not Found):</strong> The server can not find the requested resource.</div><ul class="slate-ul " ><li class="slate-li " ><div style="position:relative">Example: Trying to access an endpoint that does not exist.</div></li></ul></li></ul><p class="slate-p " ></p><p class="slate-p " ></p>

Theneo offers a comprehensive and flexible selection of API formats and collection types to meet diverse integration and development needs. Our platform supports various API formats, such as REST, SOAP, GraphQL, and Async APIs, each designed for specific use cases and requirements. We also provide compatibility with multiple API specification collections, ensuring smooth integration and an efficient development process.

HTTP methods, or verbs, denote actions performed on resources. Theneo APIs support various HTTP methods:

Parameters allow customization of API requests and responses. Theneo APIs support four types of parameters:

HTTP status codes communicate the outcome of client requests. Theneo employs HTTP status codes categorized into the following classes:

The request was unacceptable, often due to missing a required parameter.

The parameters were valid but the request failed.

The API key doesnt have permissions to perform the request.

<p class="slate-p slate-indent-0" style="0px">When it comes to interacting with APIs, authentication is a critical step to ensure secure communication between your application and the API service. API authentication is performed via HTTP Basic Auth, which involves including your API key in the HTTP request headers. This method verifies your identity and grants you access to the API&apos;s resources, ensuring that only authorized users can make requests.</p><p class="slate-p slate-indent-0" style="0px">Theneo Sample API uses <code class="slate-code">API keys</code> to authenticate requests. </p><p class="slate-p " ></p><h2 class="slate-h2 " >Add headers to an HTTP request</h2><p class="slate-p slate-indent-0" style="0px">When issuing an HTTP request to Theneo, each request must contain an <code class="slate-code">Api-Key</code> header that specifies a valid API key and must be encoded as JSON with the <code class="slate-code">Content-Type: application/json</code> header.</p><p class="slate-p slate-indent-0" style="0px"></p><div class="code-block-wrapper"  style="width:100%" ><div class="code-block-header">CURL</div><pre class="slate-CodeBlockElement slate-code_block"><textarea id="publishedPageCodeblock" style="display:none !important; visibility: hidden; opacity: 0; width: 1px; height: 1px;" type="hidden"> </textarea><code class="language-shell keep-markup drop-tokens"><div class="slate-code_line">curl -s -X POST &quot;https://app.theneo.io&quot; \</div><div class="slate-code_line">   -H &quot;Content-Type: application/json&quot; \</div><div class="slate-code_line">   -H &quot;Api-Key: YOUR_API_KEY&quot; \</div><div class="slate-code_line">   -d &apos;{</div><div class="slate-code_line">         &quot;given_name&quot;:  &quot;Theneo&quot;,</div><div class="slate-code_line">         &quot;last_name&quot;: &quot;APIDoc&quot;,</div><div class="slate-code_line">         &quot;mail&quot;: &quot;hello@theneo.io&quot;,</div><div class="slate-code_line">         &quot;phone_number&quot;: &quot;&quot;</div><div class="slate-code_line">      }</div></code></pre></div><p class="slate-p " ></p><div style="width:100%;
	min-width:100%;" class="callout-widget" data-type=warning ><div class="callout-icon"><svg width="18" height="16" viewBox="0 0 18 16" fill="none" xmlns="http://www.w3.org/2000/svg"><path d="M0.916637 15.5009C0.791637 15.5009 0.683998 15.4732 0.59372 15.4176C0.503443 15.362 0.430526 15.2857 0.37497 15.1884C0.319415 15.0912 0.288165 14.9905 0.28122 14.8864C0.274276 14.7822 0.305526 14.6745 0.37497 14.5634L8.4583 0.605103C8.52775 0.493991 8.60761 0.41413 8.69789 0.365519C8.78816 0.316908 8.88886 0.292603 8.99997 0.292603C9.11108 0.292603 9.21178 0.316908 9.30205 0.365519C9.39233 0.41413 9.47219 0.493991 9.54164 0.605103L17.625 14.5634C17.6944 14.6745 17.7257 14.7822 17.7187 14.8864C17.7118 14.9905 17.6805 15.0912 17.625 15.1884C17.5694 15.2857 17.4965 15.362 17.4062 15.4176C17.3159 15.4732 17.2083 15.5009 17.0833 15.5009H0.916637ZM1.99997 14.2509H16L8.99997 2.1676L1.99997 14.2509ZM9.0833 13.0634C9.26386 13.0634 9.41316 13.0044 9.53122 12.8864C9.64928 12.7683 9.7083 12.619 9.7083 12.4384C9.7083 12.2579 9.64928 12.1086 9.53122 11.9905C9.41316 11.8725 9.26386 11.8134 9.0833 11.8134C8.90275 11.8134 8.75344 11.8725 8.63539 11.9905C8.51733 12.1086 8.4583 12.2579 8.4583 12.4384C8.4583 12.619 8.51733 12.7683 8.63539 12.8864C8.75344 13.0044 8.90275 13.0634 9.0833 13.0634ZM9.0833 10.7509C9.26386 10.7509 9.41316 10.6919 9.53122 10.5739C9.64928 10.4558 9.7083 10.3065 9.7083 10.1259V6.70927C9.7083 6.52871 9.64928 6.37941 9.53122 6.26135C9.41316 6.1433 9.26386 6.08427 9.0833 6.08427C8.90275 6.08427 8.75344 6.1433 8.63539 6.26135C8.51733 6.37941 8.4583 6.52871 8.4583 6.70927V10.1259C8.4583 10.3065 8.51733 10.4558 8.63539 10.5739C8.75344 10.6919 8.90275 10.7509 9.0833 10.7509Z" fill="#F1C21B"></path></svg></div><div ><p class="slate-p " >Your API keys grant significant access, so it’s crucial to keep them safe! Avoid sharing your secret API keys in public places like GitHub, client-side code, and similar locations.</p></div></div><div style="width:100%;
	min-width:100%;" class="callout-widget" data-type=error ><div class="callout-icon"><svg width="18" height="18" viewBox="0 0 18 18" fill="none" xmlns="http://www.w3.org/2000/svg"><path d="M9.08366 9.9801C9.25033 9.9801 9.39269 9.92107 9.51074 9.80302C9.6288 9.68496 9.68783 9.53566 9.68783 9.3551V5.31344C9.68783 5.14677 9.62533 5.00441 9.50033 4.88635C9.37533 4.7683 9.22949 4.70927 9.06283 4.70927C8.88227 4.70927 8.73296 4.7683 8.61491 4.88635C8.49685 5.00441 8.43783 5.15371 8.43783 5.33427V9.37594C8.43783 9.5426 8.50033 9.68496 8.62533 9.80302C8.75033 9.92107 8.9031 9.9801 9.08366 9.9801ZM9.00033 13.1676C9.19477 13.1676 9.35796 13.1016 9.48991 12.9697C9.62185 12.8377 9.68783 12.6745 9.68783 12.4801C9.68783 12.2857 9.62185 12.1225 9.48991 11.9905C9.35796 11.8586 9.19477 11.7926 9.00033 11.7926C8.80588 11.7926 8.64269 11.8586 8.51074 11.9905C8.3788 12.1225 8.31283 12.2857 8.31283 12.4801C8.31283 12.6745 8.3788 12.8377 8.51074 12.9697C8.64269 13.1016 8.80588 13.1676 9.00033 13.1676ZM9.00033 17.3343C7.81977 17.3343 6.72255 17.1225 5.70866 16.6989C4.69477 16.2752 3.81283 15.6884 3.06283 14.9384C2.31283 14.1884 1.72602 13.3065 1.30241 12.2926C0.878798 11.2787 0.666992 10.1815 0.666992 9.00094C0.666992 7.83427 0.878798 6.74399 1.30241 5.7301C1.72602 4.71621 2.31283 3.83427 3.06283 3.08427C3.81283 2.33427 4.69477 1.74399 5.70866 1.31344C6.72255 0.88288 7.81977 0.667603 9.00033 0.667603C10.167 0.667603 11.2573 0.88288 12.2712 1.31344C13.285 1.74399 14.167 2.33427 14.917 3.08427C15.667 3.83427 16.2573 4.71621 16.6878 5.7301C17.1184 6.74399 17.3337 7.83427 17.3337 9.00094C17.3337 10.1815 17.1184 11.2787 16.6878 12.2926C16.2573 13.3065 15.667 14.1884 14.917 14.9384C14.167 15.6884 13.285 16.2752 12.2712 16.6989C11.2573 17.1225 10.167 17.3343 9.00033 17.3343ZM9.00033 16.0843C10.9448 16.0843 12.6114 15.3898 14.0003 14.0009C15.3892 12.612 16.0837 10.9454 16.0837 9.00094C16.0837 7.05649 15.3892 5.38982 14.0003 4.00094C12.6114 2.61205 10.9448 1.9176 9.00033 1.9176C7.05588 1.9176 5.38921 2.61205 4.00033 4.00094C2.61144 5.38982 1.91699 7.05649 1.91699 9.00094C1.91699 10.9454 2.61144 12.612 4.00033 14.0009C5.38921 15.3898 7.05588 16.0843 9.00033 16.0843Z" fill="#E90005"></path></svg></div><div ><p class="slate-p slate-indent-0" style="0px">API requests without authentication will fail.</p></div></div><p class="slate-p " ></p><h2 class="slate-h2 " >To retrieve your API key from app.theneo.io, follow these steps:</h2><p class="slate-p " ></p><div class="steps-widget" style="width:100%;
  	min-width:100%;"><div class="steps-wrapper"><div class="steps-content"><h6 class="slate-h6 " >1</h6><h3 class="slate-h3 " >Sign in</h3><p class="slate-p " >Navigate to app.theneo.io and sign in with your credentials.</p></div></div><div class="steps-wrapper"><div class="steps-content"><h6 class="slate-h6 " >2</h6><h3 class="slate-h3 " >User Settings</h3><p class="slate-p " >Once logged in, locate the user settings.</p></div></div><div class="steps-wrapper"><div class="steps-content"><h6 class="slate-h6 " >3</h6><h3 class="slate-h3 " >Tools &amp; Integrations Tab</h3><p class="slate-p " >Within the user settings, find the &quot;Tools &amp; Integrations&quot; tab. Click on it to access settings related to integrations and tools.</p></div></div><div class="steps-wrapper"><div class="steps-content"><h6 class="slate-h6 " >4</h6><h3 class="slate-h3 " >Locate API Key</h3><p class="slate-p " >In the Tools &amp; Integrations tab, you should find your API key listed.</p></div></div></div><p class="slate-p " ></p>

When it comes to interacting with APIs, authentication is a critical step to ensure secure communication between your application and the API service. API authentication is performed via HTTP Basic Auth, which involves including your API key in the HTTP request headers. This method verifies your identity and grants you access to the API's resources, ensuring that only authorized users can make requests.

When issuing an HTTP request to Theneo, each request must contain an 

 header that specifies a valid API key and must be encoded as JSON with the 

To retrieve your API key from app.theneo.io, follow these steps:

<p class="slate-p " >Create customer allows users to add a new customer to the system, providing essential details such as name, email, address, and phone number. By utilizing this functionality, users can easily store and manage customer information for seamless transactions and interactions within the application.</p><p class="slate-p " ></p>

Create customer allows users to add a new customer to the system, providing essential details such as name, email, address, and phone number. By utilizing this functionality, users can easily store and manage customer information for seamless transactions and interactions within the application.

given_name

last_name

email_address

address

phone_number

The reference ID associated with the customer.

reference_id

Any additional notes or comments related to the customer.

note

The token or credentials required to authorize the request.

Authorization

The type of content included in the request or response.

Content-Type

The customer parameter contains details and information related to the newly created customer profile.

customer

The errors parameter provides information on any errors encountered during the customer creation process.

errors

<p class="slate-p " >Update customer allows users to modify and update customer information within the system. Users can easily adjust customer details such as name, email, phone number, and more. This section provides a seamless way to keep customer data accurate and up-to-date.</p><p class="slate-p " ></p><p class="slate-p " ></p>

Update customer allows users to modify and update customer information within the system. Users can easily adjust customer details such as name, email, phone number, and more. This section provides a seamless way to keep customer data accurate and up-to-date.

The given name or first name of the customer.

last_Name

email

password

The phone number associated with the customer.

phone

userStatus

The authorization token for accessing the API.

The type of content in the request or response.

customer_id

The customer parameter contains the updated information of the customer after the update request.

The errors parameter includes any error messages or issues encountered during the customer update process.

<p class="slate-p " >This section allows users to retrieve detailed information about a specific customer within the system. Users can access essential details such as the customer's name, email address, phone number, address, and creation source. By utilizing this functionality, users can efficiently manage customer data and preferences.</p><p class="slate-p " ></p><p class="slate-p " ></p><p class="slate-p " ></p>

This section allows users to retrieve detailed information about a specific customer within the system. Users can access essential details such as the customer's name, email address, phone number, address, and creation source. By utilizing this functionality, users can efficiently manage customer data and preferences.

Header parameter for authorization to access the customer information.

Header parameter specifying the content type of the response.

Path parameter representing the unique identifier of the customer.

<p class="slate-p " >This section allows users to retrieve a list of all customers associated with the project. By accessing this data, users can gain insights into their customer base, track customer interactions, and manage customer information effectively within the project.</p><p class="slate-p " ></p><p class="slate-p " ></p>

This section allows users to retrieve a list of all customers associated with the project. By accessing this data, users can gain insights into their customer base, track customer interactions, and manage customer information effectively within the project.

Represents the email address associated with a customer.

Specifies a date and time for filtering customer records based on the creation datetime.

created

Contains the authentication credentials required to access the API.

Specifies the format of the data in the request or response.

Indicates the type of object being returned in the response.

object

Represents the URL associated with a customer.

Flag that indicates whether there are more customer records available.

has_more

Contains the data related to the customer records being returned in the response.

data

<p class="slate-p " >Deletes a customer from the system permanently, and this action cannot be reversed. Additionally, it promptly cancels any active subscriptions associated with the customer.</p><p class="slate-p " ></p><p class="slate-p " ></p>

Deletes a customer from the system permanently, and this action cannot be reversed. Additionally, it promptly cancels any active subscriptions associated with the customer.

This header parameter is used to authenticate the request and must contain a valid API key.

This header parameter specifies the media type of the request body, with the value typically set to "application/json".

This path parameter specifies the unique identifier of the customer to be deleted.

This response parameter specifies the unique identifier of the customer that was deleted.

This response parameter represents the JSON object returned upon successful deletion of the customer.

This response parameter indicates whether the customer was successfully deleted (true) or not (false).

Sections