Search the Upmind API reference (1,270+ endpoints) by keyword. Supports multi-word queries; searches names, titles, descriptions, groups, and URLs. Use this to discover the right endpoint before calling live tools or building integrations.

Get full details for one API endpoint: parameters, response schema, headers, and permissions. Accepts the endpoint name (e.g. "GetAdminProducts") or an exact URL pattern.

List all endpoint groups/categories in the Upmind API reference.

List every endpoint in one API group/category (e.g. "Contracts", "Admin_Products").

List all brands in the Upmind organisation with their IDs, domains, and currencies.

Get full details for one brand.

List product categories (with subcategories and product counts), optionally scoped to a brand.

Create a new product category (or subcategory via parent_id) for a brand.

List products, filterable by brand, category, or exact name.

Get full product details. Use "with" to include related data: prices, provision_field_values, allowed_migrations, options, products_attributes.

Create a new product in a category. Sensible defaults: single product, single-option order type, monthly billing. Use "extra" for any additional Upmind product fields (see docs endpoint PostAdminProducts). PRODUCTION: creates a live product (hidden from clients unless clients_can_order is true).

Update product fields (name, descriptions, category, visibility flags). Use "extra" for any other Upmind product field. PRODUCTION: changes are live.

Clone an existing product within the same brand. The copy is created as "{name} Copy".

Copy a product into a different brand (multi-brand catalogue management).

Reorder products within a category. Pass ALL product UUIDs of the category in the desired display order.

List all pricelists in the organisation.

Get all prices for one product across all pricelists, currencies, and billing cycles.

Set/update prices for a product on a specific pricelist. Each entry needs currency_id, billing_cycle_months, and price. PRODUCTION: changes are live immediately.

List available currencies with their UUIDs, codes, and symbols.

List the provision blueprint fields (names, types, labels) defined for a product.

Get the current provision field values configured on a product.

Update provision field values on a product (e.g. {"package_name": "Reseller Tier 2"}). PRODUCTION: affects how new services provision.

List provision configurations (e.g. servers) for a provision category code such as "shared-hosting". Omit category_code to list the provision categories themselves.

List the provision functions available on a contract product (setup, suspend, terminate, getUsage, …). Use the returned function id with trigger_provision.

List contract products (services) with filters: product, client, status code (e.g. "contract_active", "contract_suspended", "contract_cancelled"), brand. Returns a compact summary per service; set full=true for raw records.

Get a contract with its products and related data. Common "with" values: products, client, products.product, products.status.

Count active contract products for a product.

Cancel a whole contract or specific products on it. DESTRUCTIVE: this cancels live services. Provide a cancellation_reason; optionally limit to specific contract product UUIDs.

Cancel a single service on a contract, with refund control. refund_mode: 0 = no refund, 1 = full refund, 2 = pro-rata refund. DESTRUCTIVE: cancels a live service.

Activate a pending/inactive contract product (marks the service active).

Turn auto-renewal on or off for a contract product. Turning renewal off schedules the service to expire at the end of the paid period.

Change suspend/cancel/close scheduling for a contract product: either intervals in days after next_due_date, or explicit hold-off dates (not_suspend_until / not_cancel_until / not_close_until, today or future). Useful to give clients extra time before suspension.

Change the recurring selling price of a contract product (affects future invoices).

Upgrade or downgrade a contract product to a different product (with pro-rata invoice/credit note). Set dry_run=true first to preview the billing impact without changing anything.

Run a provisioning function (setup, suspend, unsuspend, terminate, getUsage, …) on a contract product. Find function IDs with list_provision_functions. PRODUCTION: executes immediately on the hosting server.

List or search clients by name, email, or company. Filter by brand.

Get client details. Common "with" values: emails, phones, addresses, accounts, tags, custom_fields.

Create a new client under a brand. Provide email + name; optionally create login credentials. Use "extra" for additional fields (language_code, currency_code, …).

Update client profile fields. Use "extra" for any other Upmind client field.

List the billing accounts of a client (account IDs are needed for wallet operations; most clients have one).

Trigger a password-reset email for a client (admin-initiated).

Resend the account verification email to a client.

List orders/baskets. Use "with" for relations like client, products.

Get one order with its products and totals.

Create an order for a client via the admin quick-order flow. By default converts straight to an invoice (convert=true). Each product needs product_id and billing_cycle_months; selling_price overrides list pricing. PRODUCTION: creates real billing documents.

Cancel a pending order. DESTRUCTIVE.

