Canopy Connect

Canopy Connect Monitorings API

Manage synced accounts

GitHub OpenAPI

Operations 8

Each operation below carries the questions people ask an LLM about it and the instructions they give an agent to run it. Generated by API Evangelist overlay

GET /teams/{teamId}/monitorings List monitorings on insurance accounts · GET /monitorings #
Ask an LLM
“Which insurance accounts am I currently monitoring for refreshes?”
“Can I list only the monitorings tied to one pull or with a particular status?”
Tell an agent
List the monitorings on team {team}.
Show monitorings for pull {pull} on team {team}.
POST /teams/{teamId}/monitorings Start monitoring an insurance account · POST /monitorings #
Ask an LLM
“How do I set up recurring refreshes of a connected insurance account?”
“What's the shortest refresh interval I can schedule for a monitored account?”
Tell an agent
Start monitoring pull {pull} on team {team}, refreshing every {interval}.
Monitor pull {pull} every {interval} and stop after {stop}.
PATCH /teams/{teamId}/monitorings/{monitoringId} Change a monitoring's schedule or status · PATCH /monitorings/:monitoringId #
Ask an LLM
“How do I change how often an existing monitoring refreshes?”
“Can I move the next refresh date or set an end date on a monitoring I already have?”
Tell an agent
Change monitoring {monitoring} on team {team} to refresh every {interval}.
Set the next refresh of monitoring {monitoring} to {date}.
DELETE /teams/{teamId}/monitorings/{monitoringId} Stop a monitoring · DELETE /monitorings/:monitoringId #
Ask an LLM
“How do I stop refreshing a monitored insurance account?”
“Can I pause monitoring on an account without deleting the pull?”
Tell an agent destructive · confirm first
Stop monitoring {monitoring} on team {team}.
Pause the refresh schedule for monitoring {monitoring}.
GET /teams/{teamId}/monitorings/{monitoringId} Get a monitoring and its pulls · GET /monitorings/:monitoringId #
Ask an LLM
“How do I see the details of one monitored insurance account?”
“Can I include the history of pulls when fetching a single monitoring?”
Tell an agent
Get monitoring {monitoring} on team {team}.
Show monitoring {monitoring} with its pulls included.
GET /teams/{teamId}/monitorings/{monitoringId}/reconnectToken Generate a reconnect token for a monitoring · GET /monitorings/:monitoringId/reconnectToken #
Ask an LLM
“How do I get a token to send a consumer back to reconnect a monitored account?”
“What do I use when a monitored account needs the user to log in again?”
Tell an agent
Generate a reconnect token for monitoring {monitoring} on team {team}.
Get a reconnect token so the user can fix monitoring {monitoring}.
POST /teams/{teamId}/monitorings/{monitoringId}/refresh Refresh a monitored account now · POST /monitorings/:monitoringId/refresh #
Ask an LLM
“Can I refresh a monitored insurance account right away instead of waiting for the schedule?”
“How do I trigger an on-demand refresh of a connected policy?”
Tell an agent
Refresh monitoring {monitoring} on team {team} now.
Trigger an immediate data refresh for monitoring {monitoring}.
GET /teams/{teamId}/monitorings/{monitoringId}/events Get changes between a monitoring's last two pulls · GET /monitorings/:monitoringId/events #
Ask an LLM
“What changed on a monitored policy between its two most recent refreshes?”
“Does seeing monitoring change events require a special plan?”
Tell an agent
Show the events for monitoring {monitoring} on team {team}.
List what changed between the last two pulls of monitoring {monitoring}.

Documentation

📖
Documentation
https://docs.usecanopy.com/reference/getting-started
📖
APIReference
https://docs.usecanopy.com/reference
📖
GettingStarted
https://docs.usecanopy.com/reference/getting-started
📖
Authentication
https://raw.githubusercontent.com/api-evangelist/canopy/refs/heads/main/authentication/canopy-authentication.yml
📖
RateLimits
https://raw.githubusercontent.com/api-evangelist/canopy/refs/heads/main/rate-limits/canopy-rate-limits.yml

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/canopy/refs/heads/main/openapi/canopy-monitorings-api-api-openapi.yml

Other Resources

🔗
Website
https://www.usecanopy.com/
🔗
OAuthScopes
https://raw.githubusercontent.com/api-evangelist/canopy/refs/heads/main/scopes/canopy-scopes.yml
🔗
ErrorCatalog
https://raw.githubusercontent.com/api-evangelist/canopy/refs/heads/main/errors/canopy-problem-types.yml
🔗
Conventions
https://raw.githubusercontent.com/api-evangelist/canopy/refs/heads/main/conventions/canopy-conventions.yml
🔗
Conformance
https://raw.githubusercontent.com/api-evangelist/canopy/refs/heads/main/conformance/canopy-conformance.yml
🔗
DataModel
https://raw.githubusercontent.com/api-evangelist/canopy/refs/heads/main/data-model/canopy-data-model.yml
🔗
Examples
https://raw.githubusercontent.com/api-evangelist/canopy/refs/heads/main/examples/canopy-examples.yml
🔗
Lifecycle
https://raw.githubusercontent.com/api-evangelist/canopy/refs/heads/main/lifecycle/canopy-lifecycle.yml
🔗
Webhooks
https://raw.githubusercontent.com/api-evangelist/canopy/refs/heads/main/asyncapi/canopy-webhooks.yml
🔗
ToolCrosswalk
https://raw.githubusercontent.com/api-evangelist/canopy/refs/heads/main/mcp/canopy-tool-crosswalk.yml
🔗
Security
https://www.usecanopy.com/security

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API 
curl "https://apis.io/api/v1/apis/canopy:canopy-monitorings-api-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

canopy-monitorings-api-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: Reference Monitorings API
  version: 1.0.0
  description: Canopy Connect Public API Documentation
  contact:
    name: Canopy Connect
    email: support@usecanopy.com
    url: https://usecanopy.com/
  license:
    name: Apache 2.0
    url: http://www.apache.org/licenses/LICENSE-2.0.html
servers:
- url: https://app.usecanopy.com/api/v1.0.0
security:
- BasicAuth: []
tags:


# --- truncated at 32 KB (32 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/canopy/refs/heads/main/openapi/canopy-monitorings-api-api-openapi.yml