{"id":402882,"date":"2023-09-27T13:57:04","date_gmt":"2023-09-27T13:57:04","guid":{"rendered":"https:\/\/webkul.com\/blog\/?p=402882"},"modified":"2025-05-09T12:14:33","modified_gmt":"2025-05-09T12:14:33","slug":"user-manual-of-odoo-rest-api","status":"publish","type":"post","link":"https:\/\/webkul.com\/blog\/user-manual-of-odoo-rest-api\/","title":{"rendered":"User Manual of Odoo REST API"},"content":{"rendered":"\n<h2 class=\"wp-block-heading\">Introduction<\/h2>\n\n\n\n<p><a href=\"https:\/\/store.webkul.com\/Odoo-REST-API.html\" target=\"_blank\" rel=\"noreferrer noopener\">Odoo REST API<\/a> offers secure access to application resources through user authentication tokens. These tokens can be generated using Base64-encoded credentials in tools like Postman.&nbsp;<\/p>\n\n\n\n<p>Odoo REST API allows you to define specific access rights and privileges for each user or API key. Responses can be formatted in either JSON or XML, based on user preference. <\/p>\n\n\n\n<p>Additionally, users can retrieve database table schemas through this API.<\/p>\n\n\n\n<h2 class=\"wp-block-heading\">Features<\/h2>\n\n\n\n<ol class=\"wp-block-list\">\n<li>Protect your API using secure tokens, verifying user identity before allowing access.<\/li>\n\n\n\n<li>User can set the API validity and Throttling limit for an API. <br><\/li>\n\n\n\n<li>Easily create authentication tokens from the user\u2019s profile without extra setup.<br><\/li>\n\n\n\n<li>&nbsp;Test your API endpoints directly in the browser using Open API tools for quick validation.<br><\/li>\n\n\n\n<li>Create API keys with defined rules and limits to control what data or actions are allowed.<br><\/li>\n\n\n\n<li>&nbsp;Perform all key operations like retrieving, creating, updating, or deleting data using standard HTTP methods.<br><\/li>\n\n\n\n<li>&nbsp;Select your preferred output format for API responses \u2014 either JSON or XML \u2014 for smooth integration.<br><\/li>\n\n\n\n<li>&nbsp;Use the API to check and access your database\u2019s table structure when needed.<br><\/li>\n\n\n\n<li>&nbsp;Secure your login and token process by encoding credentials in Base64 format.<br><\/li>\n\n\n\n<li>One API key can be used safely across different users while still maintaining security.<br><\/li>\n\n\n\n<li>&nbsp;Receive clear messages about permission issues or access limits directly in the API response.<\/li>\n<\/ol>\n\n\n\n<h2 class=\"wp-block-heading\"><strong>I<\/strong>nstallation<\/h2>\n\n\n\n<p>1. Once you purchase the App from <strong>Webkul store<\/strong>, you will receive the link to download the zip file of the module.<\/p>\n\n\n\n<p> 2. Extract the file on your system after the download finishes. You will be able to see a folder named- <strong>\u2018odoo_REST.\u2019<\/strong><\/p>\n\n\n\n<p>3. Copy and paste this folder inside your Odoo Add-Ons path.<\/p>\n\n\n\n<p>4. Now, open Odoo App and click on the Settings menu. Here, click on Activate <strong>Developer Mode.<\/strong><\/p>\n\n\n\n<p>5. Then, open the Apps menu and click on <strong>\u2018Update Modules List.\u2019<\/strong><\/p>\n\n\n\n<p>6. In the search bar, remove all the filters and search <strong>\u2018odoo_REST.\u2019<\/strong><\/p>\n\n\n\n<p>7. You will be able to see the module in the search results. Click on <strong>\u2018Install\u2019 to install it<\/strong><\/p>\n\n\n\n<h2 class=\"wp-block-heading\">Workflow<\/h2>\n\n\n\n<p>Under <strong>Settings<\/strong> &gt;&gt; <strong>Technical menu &gt;&gt; Web Service Account<\/strong> <\/p>\n\n\n\n<p>1. Now, generate an API Secret Key and enable <strong>User Authentication. <\/strong>&nbsp;Also, select <strong>\u2018Available for\u2019 <\/strong>option<strong>. <\/strong>By enabling <strong>Advanced Feature,<\/strong> users can set <strong>APIs Validity <\/strong>and <strong>Throatling Limits<\/strong>. <\/p>\n\n\n\n<p>Next, generate an API Secret Key, along with enabling &#8216;User Authentication&#8217;. Also, select the \u2018Available for\u2019 option.<\/p>\n\n\n\n<figure class=\"wp-block-image size-full\"><img decoding=\"async\" width=\"1114\" height=\"463\" src=\"https:\/\/cdnblog.webkul.com\/blog\/wp-content\/uploads\/2023\/09\/generate-api-key.webp\" alt=\"Generate API keys\" class=\"wp-image-491632\" srcset=\"https:\/\/cdnblog.webkul.com\/blog\/wp-content\/uploads\/2023\/09\/generate-api-key.webp 1114w, https:\/\/cdnblog.webkul.com\/blog\/wp-content\/uploads\/2023\/09\/generate-api-key-300x125.webp 300w, https:\/\/cdnblog.webkul.com\/blog\/wp-content\/uploads\/2023\/09\/generate-api-key-250x104.webp 250w, https:\/\/cdnblog.webkul.com\/blog\/wp-content\/uploads\/2023\/09\/generate-api-key-768x319.webp 768w\" sizes=\"(max-width: 1114px) 100vw, 1114px\" loading=\"lazy\" \/><\/figure>\n\n\n\n<ol class=\"wp-block-list\">\n<li><\/li>\n<\/ol>\n\n\n\n<p>2. Select <strong>\u2018users\u2019<\/strong> under <strong>\u2018Users &amp; Companies.\u2019<\/strong> &gt;&gt; &nbsp;Choose <strong>\u2018API Key\u2019<\/strong> and click <strong>\u2018Generate Token\u2019<\/strong> button to create a token for that specific API within <strong>User Authentication\u2019 <\/strong>tab.<\/p>\n\n\n\n<figure class=\"wp-block-image size-large\"><img decoding=\"async\" width=\"1200\" height=\"638\" src=\"https:\/\/cdnblog.webkul.com\/blog\/wp-content\/uploads\/2023\/09\/generate-user-authentication-token-1200x638.webp\" alt=\"Generate token  with user authentications\" class=\"wp-image-491638\" srcset=\"https:\/\/cdnblog.webkul.com\/blog\/wp-content\/uploads\/2023\/09\/generate-user-authentication-token-1200x638.webp 1200w, https:\/\/cdnblog.webkul.com\/blog\/wp-content\/uploads\/2023\/09\/generate-user-authentication-token-300x160.webp 300w, https:\/\/cdnblog.webkul.com\/blog\/wp-content\/uploads\/2023\/09\/generate-user-authentication-token-250x133.webp 250w, https:\/\/cdnblog.webkul.com\/blog\/wp-content\/uploads\/2023\/09\/generate-user-authentication-token-768x408.webp 768w, https:\/\/cdnblog.webkul.com\/blog\/wp-content\/uploads\/2023\/09\/generate-user-authentication-token-1536x817.webp 1536w, https:\/\/cdnblog.webkul.com\/blog\/wp-content\/uploads\/2023\/09\/generate-user-authentication-token-2048x1089.webp 2048w\" sizes=\"(max-width: 1200px) 100vw, 1200px\" loading=\"lazy\" \/><\/figure>\n\n\n\n<p>3. After that, move back to <strong>API key <\/strong>&nbsp;&gt;&gt; <strong>User<\/strong> icon\/option. This will open a list of users, and their user authentication token will be shown next to their <strong>User ID<\/strong>.<\/p>\n\n\n\n<figure class=\"wp-block-image size-large\"><img decoding=\"async\" width=\"1200\" height=\"943\" src=\"https:\/\/cdnblog.webkul.com\/blog\/wp-content\/uploads\/2023\/09\/api-keys-user-tokens-3-1200x943.webp\" alt=\"Manage API tokens\" class=\"wp-image-491661\" srcset=\"https:\/\/cdnblog.webkul.com\/blog\/wp-content\/uploads\/2023\/09\/api-keys-user-tokens-3-1200x943.webp 1200w, https:\/\/cdnblog.webkul.com\/blog\/wp-content\/uploads\/2023\/09\/api-keys-user-tokens-3-300x236.webp 300w, https:\/\/cdnblog.webkul.com\/blog\/wp-content\/uploads\/2023\/09\/api-keys-user-tokens-3-250x196.webp 250w, https:\/\/cdnblog.webkul.com\/blog\/wp-content\/uploads\/2023\/09\/api-keys-user-tokens-3-768x603.webp 768w, https:\/\/cdnblog.webkul.com\/blog\/wp-content\/uploads\/2023\/09\/api-keys-user-tokens-3-1536x1207.webp 1536w, https:\/\/cdnblog.webkul.com\/blog\/wp-content\/uploads\/2023\/09\/api-keys-user-tokens-3-2048x1609.webp 2048w\" sizes=\"(max-width: 1200px) 100vw, 1200px\" loading=\"lazy\" \/><\/figure>\n\n\n\n<p>5. You can also configure the API key for specific access. Choose the <strong>\u2018Specific Resources\u2019<\/strong> option in the \u2018Available for\u2019 option, and configure them.<\/p>\n\n\n\n<p>You can also perform User Authentication from <strong>Open API.<\/strong> <\/p>\n\n\n\n<p>All you do is encode the login credentials from Base64 in the given format and follow the screenshot instructions. &nbsp; <strong>{\u2018login\u2019:\u2019admin\u2019,\u2019 password\u2019:\u2019admin\u2019}.<\/strong><\/p>\n\n\n\n<figure class=\"wp-block-image size-full\"><img decoding=\"async\" width=\"1120\" height=\"880\" src=\"https:\/\/cdnblog.webkul.com\/blog\/wp-content\/uploads\/2023\/09\/ecode-credentials.webp\" alt=\"Encode your credentials\" class=\"wp-image-491665\" srcset=\"https:\/\/cdnblog.webkul.com\/blog\/wp-content\/uploads\/2023\/09\/ecode-credentials.webp 1120w, https:\/\/cdnblog.webkul.com\/blog\/wp-content\/uploads\/2023\/09\/ecode-credentials-300x236.webp 300w, https:\/\/cdnblog.webkul.com\/blog\/wp-content\/uploads\/2023\/09\/ecode-credentials-250x196.webp 250w, https:\/\/cdnblog.webkul.com\/blog\/wp-content\/uploads\/2023\/09\/ecode-credentials-768x603.webp 768w\" sizes=\"(max-width: 1120px) 100vw, 1120px\" loading=\"lazy\" \/><\/figure>\n\n\n\n<p>6. The user can also access REST API Documents <strong>Settings&gt;&gt; Technical&gt;&gt; REST API Documents<\/strong><\/p>\n\n\n\n<figure class=\"wp-block-image size-large\"><img decoding=\"async\" width=\"1200\" height=\"943\" src=\"https:\/\/cdnblog.webkul.com\/blog\/wp-content\/uploads\/2023\/09\/access-api-doc-1200x943.webp\" alt=\"Access OPEN API doc\" class=\"wp-image-491668\" srcset=\"https:\/\/cdnblog.webkul.com\/blog\/wp-content\/uploads\/2023\/09\/access-api-doc-1200x943.webp 1200w, https:\/\/cdnblog.webkul.com\/blog\/wp-content\/uploads\/2023\/09\/access-api-doc-300x236.webp 300w, https:\/\/cdnblog.webkul.com\/blog\/wp-content\/uploads\/2023\/09\/access-api-doc-250x196.webp 250w, https:\/\/cdnblog.webkul.com\/blog\/wp-content\/uploads\/2023\/09\/access-api-doc-768x603.webp 768w, https:\/\/cdnblog.webkul.com\/blog\/wp-content\/uploads\/2023\/09\/access-api-doc-1536x1207.webp 1536w, https:\/\/cdnblog.webkul.com\/blog\/wp-content\/uploads\/2023\/09\/access-api-doc-2048x1609.webp 2048w\" sizes=\"(max-width: 1200px) 100vw, 1200px\" loading=\"lazy\" \/><\/figure>\n\n\n\n<p>7. Generate a token with OPEN API<\/p>\n\n\n\n<p>Go to <strong>Technical<\/strong> &gt;&gt; <strong>REST API Documents<\/strong><\/p>\n\n\n\n<figure class=\"wp-block-image size-large\"><img decoding=\"async\" width=\"1200\" height=\"943\" src=\"https:\/\/cdnblog.webkul.com\/blog\/wp-content\/uploads\/2023\/09\/add-credentials-1200x943.webp\" alt=\"Generate a token with OPEN API\n\" class=\"wp-image-491672\" srcset=\"https:\/\/cdnblog.webkul.com\/blog\/wp-content\/uploads\/2023\/09\/add-credentials-1200x943.webp 1200w, https:\/\/cdnblog.webkul.com\/blog\/wp-content\/uploads\/2023\/09\/add-credentials-300x236.webp 300w, https:\/\/cdnblog.webkul.com\/blog\/wp-content\/uploads\/2023\/09\/add-credentials-250x196.webp 250w, https:\/\/cdnblog.webkul.com\/blog\/wp-content\/uploads\/2023\/09\/add-credentials-768x603.webp 768w, https:\/\/cdnblog.webkul.com\/blog\/wp-content\/uploads\/2023\/09\/add-credentials-1536x1207.webp 1536w, https:\/\/cdnblog.webkul.com\/blog\/wp-content\/uploads\/2023\/09\/add-credentials-2048x1609.webp 2048w\" sizes=\"(max-width: 1200px) 100vw, 1200px\" loading=\"lazy\" \/><\/figure>\n\n\n\n<p>8. Then navigate to <strong>Open API<\/strong> &gt;&gt; <strong>\/api\/generate_token<\/strong>\u2019<\/p>\n\n\n\n<p>Click on <strong>Tryout<\/strong>, and enter your <strong>API Key<\/strong> and <strong>Token<\/strong> for authentication<\/p>\n\n\n\n<figure class=\"wp-block-image size-large\"><img decoding=\"async\" width=\"1200\" height=\"943\" src=\"https:\/\/cdnblog.webkul.com\/blog\/wp-content\/uploads\/2023\/09\/generate-token-with-open-api-1200x943.webp\" alt=\"Enter API key and token\" class=\"wp-image-491676\" srcset=\"https:\/\/cdnblog.webkul.com\/blog\/wp-content\/uploads\/2023\/09\/generate-token-with-open-api-1200x943.webp 1200w, https:\/\/cdnblog.webkul.com\/blog\/wp-content\/uploads\/2023\/09\/generate-token-with-open-api-300x236.webp 300w, https:\/\/cdnblog.webkul.com\/blog\/wp-content\/uploads\/2023\/09\/generate-token-with-open-api-250x196.webp 250w, https:\/\/cdnblog.webkul.com\/blog\/wp-content\/uploads\/2023\/09\/generate-token-with-open-api-768x603.webp 768w, https:\/\/cdnblog.webkul.com\/blog\/wp-content\/uploads\/2023\/09\/generate-token-with-open-api-1536x1207.webp 1536w, https:\/\/cdnblog.webkul.com\/blog\/wp-content\/uploads\/2023\/09\/generate-token-with-open-api-2048x1609.webp 2048w\" sizes=\"(max-width: 1200px) 100vw, 1200px\" loading=\"lazy\" \/><\/figure>\n\n\n\n<p>9. Token Generated Successfully.<\/p>\n\n\n\n<figure class=\"wp-block-image size-large\"><img decoding=\"async\" width=\"1200\" height=\"943\" src=\"https:\/\/cdnblog.webkul.com\/blog\/wp-content\/uploads\/2023\/09\/token-generated-1200x943.webp\" alt=\"Token generated \n\" class=\"wp-image-491684\" srcset=\"https:\/\/cdnblog.webkul.com\/blog\/wp-content\/uploads\/2023\/09\/token-generated-1200x943.webp 1200w, https:\/\/cdnblog.webkul.com\/blog\/wp-content\/uploads\/2023\/09\/token-generated-300x236.webp 300w, https:\/\/cdnblog.webkul.com\/blog\/wp-content\/uploads\/2023\/09\/token-generated-250x196.webp 250w, https:\/\/cdnblog.webkul.com\/blog\/wp-content\/uploads\/2023\/09\/token-generated-768x603.webp 768w, https:\/\/cdnblog.webkul.com\/blog\/wp-content\/uploads\/2023\/09\/token-generated-1536x1207.webp 1536w, https:\/\/cdnblog.webkul.com\/blog\/wp-content\/uploads\/2023\/09\/token-generated-2048x1609.webp 2048w\" sizes=\"(max-width: 1200px) 100vw, 1200px\" loading=\"lazy\" \/><\/figure>\n\n\n\n<h2 class=\"wp-block-heading\">Need Help?<\/h2>\n\n\n\n<p>We hope this guide has been helpful. Share your feedback in the comments section below.<\/p>\n\n\n\n<p>For any issues or further inquiries, please raise a ticket on <a href=\"https:\/\/webkul.uvdesk.com\/en\/customer\/create-ticket\/\" target=\"_blank\" rel=\"noreferrer noopener\">UV Desk<\/a><strong> <\/strong>or contact our <a href=\"mailto:support@webkul.com\" target=\"_blank\" rel=\"noreferrer noopener\">support team<\/a> via email.<\/p>\n\n\n\n<p>Thank you for choosing us, and we\u2019re here to assist you further!<\/p>\n","protected":false},"excerpt":{"rendered":"<p>Introduction Odoo REST API offers secure access to application resources through user authentication tokens. These tokens can be generated using Base64-encoded credentials in tools like Postman.&nbsp; Odoo REST API allows you to define specific access rights and privileges for each user or API key. Responses can be formatted in either JSON or XML, based on <a href=\"https:\/\/webkul.com\/blog\/user-manual-of-odoo-rest-api\/\">[&#8230;]<\/a><\/p>\n","protected":false},"author":563,"featured_media":0,"comment_status":"open","ping_status":"open","sticky":false,"template":"","format":"standard","meta":{"footnotes":""},"categories":[2007],"tags":[1267,13385,14740,13605,15120,14425,15124,15123,15119,2253,14857,15122,15126],"class_list":["post-402882","post","type-post","status-publish","format-standard","hentry","category-odoo","tag-odoo","tag-odoo-admin","tag-odoo-api","tag-odoo-app","tag-odoo-rest","tag-odoo-rest-api","tag-odoo-rest-api-blog","tag-odoo-rest-api-user-guide","tag-odoo-rest-pi","tag-rest-api","tag-restful-api","tag-user-guide-for-odoo-rest-api","tag-webkul-odoo-blog"],"yoast_head":"<!-- This site is optimized with the Yoast SEO plugin v24.5 - https:\/\/yoast.com\/wordpress\/plugins\/seo\/ -->\n<title>User Guide for Odoo REST API<\/title>\n<meta name=\"description\" content=\"Odoo REST API provides secure, token-based access with customizable permissions and Open API support for easy integration and testing.\" \/>\n<meta name=\"robots\" content=\"index, follow, max-snippet:-1, max-image-preview:large, max-video-preview:-1\" \/>\n<link rel=\"canonical\" href=\"https:\/\/webkul.com\/blog\/user-manual-of-odoo-rest-api\/\" \/>\n<meta property=\"og:locale\" content=\"en_US\" \/>\n<meta property=\"og:type\" content=\"article\" \/>\n<meta property=\"og:title\" content=\"User Guide for Odoo REST API\" \/>\n<meta property=\"og:description\" content=\"Odoo REST API provides secure, token-based access with customizable permissions and Open API support for easy integration and testing.\" \/>\n<meta property=\"og:url\" content=\"https:\/\/webkul.com\/blog\/user-manual-of-odoo-rest-api\/\" \/>\n<meta property=\"og:site_name\" content=\"Webkul Blog\" \/>\n<meta property=\"article:publisher\" content=\"https:\/\/www.facebook.com\/webkul\/\" \/>\n<meta property=\"article:published_time\" content=\"2023-09-27T13:57:04+00:00\" \/>\n<meta property=\"article:modified_time\" content=\"2025-05-09T12:14:33+00:00\" \/>\n<meta property=\"og:image\" content=\"https:\/\/webkul.com\/blog\/wp-content\/uploads\/2023\/09\/generate-api-key.webp\" \/>\n<meta name=\"author\" content=\"Sakshi\" \/>\n<meta name=\"twitter:card\" content=\"summary_large_image\" \/>\n<meta name=\"twitter:creator\" content=\"@webkul\" \/>\n<meta name=\"twitter:site\" content=\"@webkul\" \/>\n<meta name=\"twitter:label1\" content=\"Written by\" \/>\n\t<meta name=\"twitter:data1\" content=\"Sakshi\" \/>\n\t<meta name=\"twitter:label2\" content=\"Est. reading time\" \/>\n\t<meta name=\"twitter:data2\" content=\"5 minutes\" \/>\n<script type=\"application\/ld+json\" class=\"yoast-schema-graph\">{\"@context\":\"https:\/\/schema.org\",\"@graph\":[{\"@type\":\"Article\",\"@id\":\"https:\/\/webkul.com\/blog\/user-manual-of-odoo-rest-api\/#article\",\"isPartOf\":{\"@id\":\"https:\/\/webkul.com\/blog\/user-manual-of-odoo-rest-api\/\"},\"author\":{\"name\":\"Sakshi\",\"@id\":\"https:\/\/webkul.com\/blog\/#\/schema\/person\/afc52cecc60c3fbe66dee9da55ec8c7d\"},\"headline\":\"User Manual of Odoo REST API\",\"datePublished\":\"2023-09-27T13:57:04+00:00\",\"dateModified\":\"2025-05-09T12:14:33+00:00\",\"mainEntityOfPage\":{\"@id\":\"https:\/\/webkul.com\/blog\/user-manual-of-odoo-rest-api\/\"},\"wordCount\":624,\"commentCount\":2,\"publisher\":{\"@id\":\"https:\/\/webkul.com\/blog\/#organization\"},\"image\":{\"@id\":\"https:\/\/webkul.com\/blog\/user-manual-of-odoo-rest-api\/#primaryimage\"},\"thumbnailUrl\":\"https:\/\/webkul.com\/blog\/wp-content\/uploads\/2023\/09\/generate-api-key.webp\",\"keywords\":[\"odoo\",\"odoo admin\",\"odoo api\",\"odoo app\",\"odoo rest\",\"odoo rest api\",\"odoo rest api blog\",\"odoo rest api user guide\",\"odoo rest pi\",\"REST API\",\"RESTful API\",\"user guide for odoo rest api\",\"webkul odoo blog\"],\"articleSection\":[\"Odoo\"],\"inLanguage\":\"en-US\",\"potentialAction\":[{\"@type\":\"CommentAction\",\"name\":\"Comment\",\"target\":[\"https:\/\/webkul.com\/blog\/user-manual-of-odoo-rest-api\/#respond\"]}]},{\"@type\":\"WebPage\",\"@id\":\"https:\/\/webkul.com\/blog\/user-manual-of-odoo-rest-api\/\",\"url\":\"https:\/\/webkul.com\/blog\/user-manual-of-odoo-rest-api\/\",\"name\":\"User Guide for Odoo REST API\",\"isPartOf\":{\"@id\":\"https:\/\/webkul.com\/blog\/#website\"},\"primaryImageOfPage\":{\"@id\":\"https:\/\/webkul.com\/blog\/user-manual-of-odoo-rest-api\/#primaryimage\"},\"image\":{\"@id\":\"https:\/\/webkul.com\/blog\/user-manual-of-odoo-rest-api\/#primaryimage\"},\"thumbnailUrl\":\"https:\/\/webkul.com\/blog\/wp-content\/uploads\/2023\/09\/generate-api-key.webp\",\"datePublished\":\"2023-09-27T13:57:04+00:00\",\"dateModified\":\"2025-05-09T12:14:33+00:00\",\"description\":\"Odoo REST API provides secure, token-based access with customizable permissions and Open API support for easy integration and testing.\",\"breadcrumb\":{\"@id\":\"https:\/\/webkul.com\/blog\/user-manual-of-odoo-rest-api\/#breadcrumb\"},\"inLanguage\":\"en-US\",\"potentialAction\":[{\"@type\":\"ReadAction\",\"target\":[\"https:\/\/webkul.com\/blog\/user-manual-of-odoo-rest-api\/\"]}]},{\"@type\":\"ImageObject\",\"inLanguage\":\"en-US\",\"@id\":\"https:\/\/webkul.com\/blog\/user-manual-of-odoo-rest-api\/#primaryimage\",\"url\":\"https:\/\/cdnblog.webkul.com\/blog\/wp-content\/uploads\/2023\/09\/generate-api-key.webp\",\"contentUrl\":\"https:\/\/cdnblog.webkul.com\/blog\/wp-content\/uploads\/2023\/09\/generate-api-key.webp\",\"width\":1114,\"height\":463},{\"@type\":\"BreadcrumbList\",\"@id\":\"https:\/\/webkul.com\/blog\/user-manual-of-odoo-rest-api\/#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Home\",\"item\":\"https:\/\/webkul.com\/blog\/\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"User Manual of Odoo REST API\"}]},{\"@type\":\"WebSite\",\"@id\":\"https:\/\/webkul.com\/blog\/#website\",\"url\":\"https:\/\/webkul.com\/blog\/\",\"name\":\"Webkul Blog\",\"description\":\"\",\"publisher\":{\"@id\":\"https:\/\/webkul.com\/blog\/#organization\"},\"potentialAction\":[{\"@type\":\"SearchAction\",\"target\":{\"@type\":\"EntryPoint\",\"urlTemplate\":\"https:\/\/webkul.com\/blog\/?s={search_term_string}\"},\"query-input\":{\"@type\":\"PropertyValueSpecification\",\"valueRequired\":true,\"valueName\":\"search_term_string\"}}],\"inLanguage\":\"en-US\"},{\"@type\":\"Organization\",\"@id\":\"https:\/\/webkul.com\/blog\/#organization\",\"name\":\"WebKul Software Private Limited\",\"url\":\"https:\/\/webkul.com\/blog\/\",\"logo\":{\"@type\":\"ImageObject\",\"inLanguage\":\"en-US\",\"@id\":\"https:\/\/webkul.com\/blog\/#\/schema\/logo\/image\/\",\"url\":\"https:\/\/cdnblog.webkul.com\/blog\/wp-content\/uploads\/2021\/08\/webkul-logo-accent-sq.png\",\"contentUrl\":\"https:\/\/cdnblog.webkul.com\/blog\/wp-content\/uploads\/2021\/08\/webkul-logo-accent-sq.png\",\"width\":380,\"height\":380,\"caption\":\"WebKul Software Private Limited\"},\"image\":{\"@id\":\"https:\/\/webkul.com\/blog\/#\/schema\/logo\/image\/\"},\"sameAs\":[\"https:\/\/www.facebook.com\/webkul\/\",\"https:\/\/x.com\/webkul\",\"https:\/\/www.instagram.com\/webkul\/\",\"https:\/\/www.linkedin.com\/company\/webkul\",\"https:\/\/www.youtube.com\/user\/webkul\/\"]},{\"@type\":\"Person\",\"@id\":\"https:\/\/webkul.com\/blog\/#\/schema\/person\/afc52cecc60c3fbe66dee9da55ec8c7d\",\"name\":\"Sakshi\",\"image\":{\"@type\":\"ImageObject\",\"inLanguage\":\"en-US\",\"@id\":\"https:\/\/webkul.com\/blog\/#\/schema\/person\/image\/\",\"url\":\"https:\/\/secure.gravatar.com\/avatar\/205eeb94fc0fe2c477dcc386238bf430795ec603ccb175c09171f74dc6738415?s=96&d=https%3A%2F%2Fcdnblog.webkul.com%2Fblog%2Fwp-content%2Fuploads%2F2019%2F10%2Feva.png&r=g\",\"contentUrl\":\"https:\/\/secure.gravatar.com\/avatar\/205eeb94fc0fe2c477dcc386238bf430795ec603ccb175c09171f74dc6738415?s=96&d=https%3A%2F%2Fcdnblog.webkul.com%2Fblog%2Fwp-content%2Fuploads%2F2019%2F10%2Feva.png&r=g\",\"caption\":\"Sakshi\"},\"description\":\"Sakshi is a proficient Odoo Business Analyst specializing in multichannel integration, connector platforms, and business intelligence tool integration with Odoo. She excels in optimizing business processes, ensuring seamless system integration, and enhancing data-driven decision-making, driving operational efficiency and strategic growth for businesses.\",\"url\":\"https:\/\/webkul.com\/blog\/author\/sakshi-int820\/\"}]}<\/script>\n<!-- \/ Yoast SEO plugin. -->","yoast_head_json":{"title":"User Guide for Odoo REST API","description":"Odoo REST API provides secure, token-based access with customizable permissions and Open API support for easy integration and testing.","robots":{"index":"index","follow":"follow","max-snippet":"max-snippet:-1","max-image-preview":"max-image-preview:large","max-video-preview":"max-video-preview:-1"},"canonical":"https:\/\/webkul.com\/blog\/user-manual-of-odoo-rest-api\/","og_locale":"en_US","og_type":"article","og_title":"User Guide for Odoo REST API","og_description":"Odoo REST API provides secure, token-based access with customizable permissions and Open API support for easy integration and testing.","og_url":"https:\/\/webkul.com\/blog\/user-manual-of-odoo-rest-api\/","og_site_name":"Webkul Blog","article_publisher":"https:\/\/www.facebook.com\/webkul\/","article_published_time":"2023-09-27T13:57:04+00:00","article_modified_time":"2025-05-09T12:14:33+00:00","og_image":[{"url":"https:\/\/webkul.com\/blog\/wp-content\/uploads\/2023\/09\/generate-api-key.webp","type":"","width":"","height":""}],"author":"Sakshi","twitter_card":"summary_large_image","twitter_creator":"@webkul","twitter_site":"@webkul","twitter_misc":{"Written by":"Sakshi","Est. reading time":"5 minutes"},"schema":{"@context":"https:\/\/schema.org","@graph":[{"@type":"Article","@id":"https:\/\/webkul.com\/blog\/user-manual-of-odoo-rest-api\/#article","isPartOf":{"@id":"https:\/\/webkul.com\/blog\/user-manual-of-odoo-rest-api\/"},"author":{"name":"Sakshi","@id":"https:\/\/webkul.com\/blog\/#\/schema\/person\/afc52cecc60c3fbe66dee9da55ec8c7d"},"headline":"User Manual of Odoo REST API","datePublished":"2023-09-27T13:57:04+00:00","dateModified":"2025-05-09T12:14:33+00:00","mainEntityOfPage":{"@id":"https:\/\/webkul.com\/blog\/user-manual-of-odoo-rest-api\/"},"wordCount":624,"commentCount":2,"publisher":{"@id":"https:\/\/webkul.com\/blog\/#organization"},"image":{"@id":"https:\/\/webkul.com\/blog\/user-manual-of-odoo-rest-api\/#primaryimage"},"thumbnailUrl":"https:\/\/webkul.com\/blog\/wp-content\/uploads\/2023\/09\/generate-api-key.webp","keywords":["odoo","odoo admin","odoo api","odoo app","odoo rest","odoo rest api","odoo rest api blog","odoo rest api user guide","odoo rest pi","REST API","RESTful API","user guide for odoo rest api","webkul odoo blog"],"articleSection":["Odoo"],"inLanguage":"en-US","potentialAction":[{"@type":"CommentAction","name":"Comment","target":["https:\/\/webkul.com\/blog\/user-manual-of-odoo-rest-api\/#respond"]}]},{"@type":"WebPage","@id":"https:\/\/webkul.com\/blog\/user-manual-of-odoo-rest-api\/","url":"https:\/\/webkul.com\/blog\/user-manual-of-odoo-rest-api\/","name":"User Guide for Odoo REST API","isPartOf":{"@id":"https:\/\/webkul.com\/blog\/#website"},"primaryImageOfPage":{"@id":"https:\/\/webkul.com\/blog\/user-manual-of-odoo-rest-api\/#primaryimage"},"image":{"@id":"https:\/\/webkul.com\/blog\/user-manual-of-odoo-rest-api\/#primaryimage"},"thumbnailUrl":"https:\/\/webkul.com\/blog\/wp-content\/uploads\/2023\/09\/generate-api-key.webp","datePublished":"2023-09-27T13:57:04+00:00","dateModified":"2025-05-09T12:14:33+00:00","description":"Odoo REST API provides secure, token-based access with customizable permissions and Open API support for easy integration and testing.","breadcrumb":{"@id":"https:\/\/webkul.com\/blog\/user-manual-of-odoo-rest-api\/#breadcrumb"},"inLanguage":"en-US","potentialAction":[{"@type":"ReadAction","target":["https:\/\/webkul.com\/blog\/user-manual-of-odoo-rest-api\/"]}]},{"@type":"ImageObject","inLanguage":"en-US","@id":"https:\/\/webkul.com\/blog\/user-manual-of-odoo-rest-api\/#primaryimage","url":"https:\/\/cdnblog.webkul.com\/blog\/wp-content\/uploads\/2023\/09\/generate-api-key.webp","contentUrl":"https:\/\/cdnblog.webkul.com\/blog\/wp-content\/uploads\/2023\/09\/generate-api-key.webp","width":1114,"height":463},{"@type":"BreadcrumbList","@id":"https:\/\/webkul.com\/blog\/user-manual-of-odoo-rest-api\/#breadcrumb","itemListElement":[{"@type":"ListItem","position":1,"name":"Home","item":"https:\/\/webkul.com\/blog\/"},{"@type":"ListItem","position":2,"name":"User Manual of Odoo REST API"}]},{"@type":"WebSite","@id":"https:\/\/webkul.com\/blog\/#website","url":"https:\/\/webkul.com\/blog\/","name":"Webkul Blog","description":"","publisher":{"@id":"https:\/\/webkul.com\/blog\/#organization"},"potentialAction":[{"@type":"SearchAction","target":{"@type":"EntryPoint","urlTemplate":"https:\/\/webkul.com\/blog\/?s={search_term_string}"},"query-input":{"@type":"PropertyValueSpecification","valueRequired":true,"valueName":"search_term_string"}}],"inLanguage":"en-US"},{"@type":"Organization","@id":"https:\/\/webkul.com\/blog\/#organization","name":"WebKul Software Private Limited","url":"https:\/\/webkul.com\/blog\/","logo":{"@type":"ImageObject","inLanguage":"en-US","@id":"https:\/\/webkul.com\/blog\/#\/schema\/logo\/image\/","url":"https:\/\/cdnblog.webkul.com\/blog\/wp-content\/uploads\/2021\/08\/webkul-logo-accent-sq.png","contentUrl":"https:\/\/cdnblog.webkul.com\/blog\/wp-content\/uploads\/2021\/08\/webkul-logo-accent-sq.png","width":380,"height":380,"caption":"WebKul Software Private Limited"},"image":{"@id":"https:\/\/webkul.com\/blog\/#\/schema\/logo\/image\/"},"sameAs":["https:\/\/www.facebook.com\/webkul\/","https:\/\/x.com\/webkul","https:\/\/www.instagram.com\/webkul\/","https:\/\/www.linkedin.com\/company\/webkul","https:\/\/www.youtube.com\/user\/webkul\/"]},{"@type":"Person","@id":"https:\/\/webkul.com\/blog\/#\/schema\/person\/afc52cecc60c3fbe66dee9da55ec8c7d","name":"Sakshi","image":{"@type":"ImageObject","inLanguage":"en-US","@id":"https:\/\/webkul.com\/blog\/#\/schema\/person\/image\/","url":"https:\/\/secure.gravatar.com\/avatar\/205eeb94fc0fe2c477dcc386238bf430795ec603ccb175c09171f74dc6738415?s=96&d=https%3A%2F%2Fcdnblog.webkul.com%2Fblog%2Fwp-content%2Fuploads%2F2019%2F10%2Feva.png&r=g","contentUrl":"https:\/\/secure.gravatar.com\/avatar\/205eeb94fc0fe2c477dcc386238bf430795ec603ccb175c09171f74dc6738415?s=96&d=https%3A%2F%2Fcdnblog.webkul.com%2Fblog%2Fwp-content%2Fuploads%2F2019%2F10%2Feva.png&r=g","caption":"Sakshi"},"description":"Sakshi is a proficient Odoo Business Analyst specializing in multichannel integration, connector platforms, and business intelligence tool integration with Odoo. She excels in optimizing business processes, ensuring seamless system integration, and enhancing data-driven decision-making, driving operational efficiency and strategic growth for businesses.","url":"https:\/\/webkul.com\/blog\/author\/sakshi-int820\/"}]}},"amp_enabled":true,"_links":{"self":[{"href":"https:\/\/webkul.com\/blog\/wp-json\/wp\/v2\/posts\/402882","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/webkul.com\/blog\/wp-json\/wp\/v2\/posts"}],"about":[{"href":"https:\/\/webkul.com\/blog\/wp-json\/wp\/v2\/types\/post"}],"author":[{"embeddable":true,"href":"https:\/\/webkul.com\/blog\/wp-json\/wp\/v2\/users\/563"}],"replies":[{"embeddable":true,"href":"https:\/\/webkul.com\/blog\/wp-json\/wp\/v2\/comments?post=402882"}],"version-history":[{"count":8,"href":"https:\/\/webkul.com\/blog\/wp-json\/wp\/v2\/posts\/402882\/revisions"}],"predecessor-version":[{"id":491733,"href":"https:\/\/webkul.com\/blog\/wp-json\/wp\/v2\/posts\/402882\/revisions\/491733"}],"wp:attachment":[{"href":"https:\/\/webkul.com\/blog\/wp-json\/wp\/v2\/media?parent=402882"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/webkul.com\/blog\/wp-json\/wp\/v2\/categories?post=402882"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/webkul.com\/blog\/wp-json\/wp\/v2\/tags?post=402882"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}