Add a customer to the blacklist to prevent future transactions
\nBearer Token with permission: api:customers.blacklist.add
Remove a customer from the blacklist to allow future transactions
\nBearer Token with permission: api:customers.blacklist.remove
Check if a customer is blacklisted and view their blacklist details
\nBearer Token with permission: api:customers.blacklist.check
No request body required. The customer is identified by the customer_number in the URL path.
\nCancel all or specific subscriptions for a customer
\nBearer Token with permission: api:customers.subscriptions.cancel
The endpoint accepts either a customer_number or subscription_number as the identifier in the URL path
\nIf a subscription_number is provided in the URL, only that subscription will be canceled
\nIf a customer_number is provided in the URL and no subscription_number in the request body, all cancelable subscriptions will be canceled
\nIf both URL identifier and request body subscription_number are provided, the subscription must belong to the specified customer
\nCancel all or specific fulfillments for a customer
\nBearer Token with permission: api:customers.fulfillments.cancel
The endpoint accepts either a customer_number or fulfillment_number as the identifier in the URL path
\nIf a fulfillment_number is provided in the URL, only that fulfillment will be canceled
\nIf a customer_number is provided in the URL and no fulfillment_number in the request body, all cancelable fulfillments will be canceled
\nIf both URL identifier and request body fulfillment_number are provided, the fulfillment must belong to the specified customer
\nOnly fulfillments with status PENDING, PROCESSING, or ON_HOLD can be canceled
\nCreate a new lead within Health Suite
\nBearer Token from collection Health Suite
\nProcess a payment for an existing lead that was created from the Create Lead endpoint
\nBearer Token from collection Health Suite
\nStandard payment processing. The order is created and payment is captured immediately.
\nFor payments processed outside the platform. Set payment.method to \"external\" and optionally pass payment.external_payment_id to link the transaction to a specific alternative payment method configured in the CRM. The order completes immediately with no gateway interaction.
Redirect-based payment flow requiring three steps:
\npayment.method set to \"paypal_wallet\", along with return_url and cancel_url. The response includes a redirect_url.redirect_url. They log in to PayPal and approve the payment. PayPal redirects them back to your return_url.POST /checkout/orders/capture with the order_number to finalize the charge. Money does not move until this step.Two ways to populate the order's tax:
\ntax_amount (and optionally tax_rate) in the request body. Typical flow: call POST /checkout/tax first to get the calculated values, then pass them here to lock in what the customer saw on the checkout page. The customer is always charged the tax_amount you supply.Charge vs. report are separate decisions:
\ntax_amount controls what the customer pays.tax_enabled flag + active provider. If the campaign has tax disabled, the customer is still charged the supplied tax_amount, but nothing is reported to TaxJar's books.Create a new order within the CRM
\nBearer Token from collection Health Suite
\nStandard payment processing. The order is created and payment is captured immediately.
\nFor payments processed outside the platform. Set payment.method to \"external\" and optionally pass payment.external_payment_id to link the transaction to a specific alternative payment method configured in the CRM. The order completes immediately with no gateway interaction.
Redirect-based payment flow requiring three steps:
\npayment.method set to \"paypal_wallet\", along with return_url and cancel_url. The response includes a redirect_url.redirect_url. They log in to PayPal and approve the payment. PayPal redirects them back to your return_url.POST /checkout/orders/capture with the order_number to finalize the charge. Money does not move until this step.Two ways to populate the order's tax:
\ntax_amount (and optionally tax_rate) in the request body. Typical flow: call POST /checkout/tax first to get the calculated values, then pass them here to lock in what the customer saw on the checkout page. The customer is always charged the tax_amount you supply.Charge vs. report are separate decisions:
\ntax_amount controls what the customer pays.tax_enabled flag + active provider. If the campaign has tax disabled, the customer is still charged the supplied tax_amount, but nothing is reported to TaxJar's books.Process a transaction as an upsell for an existing order from within the CRM
\nBearer Token from collection Health Suite
\nTwo ways to populate the upsell's tax:
\ntax_amount (and optionally tax_rate) in the request body. Typical flow: call POST /checkout/tax with the upsell's line items to get the calculated tax, then pass the returned value here. The customer is charged the tax_amount you supply.CampaignUpsell.tax_rate configured on the offer.Each upsell posts to TaxJar as its own record. When the upsell transaction completes, it's posted to TaxJar's /v2/transactions/orders endpoint keyed by the transaction's ID. Refunds of this upsell will reference that specific transaction — so tax reporting stays accurate even when items in the same order have different tax treatments (e.g., taxable base + tax-exempt clothing upsell).
Charge vs. report are separate decisions:
\ntax_amount controls what the customer pays.tax_enabled flag + active provider. If the campaign has tax disabled, the customer is still charged the supplied tax_amount, but nothing is reported to TaxJar's books.Mark an order as completed within the CRM.
\nNote: By default, this endpoint will be called 20 minutes after the customers last transaction which will close the order and send any applicable transactional emails
\nBearer Token from collection Health Suite
\nCaptures a PayPal Wallet payment after the customer has approved it on PayPal. This is the final step in the PayPal redirect flow.
\nThis endpoint is idempotent — if the payment has already been captured, it will return the current state without charging again.
\npayment.method set to \"paypal_wallet\". You receive a redirect_url in the response.redirect_url. They approve the payment on PayPal and are redirected back to your return_url.order_number to finalize the charge. Money does not move until this step completes.Bearer Token from collection Health Suite
\nReturn information about orders that match the specified search criteria from within the CRM
\nBearer Token from collection Health Suite
\nCalculates sales tax for a cart in real time via the campaign's configured tax provider (TaxJar). Intended to be called during checkout whenever the cart or shipping address changes, so the tax amount displayed to the customer stays in sync with the line items and destination.
\nIf the campaign has no tax provider configured, is disabled, or the provider is inactive, the endpoint returns tax_amount: 0, tax_rate: 0, empty breakdown, and tax_enabled: false. Callers should treat that as a successful \"no tax required\" response rather than an error.
Bearer Token from collection Health Suite. The API key must have the api:tax.calculate permission.
{\n \"success\": true,\n \"data\": {\n \"tax_amount\": 4.37,\n \"tax_rate\": 0.0875,\n \"breakdown\": {\n \"state\": 3.00,\n \"county\": 0.50,\n \"city\": 0.50,\n \"special\": 0.37\n },\n \"tax_enabled\": true\n }\n}\n{\n \"success\": true,\n \"data\": {\n \"tax_amount\": 0,\n \"tax_rate\": 0,\n \"breakdown\": [],\n \"tax_enabled\": false\n }\n}\nTaxJar exposes a taxonomy of product categories that alter per-jurisdiction taxability (clothing is exempt in PA but taxable in CA, groceries are reduced-rate in many states, prescriptions are exempt nearly everywhere, etc.).
\ntax_code to treat the item as fully taxable — TaxJar's default.tax_code to let TaxJar consult ship-from / ship-to / local rules for that category.GET /v2/categories in the TaxJar API.tax_amount can be passed back to POST /checkout/orders as tax_amount (and optionally tax_rate) to lock in the calculated value. The Order endpoints will otherwise recompute tax server-side when the campaign has tax enabled.Here are example offers and how you would interract with the endpoints:
\nMultiple Step Form with Upsells (Capture lead and then capture card information):
Create Lead -> Process Payment -> Process Upsell #1 -> Process Upsell #2 -> Complete Order (optional)
Single Checkout Form with Upsells (Capture lead and card information in one form):
Create Order -> Process Upsell #1 -> Process Upsell #2 -> Complete Order (optional)
Note: The Create Order endpoint is a stand-alone order creation for 1-step checkouts.
Where as the Create Lead and Process Payment endpoint are paired together for 2-step checkouts
Return payment transactions that match the specified search criteria from within the CRM
\nBearer Token from collection Health Suite
\nProcess a refund for a specific transaction from within the CRM
\nBearer Token from collection Health Suite
\nWhen a refund is processed on an order whose campaign has TaxJar enabled and whose original order was posted to TaxJar, a matching refund transaction is automatically posted to TaxJar's /v2/transactions/refunds endpoint. No additional request fields are required — tax handling is driven by the campaign's tax provider configuration and the order's original TaxJar transaction.
Proration: The refund's tax and shipping portions are prorated by refund_amount / order_total against the original order's tax and shipping. Example — refunding $59.38 of a $118.75 order (50%) posts sales_tax: -4.38 against the original sales_tax: 8.75.
Coverage:
\nOrderVoidedEvent) on TaxJar-posted orders — sent as a full-amount negative refund.is_external: true) — still posted since TaxJar tracks tax liability regardless of money movement.ProcessAlertRefundAction.Idempotency: Each refund is posted with a stable transaction_id of \"{order_id}-refund-{transaction_id}\" and a transaction_reference_id linking to the original order. Duplicate posts (422) are treated as success. The transactions.tax_posted_at timestamp marks which refund rows have been posted.
Skipped cases: Orders without a TaxJar provider, with tax_enabled: false, or that were never posted to TaxJar (orders.tax_posted_at null) — nothing is sent in these cases.
This simplified API streamlines the checkout process for developers. Designed with ease of use in mind, Health Suite API reduces complexity and allows you to implement checkout functionality with minimal code requirements. The streamlined interface focuses on essential operations, making integration straightforward while maintaining robust functionality.
\nRegister for a Health Suite account to get started
\nLogin to your Health Suite Account
\nNavigate to Settings > API Keys
\nClick \"Generate API Key\"
\nCopy your newly generated API key
\nStore this key securely - it will only be shown once
\nInclude your API key in all requests as a Bearer token in the Authorization header:
\nAuthorization: Bearer YOUR_API_KEY_HERE
All authenticated endpoints require this header to be present with a valid API key.
\nThis is a JSON API and requires proper headers for all requests:
\nAll requests must include Content-Type: application/json
All requests must include Accept: application/json
If these headers are not included, the API will return a 400 Bad Request response with an error message indicating which header is missing or incorrect, such as \"Content-Type must be application/json\" or \"Accept must be application/json\".
\nTo ensure system stability and fair usage, API requests are subject to the below rate limiting per account:
\n100 requests per minute is default
\nEnterprise accounts can be set to custom rate limits (e.g. 1,000 requests per minute and beyond). To increase rate limits please email hello@healthsuite.io.
\nWhen a rate limit is exceeded, the API will return a 429 Too Many Requests response with the following headers:
\nHealth Suite uses conventional HTTP response codes to indicate the success or failure of an API request. In general:
\nCodes in the 2xx range indicate success
Codes in the 4xx range indicate an error that failed given the information provided (e.g., a required parameter was omitted, invalid object passed, etc.)
Codes in the 5xx range indicate an error with Health Suite's servers (these are rare)
All 4xx and 5xx errors return an error message via the \"errors\" field.
{\n \"success\": false,\n \"message\": \"Validation error\",\n \"errors\": {\n \"customer.email\": [\n \"The email field is required.\"\n ],\n \"shipping.address1\": [\n \"The address1 field is required.\"\n ]\n }\n}\n\nIf there is no data for a response field, the API will use null for that field's value.
Retrieve information about campaigns that match the specified search criteria, or get a specific campaign by its identifier.
\nBearer Token from collection Health Suite
\nGET /v1/campaigns\nAuthorization: Bearer YOUR_API_KEY_HERE\nContent-Type: application/json\nAccept: application/json\n\nGET /v1/campaigns?is_active=true\nAuthorization: Bearer YOUR_API_KEY_HERE\nContent-Type: application/json\nAccept: application/json\n\nGET /v1/campaigns?is_active=false\nAuthorization: Bearer YOUR_API_KEY_HERE\nContent-Type: application/json\nAccept: application/json\n\nGET /v1/campaigns?search=summer\nAuthorization: Bearer YOUR_API_KEY_HERE\nContent-Type: application/json\nAccept: application/json\n\nGET /v1/campaigns?identifier=123\nAuthorization: Bearer YOUR_API_KEY_HERE\nContent-Type: application/json\nAccept: application/json\n\nGET /v1/campaigns?is_active=true&search=sale&per_page=10\nAuthorization: Bearer YOUR_API_KEY_HERE\nContent-Type: application/json\nAccept: application/json\n\n{\n \"success\": true,\n \"data\": {\n \"id\": 1,\n \"internal_id\": \"123\",\n \"name\": \"Summer Sale Campaign\",\n \"uuid\": \"550e8400-e29b-41d4-a716-446655440000\",\n \"is_active\": true,\n \"allowed_countries\": [\"US\", \"CA\", \"GB\"],\n \"allowed_currencies\": [\"USD\", \"CAD\", \"GBP\"],\n \"allowed_card_brands\": [\"visa\", \"mastercard\", \"amex\"],\n \"allow_prepaid_cards\": true,\n \"allow_virtual_cards\": false,\n \"allow_international_cards\": true,\n \"minimum_amount\": \"1000\",\n \"maximum_amount\": \"50000\",\n \"max_customer_declines\": 3,\n \"fulfillment_delay\": 24,\n \"category\": {\n \"id\": 1,\n \"name\": \"E-commerce\"\n },\n \"gateway_id\": 1,\n \"payment_orchestrator_id\": null,\n \"created_at\": \"2024-01-15T10:30:00.000Z\",\n \"updated_at\": \"2024-01-20T14:45:00.000Z\",\n \"offers_count\": 3,\n \"upsells_count\": 2\n }\n}\n\n{\n \"success\": true,\n \"data\": [\n {\n \"id\": 1,\n \"internal_id\": \"123\",\n \"name\": \"Summer Sale Campaign\",\n \"uuid\": \"550e8400-e29b-41d4-a716-446655440000\",\n \"is_active\": true,\n \"allowed_countries\": [\"US\", \"CA\", \"GB\"],\n \"allowed_currencies\": [\"USD\", \"CAD\", \"GBP\"],\n \"allowed_card_brands\": [\"visa\", \"mastercard\", \"amex\"],\n \"allow_prepaid_cards\": true,\n \"allow_virtual_cards\": false,\n \"allow_international_cards\": true,\n \"minimum_amount\": \"1000\",\n \"maximum_amount\": \"50000\",\n \"max_customer_declines\": 3,\n \"fulfillment_delay\": 24,\n \"category\": {\n \"id\": 1,\n \"name\": \"E-commerce\"\n },\n \"gateway_id\": 1,\n \"payment_orchestrator_id\": null,\n \"created_at\": \"2024-01-15T10:30:00.000Z\",\n \"updated_at\": \"2024-01-20T14:45:00.000Z\",\n \"offers_count\": 3,\n \"upsells_count\": 2\n }\n ],\n \"pagination\": {\n \"total\": 1,\n \"per_page\": 15,\n \"current_page\": 1,\n \"last_page\": 1,\n \"from\": 1,\n \"to\": 1\n }\n}\n\nRetrieve a specific alternative payment method by its ID.
\nBearer Token from collection Health Suite
\nGET /v1/alternative-payments/2\nAuthorization: Bearer YOUR_API_KEY_HERE\nContent-Type: application/json\nAccept: application/json\n\n{\n \"success\": true,\n \"data\": {\n \"id\": 2,\n \"name\": \"Zelle Payments\",\n \"payment_type\": \"zelle\",\n \"payment_type_label\": \"Zelle\",\n \"status\": \"active\",\n \"supports_refunds\": false,\n \"supports_voids\": false,\n \"supports_upsells\": false,\n \"test_mode\": false,\n \"requires_redirect\": false,\n \"created_at\": \"2026-02-12T11:00:00.000000Z\",\n \"updated_at\": \"2026-02-12T11:00:00.000000Z\"\n }\n}\n\nRetrieve a paginated list of alternative payment methods configured for your account. Use the id field from the response as the payment[external_payment_id] when creating orders.
Bearer Token from collection Health Suite
\nGET /v1/alternative-payments\nAuthorization: Bearer YOUR_API_KEY_HERE\nContent-Type: application/json\nAccept: application/json\n\nGET /v1/alternative-payments?payment_type=paypal_wallet\nAuthorization: Bearer YOUR_API_KEY_HERE\nContent-Type: application/json\nAccept: application/json\n\nGET /v1/alternative-payments?status=active\nAuthorization: Bearer YOUR_API_KEY_HERE\nContent-Type: application/json\nAccept: application/json\n\nGET /v1/alternative-payments?search=zelle\nAuthorization: Bearer YOUR_API_KEY_HERE\nContent-Type: application/json\nAccept: application/json\n\nGET /v1/alternative-payments?status=active&payment_type=external&per_page=10\nAuthorization: Bearer YOUR_API_KEY_HERE\nContent-Type: application/json\nAccept: application/json\n\n{\n \"success\": true,\n \"data\": [\n {\n \"id\": 1,\n \"name\": \"PayPal Business\",\n \"payment_type\": \"paypal_wallet\",\n \"payment_type_label\": \"PayPal Wallet\",\n \"status\": \"active\",\n \"supports_refunds\": true,\n \"supports_voids\": true,\n \"supports_upsells\": true,\n \"test_mode\": false,\n \"requires_redirect\": true,\n \"created_at\": \"2026-02-12T10:00:00.000000Z\",\n \"updated_at\": \"2026-02-12T13:33:00.000000Z\"\n },\n {\n \"id\": 2,\n \"name\": \"Zelle Payments\",\n \"payment_type\": \"zelle\",\n \"payment_type_label\": \"Zelle\",\n \"status\": \"active\",\n \"supports_refunds\": false,\n \"supports_voids\": false,\n \"supports_upsells\": false,\n \"test_mode\": false,\n \"requires_redirect\": false,\n \"created_at\": \"2026-02-12T11:00:00.000000Z\",\n \"updated_at\": \"2026-02-12T11:00:00.000000Z\"\n }\n ],\n \"pagination\": {\n \"total\": 2,\n \"per_page\": 15,\n \"current_page\": 1,\n \"last_page\": 1,\n \"from\": 1,\n \"to\": 2\n }\n}\n\nRetrieve a paginated list of coupons with optional filtering and search capabilities.
\nBearer Token from collection Health Suite
\nRetrieve detailed information about a specific coupon by its code.
\nBearer Token from collection Health Suite
\nCreate a new coupon with specified discount rules and restrictions.
\nBearer Token from collection Health Suite
\nValidate a coupon for checkout and calculate the discount amount based on the provided context.
\nBearer Token from collection Health Suite
\nUpdate an existing coupon's properties and restrictions.
\nBearer Token from collection Health Suite
\nSoft delete a coupon from the system.
\nBearer Token from collection Health Suite
\nRetrieve notes for a specific customer that match the specified search criteria.
\nBearer Token from collection Health Suite
\nRetrieve a specific note for a customer by note ID.
\nBearer Token from collection Health Suite
\nNo request body parameters. The customer number and note ID are provided in the URL path.
\nCreate a new note for a specific customer.
\nBearer Token from collection Health Suite
\nUpdate an existing note for a specific customer.
\nBearer Token from collection Health Suite
\nNote: At least one field must be provided to update the note. All fields use \"sometimes\" validation, meaning they're only validated if present in the request.
\nDelete a specific note for a customer by note ID.
\nBearer Token from collection Health Suite
\nNo request body parameters. The customer number and note ID are provided in the URL path.
\nRetrieve fulfillments that match the specified search criteria with filtering and pagination support.
\nBearer Token from collection Health Suite
\nRetrieve detailed information for a specific fulfillment by fulfillment number.
\nBearer Token from collection Health Suite
\nNo request body parameters. The fulfillment number is provided in the URL path.
\nRetrieve notes for a specific order that match the specified search criteria.
\nBearer Token from collection Health Suite
\nCreate a new note for a specific order.
\nBearer Token from collection Health Suite
\nRetrieve a specific note for an order by note ID.
\nBearer Token from collection Health Suite
\nNo request body parameters. The order number and note ID are provided in the URL path.
\nUpdate an existing note for a specific order.
\nBearer Token from collection Health Suite
\nNote: At least one field must be provided to update the note. All fields use \"sometimes\" validation, meaning they're only validated if present in the request.
\nDelete a specific note for an order by note ID.
\nBearer Token from collection Health Suite
\nNo request body parameters. The order number and note ID are provided in the URL path.
\nRetrieve all products (offers and upsells combined) for a specific campaign. Products are returned sorted by position and can be filtered by type and active status.
\nBearer Token from collection Health Suite
\nGET /v1/campaigns/123/products\nAuthorization: Bearer YOUR_API_KEY_HERE\nContent-Type: application/json\nAccept: application/json\nGET /v1/campaigns/123/products?is_active=true\nAuthorization: Bearer YOUR_API_KEY_HERE\nContent-Type: application/json\nAccept: application/json\nGET /v1/campaigns/123/products?product_type=offer\nAuthorization: Bearer YOUR_API_KEY_HERE\nContent-Type: application/json\nAccept: application/json\nGET /v1/campaigns/123/products?product_type=upsell\nAuthorization: Bearer YOUR_API_KEY_HERE\nContent-Type: application/json\nAccept: application/json\nGET /v1/campaigns/123/products?product_type=offer&is_active=true&per_page=10\nAuthorization: Bearer YOUR_API_KEY_HERE\nContent-Type: application/json\nAccept: application/json\n{\n \"success\": true,\n \"data\": [\n {\n \"id\": 1,\n \"internal_id\": \"offer_001\",\n \"name\": \"Premium Package\",\n \"product_type\": \"offer\",\n \"is_active\": true,\n \"position\": 1,\n \"price\": \"2999\",\n \"shipping_price\": \"599\",\n \"tax_rate\": \"0.08\",\n \"is_tax_included\": false,\n \"dynamic_descriptor\": \"PREMIUM PKG\",\n \"sale_type\": \"one_time\",\n \"subscription_config\": null,\n \"allow_duplicates\": null,\n \"requires_shipping_on_trial\": null,\n \"billing_interval\": null,\n \"billing_cycles\": null,\n \"billing_schedule\": null,\n \"use_offer_gateway\": null,\n \"gateway_id\": null,\n \"payment_orchestrator_id\": null,\n \"product\": {\n \"id\": 1,\n \"name\": \"Premium Package\",\n \"sku\": \"PREM-001\",\n \"description\": \"Our premium package with all features included\",\n \"weight\": \"2.5\",\n \"dimensions\": {\n \"length\": \"10\",\n \"width\": \"8\",\n \"height\": \"6\"\n },\n \"requires_shipping\": true\n },\n \"created_at\": \"2024-01-15T10:30:00.000Z\",\n \"updated_at\": \"2024-01-20T14:45:00.000Z\"\n },\n {\n \"id\": 2,\n \"internal_id\": \"upsell_001\",\n \"name\": \"Extended Warranty\",\n \"product_type\": \"upsell\",\n \"is_active\": true,\n \"position\": 2,\n \"price\": \"999\",\n \"shipping_price\": \"0\",\n \"tax_rate\": \"0.08\",\n \"is_tax_included\": false,\n \"dynamic_descriptor\": \"WARRANTY\",\n \"sale_type\": \"subscription\",\n \"subscription_config\": {\n \"interval\": \"monthly\",\n \"cycles\": 12\n },\n \"allow_duplicates\": false,\n \"requires_shipping_on_trial\": false,\n \"billing_interval\": \"monthly\",\n \"billing_cycles\": 12,\n \"billing_schedule\": {\n \"start_date\": \"immediate\",\n \"trial_days\": 0\n },\n \"use_offer_gateway\": true,\n \"gateway_id\": null,\n \"payment_orchestrator_id\": null,\n \"product\": {\n \"id\": 2,\n \"name\": \"Extended Warranty\",\n \"sku\": \"WARR-001\",\n \"description\": \"12-month extended warranty coverage\",\n \"weight\": \"0\",\n \"dimensions\": null,\n \"requires_shipping\": false\n },\n \"created_at\": \"2024-01-15T11:00:00.000Z\",\n \"updated_at\": \"2024-01-20T15:00:00.000Z\"\n }\n ],\n \"campaign\": {\n \"internal_id\": \"123\",\n \"name\": \"Summer Sale Campaign\",\n \"uuid\": \"550e8400-e29b-41d4-a716-446655440000\"\n },\n \"pagination\": {\n \"total\": 2,\n \"per_page\": 15,\n \"current_page\": 1,\n \"last_page\": 1,\n \"from\": 1,\n \"to\": 2\n }\n}\nRetrieve notes for a specific transaction that match the specified search criteria.
\nBearer Token from collection Health Suite
\nCreate a new note for a specific transaction.
\nBearer Token from collection Health Suite
\nUpdate an existing note for a specific transaction.
\nBearer Token from collection Health Suite
\nNote: At least one field must be provided to update the note. All fields use \"sometimes\" validation, meaning they're only validated if present in the request.
\nDelete a specific note for a transaction by note ID.
\nBearer Token from collection Health Suite
\nNo request body parameters. The transaction number and note ID are provided in the URL path.
\nThe REST API is used to create, read, update, and delete all system resources, so companies can build truly headless e-commerce experiences without having to do all the integrations Health Suite has already done.
\nThis comprehensive API provides full access to your Health Suite resources including campaigns, products, orders, customers, and more. Designed with flexibility in mind, the REST API enables developers to build custom integrations, dashboards, and automated workflows while leveraging Health Suite's powerful e-commerce infrastructure. The API follows RESTful conventions and returns consistent JSON responses across all endpoints.
\nRegister for a Health Suite account to get started
\nInclude your API key in all requests as a Bearer token in the Authorization header:\nAuthorization: Bearer YOUR_API_KEY_HERE
All authenticated endpoints require this header to be present with a valid API key.
\nThis is a JSON API and requires proper headers for all requests:
\nContent-Type: application/jsonAccept: application/jsonIf these headers are not included, the API will return a 400 Bad Request response with an error message indicating which header is missing or incorrect, such as \"Content-Type must be application/json\" or \"Accept must be application/json\".
\nDifferent API endpoints require specific permissions. Your API key must have the appropriate permissions assigned to access each endpoint:
\nIf your API key lacks the necessary permissions, you'll receive a 403 Forbidden response with the message \"Unauthorized. Token lacks the necessary permissions.\"
\nTo ensure system stability and fair usage, API requests are subject to the below rate limiting per account:
\nWhen a rate limit is exceeded, the API will return a 429 Too Many Requests response with the following headers:
\nAll REST API requests should be made to:\nhttps://api.healthsuite.io/v1
List endpoints support pagination to help you manage large datasets efficiently:
\nPaginated responses include a pagination object with the following structure:
{\n \"success\": true,\n \"data\": [...],\n \"pagination\": {\n \"total\": 150,\n \"per_page\": 15,\n \"current_page\": 1,\n \"last_page\": 10,\n \"from\": 1,\n \"to\": 15\n }\n}\nMany endpoints support filtering and search capabilities:
\nSearch parameters typically perform partial matches across multiple fields (e.g., name, internal_id) using SQL LIKE operations.
\nResources can be identified using multiple identifiers for flexibility:
\n123)550e8400-e29b-41d4-a716-446655440000)The API automatically detects the identifier type - numeric values are treated as internal IDs, while non-numeric values are treated as UUIDs.
\nHealth Suite uses conventional HTTP response codes to indicate the success or failure of an API request. In general:
\n2xx range indicate success4xx range indicate an error that failed given the information provided (e.g., a required parameter was omitted, invalid object passed, etc.)5xx range indicate an error with Health Suite's servers (these are rare)All 4xx and 5xx errors return an error message via the \"errors\" field.
{\n \"success\": false,\n \"message\": \"Validation error\",\n \"errors\": {\n \"identifier\": [\n \"The identifier field is required.\"\n ],\n \"per_page\": [\n \"The per page field must be between 1 and 15.\"\n ]\n }\n}\nIf there is no data for a response field, the API will use null for that field's value.
All API responses follow a consistent format:
\n{\n \"success\": true,\n \"data\": {...},\n \"pagination\": {...} // Only present for paginated responses\n}\n{\n \"success\": false,\n \"message\": \"Error description\",\n \"errors\": {...}, // Validation errors (when applicable)\n \"error\": \"Technical error message\" // Server errors (when applicable)\n}\n1999\"US\", \"CA\", \"GB\")\"USD\", \"EUR\", \"GBP\")All API requests are automatically scoped to your team/account. You can only access resources that belong to your team, ensuring complete data isolation and security.
\n","_postman_id":"9315e073-dcf9-4a75-9200-f6479c8e8e5a","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":true,"source":{"_postman_id":"19891c09-8068-478a-9933-9452ba0ca218","id":"19891c09-8068-478a-9933-9452ba0ca218","name":"Health Suite","type":"collection"}}},{"name":"Enrichment","item":[{"name":"Email Validation","id":"e6f1c632-bd9e-4983-804d-ffef2bc21b5d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"","description":"When email validation is enabled, the following structure is returned in the enrichment.email object:
\nWhen phone validation is enabled, the following structure is returned in the enrichment.phone object:
\nWhen address verification is enabled, the following structure is returned in the enrichment.address object:
\nHealth Suite's enrichment services provide real-time validation and standardization for customer data during checkout. When enabled, these services automatically validate email addresses, phone numbers, and shipping addresses to reduce fraud, improve deliverability, and ensure accurate fulfillment.
\nTo use enrichment services:
\nWhen enrichment services are enabled:
\nenrichment response objectEnrichment data is automatically included in responses from:
\nPOST /checkout/orders - Create OrderPOST /checkout/orders/payment - Process PaymentPOST /checkout/leads - Create Lead (when enrich=true parameter is included)GET /checkout/orders - Search Orders (for orders processed with enrichment enabled)Each enrichment service is billed per validation. Contact support@healthsuite.io for pricing details.
\n","_postman_id":"02a506d2-1136-4216-909c-0c8af785cbc0","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":true,"source":{"_postman_id":"19891c09-8068-478a-9933-9452ba0ca218","id":"19891c09-8068-478a-9933-9452ba0ca218","name":"Health Suite","type":"collection"}}}],"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]}},"event":[{"listen":"prerequest","script":{"type":"text/javascript","packages":{},"exec":[""],"id":"2f717493-091a-4ca0-82b6-a2db10fe698d"}},{"listen":"test","script":{"type":"text/javascript","packages":{},"exec":[""],"id":"a0ae985f-f52e-4995-883a-371cdc55827c"}}],"variable":[{"key":"api_token","value":"","type":"string"}]}