WHMCS

opencollection: 1.0.0
info:
  name: WHMCS API
  version: 1.0.0
request:
  auth:
    type: apikey
    key: identifier
    value: '{{identifier}}'
    placement: query
items:
- info:
    name: Clients
    type: folder
  items:
  - info:
      name: Get Clients
      type: http
    http:
      method: POST
      url: https://{your-domain}/includes/api.php/?action=GetClients
      body:
        type: form-urlencoded
        data: []
    docs: Retrieve a list of clients from WHMCS.
  - info:
      name: Get Client Details
      type: http
    http:
      method: POST
      url: https://{your-domain}/includes/api.php/?action=GetClientsDetails
      body:
        type: form-urlencoded
        data: []
    docs: Retrieve detailed information for a specific client.
  - info:
      name: Add Client
      type: http
    http:
      method: POST
      url: https://{your-domain}/includes/api.php/?action=AddClient
      body:
        type: form-urlencoded
        data: []
    docs: Add a new client account to WHMCS.
  - info:
      name: Update Client
      type: http
    http:
      method: POST
      url: https://{your-domain}/includes/api.php/?action=UpdateClient
      body:
        type: form-urlencoded
        data: []
    docs: Update an existing client account in WHMCS.
  - info:
      name: Delete Client
      type: http
    http:
      method: POST
      url: https://{your-domain}/includes/api.php/?action=DeleteClient
      body:
        type: form-urlencoded
        data: []
    docs: Delete a client account from WHMCS.
- info:
    name: Orders
    type: folder
  items:
  - info:
      name: Get Orders
      type: http
    http:
      method: POST
      url: https://{your-domain}/includes/api.php/?action=GetOrders
      body:
        type: form-urlencoded
        data: []
    docs: Retrieve a list of orders from WHMCS.
  - info:
      name: Add Order
      type: http
    http:
      method: POST
      url: https://{your-domain}/includes/api.php/?action=AddOrder
      body:
        type: form-urlencoded
        data: []
    docs: Create a new order in WHMCS.
  - info:
      name: Get Products
      type: http
    http:
      method: POST
      url: https://{your-domain}/includes/api.php/?action=GetProducts
      body:
        type: form-urlencoded
        data: []
    docs: Retrieve a list of products and services available in WHMCS.
- info:
    name: Billing
    type: folder
  items:
  - info:
      name: Get Invoices
      type: http
    http:
      method: POST
      url: https://{your-domain}/includes/api.php/?action=GetInvoices
      body:
        type: form-urlencoded
        data: []
    docs: Retrieve a list of invoices from WHMCS.
  - info:
      name: Get Invoice
      type: http
    http:
      method: POST
      url: https://{your-domain}/includes/api.php/?action=GetInvoice
      body:
        type: form-urlencoded
        data: []
    docs: Retrieve a specific invoice from WHMCS.
  - info:
      name: Create Invoice
      type: http
    http:
      method: POST
      url: https://{your-domain}/includes/api.php/?action=CreateInvoice
      body:
        type: form-urlencoded
        data: []
    docs: Create a new invoice in WHMCS.
- info:
    name: Support
    type: folder
  items:
  - info:
      name: Get Tickets
      type: http
    http:
      method: POST
      url: https://{your-domain}/includes/api.php/?action=GetTickets
      body:
        type: form-urlencoded
        data: []
    docs: Retrieve a list of support tickets from WHMCS.
  - info:
      name: Open Ticket
      type: http
    http:
      method: POST
      url: https://{your-domain}/includes/api.php/?action=OpenTicket
      body:
        type: form-urlencoded
        data: []
    docs: Open a new support ticket in WHMCS.
- info:
    name: Domains
    type: folder
  items:
  - info:
      name: Domain Register
      type: http
    http:
      method: POST
      url: https://{your-domain}/includes/api.php/?action=DomainRegister
      body:
        type: form-urlencoded
        data: []
    docs: Register a new domain via WHMCS.
  - info:
      name: Domain WHOIS
      type: http
    http:
      method: POST
      url: https://{your-domain}/includes/api.php/?action=DomainWhois
      body:
        type: form-urlencoded
        data: []
    docs: Perform a WHOIS lookup on a domain.
- info:
    name: System
    type: folder
  items:
  - info:
      name: Get WHMCS Details
      type: http
    http:
      method: POST
      url: https://{your-domain}/includes/api.php/?action=WhmcsDetails
      body:
        type: form-urlencoded
        data: []
    docs: Retrieve WHMCS installation details including version and settings.
  - info:
      name: Get Stats
      type: http
    http:
      method: POST
      url: https://{your-domain}/includes/api.php/?action=GetStats
      body:
        type: form-urlencoded
        data: []
    docs: Retrieve WHMCS statistics dashboard data.
- info:
    name: Authentication
    type: folder
  items:
  - info:
      name: Validate Login
      type: http
    http:
      method: POST
      url: https://{your-domain}/includes/api.php/?action=ValidateLogin
      body:
        type: form-urlencoded
        data: []
    docs: Validate client login credentials against WHMCS.
  - info:
      name: Create SSO Token
      type: http
    http:
      method: POST
      url: https://{your-domain}/includes/api.php/?action=CreateSsoToken
      body:
        type: form-urlencoded
        data: []
    docs: Create a single sign-on token for a client or admin user.
bundled: true