Harbour API Documentation

This is the complete API documentation for connecting to the Harbour 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 Harbour: Harbour is a document workflow platform for creating, sending, and managing documents and signatures. Keep reading to get started.

Quickstart

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

Every Harbour action uses the same URL pattern:

POST https://connect.mindcloud.co/v2/universal/apps/harbour/actions/{actionSlug}/run

You need a MindCloud API Key and a Harbour connection. Then call an action such as Convert Document:

curl --request POST \
  --url "https://connect.mindcloud.co/v2/universal/apps/harbour/actions/convert-document/run" \
  --header "Authorization: Bearer $MINDCLOUD_API_KEY" \
  --header "Content-Type: application/json" \
  --data '{
  "connectionId": "$CONNECTION_ID",
  "arguments": {}
}'

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 Harbour account. See Harbour API Authentication for the full flow and how to get your connection credentials.

Harbour actions

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

• PUTAnnotate Document
• GETConvert Document
• GETConvert Document From Base64
• POSTCreate Agreement
• POSTCreate Agreement Link
• POSTCreate Document
• POSTCreate Insights
• GETDownload Agreement
• GETDownload Agreement Link
• GETGet Agreement
• GETGet Agreement Link
• GETGet Agreement Link Submission
• GETGet Brand
• GETGet Document
• GETGet Folder
• GETGet Item
• GETList Agreement Link Submissions
• GETList Agreement Links
• GETList Agreements
• GETList Brands
• GETList Documents
• GETList Folders
• GETList Items
• GETList Organizations

Related apps

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

Google CalendarNotionTypeformJira Software CloudCal.comWufooBasecampOnceHub