Recommand API Documentation

This is the complete API documentation for connecting to the Recommand 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 Recommand: Recommand API integration for managing Peppol companies, documents, recipients, webhooks, playgrounds, suppliers, customers, and labels. Keep reading to get started.

Quickstart

Before you run your first Recommand 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 Recommand connection — create or choose one in Connections. Note its connectionId.

Every Recommand action uses the same URL pattern:

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

You need a MindCloud API Key and a Recommand connection. Then call an action such as Verify Authentication:

curl --request GET \
  --url "https://connect.mindcloud.co/v1/universal/recommand/latest/actions/verify-authentication" \
  --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.

Authenticate with a MindCloud API Key plus a connectionId for your Recommand account. See Recommand API Authentication for the full flow and how to get your connection credentials.

Recommand actions

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

• PUTAssign Label to Document
• PUTAssign Label to Supplier
• POSTCreate Company
• POSTCreate Company Document Type
• POSTCreate Company Identifier
• POSTCreate Company Notification Email Address
• POSTCreate Label
• POSTCreate Playground
• POSTCreate Webhook
• DELETEDelete Company
• DELETEDelete Company Document Type
• DELETEDelete Company Identifier
• DELETEDelete Company Notification Email Address
• DELETEDelete Customer
• DELETEDelete Document
• DELETEDelete Label
• DELETEDelete Supplier
• DELETEDelete Webhook
• GETDownload Document Package
• GETGet Company
• GETGet Company Document Type
• GETGet Company Identifier
• GETGet Company Notification Email Address
• GETGet Customer
• GETGet Document
• GETGet Label
• GETGet Playground
• GETGet Supplier
• GETGet Webhook
• GETInbox
• GETList Companies
• GETList Company Document Types
• GETList Company Identifiers
• GETList Company Notification Email Addresses
• GETList Customers
• GETList Documents
• GETList Labels
• GETList Suppliers
• GETList Webhooks
• PUTMark Document as Read
• GETRender Document Preview
• GETSearch Directory
• POSTSend Document
• DELETEUnassign Label from Document
• DELETEUnassign Label from Supplier
• PUTUpdate Company
• PUTUpdate Company Document Type
• PUTUpdate Company Identifier
• PUTUpdate Company Notification Email Address
• PUTUpdate Label
• PUTUpdate Webhook
• POSTUpsert Customer
• POSTUpsert Supplier
• GETVerify Authentication
• GETVerify Company
• GETVerify Document Support
• GETVerify Recipient

Related apps

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

StripeShopifySquareWooCommerceXeroThinkificWhopGumroad