Encircle API Documentation
This is the complete API documentation for connecting to the Encircle 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 Encircle: Document claims, inspections, equipment, and restoration field data. Keep reading to get started.
Quickstart
Before you run your first Encircle request, you need three things:
- A MindCloud account — sign in or create an account at MindCloud.
- A MindCloud API Key — create one in API Keys. Keep it on your server.
- At least one Encircle connection — create or choose one in Connections. Note its
connectionId.
Every Encircle action uses the same URL pattern:
POST https://connect.mindcloud.co/v2/universal/apps/encircle/actions/{actionSlug}/runYou need a MindCloud API Key and a Encircle connection. Then call an action such as Find Claim Assignments:
curl --request POST \
--url "https://connect.mindcloud.co/v2/universal/apps/encircle/actions/find-claim-assignments/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 Encircle account. See Encircle API Authentication for the full flow and how to get your connection credentials.
Encircle actions
All 24 published actions for this Encircle version. Each page documents the endpoint, arguments, and response controls.
- POSTAssign User To Claim
- POSTCreate Claim Note
- POSTCreate Property Claim
- POSTCreate Property Inspection
- GETFind Claim Assignments
- GETFind Claim Media
- GETFind Claim Notes
- GETFind Claim Rooms
- GETFind Claim Structures
- GETFind Equipment
- GETFind Inspection Assignments
- GETFind Inspection Rooms
- GETFind Inspection Structures
- GETFind Organization Brands
- GETFind Organizations
- GETFind Property Claims
- GETFind Property Inspections
- GETGet Claim Note
- GETGet Property Claim
- GETGet Property Inspection
- DELETEUnassign User From Claim
- PUTUpdate Claim Note
- PUTUpdate Property Claim
- PUTUpdate Property Inspection
Related apps
More Support apps on the Universal API, behind the same REST shape. Or browse all apps.