Roboto

Theneo Quickstart Guide 🚀

Getting Started

Customizing

Theneo web editor

API Reference Guide

Basics of APIs

Base URL

Authentication

Rest API Reference

Create customer

Update customer

Retrieve customer

List all customers

Delete customer

Blank

Theneo Sample Project

Production

Sandbox

<p class="slate-p " >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.</p><div style="text-align:left"><img src="https://theneo-prod-public.s3.us-east-1.amazonaws.com/8f2c11a7-8beb-462d-8e31-00329170c52b.png" style="
              width:612px;
	            height:313px;
	            aspect-ratio:612 / 313"
         /></div><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 " >Uploading Your API Specification</h3><p class="slate-p slate-indent-0" style="0px">Theneo supports various API specs, like Swagger, OpenAPI, and GraphQL, with an easy upload process. If you don&apos;t have a spec, use our tools to create one from scratch</p></div></div><div class="steps-wrapper"><div class="steps-content"><h6 class="slate-h6 " >2</h6><h3 class="slate-h3 " >Selecting Your AI Co-pilot</h3><p class="slate-p slate-indent-0" style="0px">After uploading your API spec, use Theneo&apos;s AI Co-pilot to generate or enhance content. For a faster setup, click &apos;Quick Start&apos; to go straight to publishing.</p></div></div><div class="steps-wrapper"><div class="steps-content"><h6 class="slate-h6 " >3</h6><h3 class="slate-h3 " >Setting Permissions</h3><p class="slate-p slate-indent-0" style="0px">Set your project&apos;s visibility and invite collaborators as needed. Start privately and go public when ready, managing settings anytime to match your development lifecycle.</p></div></div></div><p class="slate-p " ></p>

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.

<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><p class="slate-p slate-indent-0" style="0px">General Settings:</p><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><p class="slate-p " >Global Settings:</p><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><p class="slate-p " >Left Sidebar Menu:</p><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><p class="slate-p " >Widget Cards:</p><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><p class="slate-p " ></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><ul class="slate-ul " ><li class="slate-li " ><div style="position:relative"><span style="color:var(--tw-prose-bold)"><strong class="slate-bold">Code Blocks</strong></span>: Perfect for displaying code snippets, helping users und/erstand implementation details in different programming languages.</div></li><li class="slate-li " ><div style="position:relative"><span style="color:var(--tw-prose-bold)"><strong class="slate-bold">Divider</strong></span>: A simple yet effective tool to create clear separations between sections, enhancing readability and structure.</div></li><li class="slate-li " ><div style="position:relative"><span style="color:var(--tw-prose-bold)"><strong class="slate-bold">Callout</strong></span>: Draws focus to important information, tips, or warnings, ensuring key messages are not missed.</div></li><li class="slate-li " ><div style="position:relative"><span style="color:var(--tw-prose-bold)"><strong class="slate-bold">Table</strong></span>: Ideal for presenting data or information systematically, making complex details easier to digest.</div></li><li class="slate-li " ><div style="position:relative"><span style="color:var(--tw-prose-bold)"><strong class="slate-bold">Image &amp; Video</strong></span>: Brings your documentation to life with visual content like diagrams, screenshots, or explanatory videos, offering a richer understanding.</div></li><li class="slate-li " ><div style="position:relative"><span style="color:var(--tw-prose-bold)"><strong class="slate-bold">Object Example</strong></span>: Shows practical examples of objects used in your API, demystifying complex data structures for better comprehension.</div></li><li class="slate-li " ><div style="position:relative"><span style="color:var(--tw-prose-bold)"><strong class="slate-bold">Error Codes</strong></span>: Outlines potential errors that might occur, providing a guide for troubleshooting and error resolution.</div></li><li class="slate-li " ><div style="position:relative"><span style="color:var(--tw-prose-bold)"><strong class="slate-bold">Status Codes</strong></span>: Clarifies the HTTP status codes your API returns, giving insights into various responses and their meanings.</div></li><li class="slate-li " ><div style="position:relative"><span style="color:var(--tw-prose-bold)"><strong class="slate-bold">Base URL</strong></span>: Displays the base URL of your API prominently, a crucial starting point for users making API requests.</div></li><li class="slate-li " ><div style="position:relative"><span style="color:var(--tw-prose-bold)"><strong class="slate-bold">Language Box</strong></span>: Allows for multi-language documentation, offering code examples in various programming languages to cater to a diverse audience.</div></li><li class="slate-li " ><div style="position:relative"><span style="color:var(--tw-prose-bold)"><strong class="slate-bold">Request Widget</strong></span>: Demonstrates specific API requests, detailing parameters, headers, and other necessary request components.</div></li><li class="slate-li " ><div style="position:relative"><span style="color:var(--tw-prose-bold)"><strong class="slate-bold">Response Widget</strong></span>: Provides examples of API responses, helping users understand expected outcomes from their API interactions.</div></li></ul><p class="slate-p " ></p><p class="slate-p " >Each widget is tailored to enhance specific aspects of API documentation, making Theneo&apos;s web editor a versatile tool for developers and technical writers. As you proceed with documentation, these widgets can be seamlessly integrated to cater to your content needs, ensuring a comprehensive and user-friendly experience.</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:

Each widget is tailored to enhance specific aspects of API documentation, making Theneo's web editor a versatile tool for developers and technical writers. As you proceed with documentation, these widgets can be seamlessly integrated to cater to your content needs, ensuring a comprehensive and user-friendly experience.

<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">The Base URL is a crucial element for making API calls, enabling you to clearly specify the root URL(s) for API requests. When making API calls, you combine the base URL with the specific endpoint path to form the complete request URL.</p><p class="slate-p slate-indent-0" style="0px">It supports multiple environments, including staging and production. Additionally, the base URL synchronizes with the API explorer, allowing you to seamlessly switch between environments like Sandbox and Production while trying out API calls.</p>

The Base URL is a crucial element for making API calls, enabling you to clearly specify the root URL(s) for API requests. When making API calls, you combine the base URL with the specific endpoint path to form the complete request URL.

It supports multiple environments, including staging and production. Additionally, the base URL synchronizes with the API explorer, allowing you to seamlessly switch between environments like Sandbox and Production while trying out API calls.

<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'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><h3 class="slate-h3 " >To retrieve your API key from app.theneo.io, follow these steps:</h3><ol class="slate-ol " ><li class="slate-li " ><div style="position:relative"><strong class="slate-bold">Sign in</strong>: Navigate to app.theneo.io and sign in with your credentials.</div></li><li class="slate-li " ><div style="position:relative"><strong class="slate-bold">User Settings</strong>: Once logged in, locate the user settings. </div></li><li class="slate-li " ><div style="position:relative"><strong class="slate-bold">Tools & Integrations Tab</strong>: Within the user settings, find the "Tools & Integrations" tab. Click on it to access settings related to integrations and tools.</div></li><li class="slate-li " ><div style="position:relative"><strong class="slate-bold">Locate API Key</strong>: In the Tools & Integrations tab, you should find your API key listed. </div></li></ol><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"><code class="language-shell keep-markup drop-tokens"><div class="slate-code_line">curl -s -X POST "https://app.theneo.io" \</div><div class="slate-code_line">   -H "Content-Type: application/json" \</div><div class="slate-code_line">   -H "Api-Key: YOUR_API_KEY" \</div><div class="slate-code_line">   -d '{</div><div class="slate-code_line">         "given_name":  "Theneo",</div><div class="slate-code_line">         "last_name": "APIDoc",</div><div class="slate-code_line">         "mail": "hello@theneo.io",</div><div class="slate-code_line">         "phone_number": ""</div><div class="slate-code_line">      }</div></code></pre></div><p class="slate-p " ></p><div style="width:100%;
	min-width:100%;" data-type=warning ><div ><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%;" data-type=error ><div ><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>

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.

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

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 

<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