Convert a draft order/basket into a real invoice.

List invoices with filters: client, status (e.g. "unpaid", "paid", "overdue"), brand. Compact summaries by default; full=true for raw records.

Get one invoice. Common "with" values: products, payments, client, credit_notes.

Issue a credit note against an invoice. Omit amount to credit the full remaining amount, or set full_credit=true. refund_source: 0 = original payment source, 1 = wallet. DESTRUCTIVE: moves money / changes billing records.

Pay (part of) an invoice using the client's wallet/credit balance.

Record a manual (offline) refund against an invoice or pay out a credit note. Requires the gateway the refund was made through. DESTRUCTIVE: records money movement.

Generate the next recurring (renewal) invoice for a contract now, instead of waiting for the scheduler. Optionally scope to one contract product.

Regenerate invoice data and its PDF (e.g. after changing brand details or a template).

List payment transactions, filterable by client or invoice.

Record a payment against an invoice — typically an offline/manual payment through an offline gateway (see list_gateways), or charge a stored payment method. amount must be in the invoice currency. DESTRUCTIVE: records money movement.

Refund a captured payment through its gateway, by transaction reference. Omit amount to refund the full overpaid amount. DESTRUCTIVE: moves real money.

List configured payment gateways (IDs needed for refunds and manual payments).

Get a client's wallet/credit balance. Pass client_id (default account is resolved automatically) or a specific account_id.

List a client's wallet transaction history (credits, debits, top-ups).

Manually refund an amount from a client's wallet balance (e.g. paying out unused credit outside the system). DESTRUCTIVE: reduces the client's credit balance.

List support tickets with filters (client, status code, department, brand) or full-text search across subjects and message bodies. Status codes: ticket_in_progress, ticket_waiting_response, ticket_resolved, ticket_closed (short forms like "in_progress" also match).

Get one ticket with its metadata (status, client, assignees). Use get_ticket_messages for the conversation.

Get the message thread of a ticket with HTML stripped — readable conversation including private staff notes.

Open a new support ticket on behalf of a client (e.g. to document a phone call or start an outbound conversation).

Post a reply on a ticket. Set is_private=true to add an internal staff note the client cannot see. PRODUCTION: public replies email the client.

Update ticket properties: status (by code, e.g. "closed"), subject, department, priority, or linked service.

Assign a ticket to a staff user (see list_users), or unassign with user_id omitted.

List ticket departments (IDs needed for creating/moving tickets).

List promotions/coupon codes.

Get full details of one promotion (products, restrictions, usage).

Create a promotion code. type: 1 = fixed amount (needs currency_id), 2 = percentage. Applies to all products unless restricted via "extra" (products, pricelists, billing_cycles).

Update fields of an existing promotion.

Disable a promotion so it can no longer be used.

List sales leads/prospects, optionally searching by text.

Create a sales lead (prospect) — e.g. from an inbound enquiry.

Update fields on a lead.

Convert a lead into a real client record.

List emails the platform has sent, filterable by client or brand. Useful to confirm whether an invoice reminder, verification, or notification actually went out.

Get delivery details for one sent email: recipient, subject, sent/bounced state, and error/bounce data. (Upmind does not expose the rendered body via the API.)

Resend a previously sent email (e.g. an invoice or verification email that never arrived).

List configured webhook endpoints and their subscriptions.

List the event types that webhook endpoints can subscribe to.

Create a webhook endpoint. Optionally pass subscription event codes to subscribe immediately.

Update a webhook endpoint (URL, enabled state, name, secret).

Delete a webhook endpoint. DESTRUCTIVE.

List staff/admin users (IDs are needed for assign_ticket).

Get details for one staff user.

Get the products a given product is allowed to upgrade/migrate to.

Set which products a product can be upgraded to. PRODUCTION: changes are live.

Remove one upgrade path from a product.

Quick operational overview: active services, total clients, open tickets, unpaid invoices, and pending orders — optionally scoped to a brand.

List Upmind's built-in reports (revenue, churn, tax, transactions, …) that can be run with run_report.

Run a built-in Upmind report by its code/name with optional parameters (date ranges etc.). Check list_reports first; parameters vary per report.

List whitelisted IPs for the organisation, or for one staff user when user_id is given. When a whitelist exists, admin access is only allowed from these addresses.

Whitelist an IP for the organisation (or one staff user). CAUTION: once a whitelist is active, access from other IPs is blocked — add your current IP first.

Remove a whitelisted IP entry. DESTRUCTIVE: may lock out whoever uses that address.