{"templateId":"markdown","sharedDataIds":{"sidebar":"sidebar-api/sidebars.yaml"},"props":{"metadata":{"markdoc":{"tagList":[]},"type":"markdown"},"seo":{"title":"API","description":"Developer documentation for the WHMCS API — the","llmstxt":{"hide":false,"sections":[{"title":"Table of contents","includeFiles":["**/*"],"excludeFiles":[]}],"excludeFiles":[]}},"dynamicMarkdocComponents":[],"compilationErrors":[],"ast":{"$$mdtype":"Tag","name":"article","attributes":{},"children":[{"$$mdtype":"Tag","name":"Heading","attributes":{"level":1,"id":"api","__idx":0},"children":["API"]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"introduction","__idx":1},"children":["Introduction"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The WHMCS API allows you to perform operations and actions within WHMCS from external third party and custom code."]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/api/getting-started/"},"children":["Getting Started"]}]},{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]},"Learn about how to get started with the API"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/api/authentication/"},"children":["Authentication"]}]},{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]},"Learn how authentication works for the WHMCS API"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/api/access-control/"},"children":["Access Control"]}]},{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]},"Learn how IP and Access Key control works for the WHMCS API"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/api/response-types/"},"children":["Response Types"]}]},{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]},"Learn about the different response types"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/api/sample-code/"},"children":["Sample Code"]}]},{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]},"See sample code for remotely connecting to the WHMCS API"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/api/internal-api/"},"children":["Internal API"]}]},{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]},"See sample code for using the Local WHMCS API"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/api/api-index/"},"children":["API Index"]}]},{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]},"A complete listing of all available API commands"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/api-reference/"},"children":["API Reference"]}]},{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]},"Visit the API Reference Manual"]}]}]},"headings":[{"value":"API","id":"api","depth":1},{"value":"Introduction","id":"introduction","depth":2}],"frontmatter":{"title":"API","seo":{"title":"API"}},"lastModified":"2026-08-03T17:00:42.000Z","pagePropGetterError":{"message":"","name":""}},"slug":"/api","userData":{"isAuthenticated":false,"teams":["anonymous"]},"isPublic":true}