API Documentation

Prev Next

Authentication

  • All endpoints below require header: Authorization: Bearer <API Key>

  • Content type for POST: Content-Type: application/json


getUserToken

GET /v1/users/:userId/token

Returns a JWT for the specified end user

Params
  • userId (required) – the ID for the end user

Example
curl -X GET "https://embedded.mindcloud.co/v1/users/enduser_1234/token" \
  -H "Authorization: Bearer <API Key>"

# Success: { "token": "eyJhbGciOi..." }

createUser

POST /v1/users

Creates a new end user for your company

Body Options
  • externalId (optional) – the user ID on your company

  • name (optional) – the user name

  • email (optional) – the user email

Example
curl -X POST "https://embedded.mindcloud.co/v1/users" \
  -H "Authorization: Bearer <API Key>" \
  -H "Content-Type: application/json" \
  -d '{
    "externalId": "12345",
    "name": "Jane Doe",
    "email": "customer@example.com"
  }'

# Success: { "success": true, "data": { "userId": "enduser_1234" } }

runAppAction

POST /v1/installation/apps/:appId/:appVersion/action/:actionId/run

Runs an app's action with the credentials from an installation. This endpoint is authenticated via user token, not via API key.

Body Options
  • installationId (required) – the installation's ID

  • actionArguments (optional) – the arguments for that action

Example
curl -X POST "https://embedded.mindcloud.co/v1/installation/apps/HHSTHkK9BAPm/published/action/3re615i701jr/run" \
  -H "Authorization: Bearer <End User Token>" \
  -H "Content-Type: application/json" \
  -d '{
    "installationId": "install_F8qZr6xtxE6Q",
    "actionArguments": {
      "message": "Hello World"
    }
  }'