HappyFox API Documentation

This is the complete API documentation for connecting to the HappyFox API using MindCloud's Universal API. If you are new to MindCloud, start with the Introduction to see how one API can sit in front of many different apps.

MindCloud is an integration company that offers one normalized API to access 3,100+ apps from a single place. It cleans up provider-specific quirks, keeps requests and responses consistent, and centralizes authentication so you do not need to manage separate flows for every app. Browse other apps.

Meet HappyFox: HappyFox: Manage support tickets, contacts, contact groups, and help desk metadata across tenant-specific HappyFox domains. Keep reading to get started.

Quickstart

Before you run your first HappyFox request, you need three things:

1. A MindCloud account — sign in or create an account at MindCloud.
2. A MindCloud API Key — create one in API Keys. Keep it on your server.
3. At least one HappyFox connection — create or choose one in Connections. Note its connectionId.

Every HappyFox action uses the same URL pattern:

https://connect.mindcloud.co/v1/universal/happyFox/latest/actions/{actionSlug}

You need a MindCloud API Key and a HappyFox connection. Then call an action such as Get Contact:

curl --request GET \
  --url "https://connect.mindcloud.co/v1/universal/happyFox/latest/actions/get-contact" \
  --header "Authorization: Bearer $MINDCLOUD_API_KEY" \
  --get \
  --data-urlencode "connectionId=$CONNECTION_ID"

Every response comes back in the same envelope, with your rows in a data array:

{
  "success": true,
  "data": [
    { "id": "1042", "name": "Ava" }
  ],
  "meta": {}
}

After your first request works, use Shape your requests to control arguments, pagination, filtering, fields, and errors.

Authentication

Authentication has two layers. Your MindCloud API Key authenticates the request to MindCloud, sent as a Bearer token in the Authorization header. The connectionId selects the connected HappyFox account that should run the action. MindCloud stores and refreshes the HappyFox credentials behind that connection, so you never send provider tokens with your requests.

Pass connectionId in the query string for GET and DELETE actions, and in the JSON body for POST, PUT, and PATCH actions. Keep your MindCloud API Key on your server; do not ship it in browser code, mobile apps, public repositories, or logs.

HappyFox actions

All 24 published actions for this HappyFox version. Each page documents the endpoint, arguments, and response controls.

• POSTAdd Staff Private Note
• POSTAdd Staff Update
• POSTCreate Contact
• POSTCreate Contact Group
• POSTCreate Ticket
• GETGet Contact
• GETGet Ticket
• GETList Categories
• GETList Contact Custom Fields
• GETList Contact Groups
• GETList Contacts
• GETList Priorities
• GETList Staff
• GETList Statuses
• GETList Ticket Custom Fields
• GETList Tickets
• PUTMove Ticket
• PUTRemove Contacts from Contact Group
• PUTUpdate Contact
• PUTUpdate Contact Group
• PUTUpdate Contact Group Members
• PUTUpdate Ticket Custom Fields
• PUTUpdate Ticket Properties
• PUTUpdate Ticket Tags

Related apps

More Support apps on the Universal API, behind the same REST shape. Or browse all apps.

TrelloClickUpZendeskQuoIntercomEventbriteTickTickLinear