Canopy Connect

Canopy Connect Pulls API

Get Pull data and download documents

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}/pulls/{pullId} Get all data for a pull · GET /pulls/:pullId #
Ask an LLM
“How do I fetch everything collected from a consumer's insurance connection?”
“Can I also get property data when retrieving a single pull?”
Tell an agent
Get pull {pull} on team {team}.
Fetch pull {pull} and include property data: {prop}.
PATCH /teams/{teamId}/pulls/{pullId} Archive or unarchive a pull · PATCH /pulls/:pullId #
Ask an LLM
“How do I archive a pull I no longer need to see?”
“Can I restore an archived pull?”
Tell an agent
Archive pull {pull} on team {team}.
Set archived to {archived} on pull {pull}.
GET /teams/{teamId}/pulls List a team's pulls · GET /pulls #
Ask an LLM
“Which insurance pulls has my team received recently?”
“Can I list pulls between two dates?”
Tell an agent
List the pulls on team {team}.
List pulls on team {team} since {since}.
GET /teams/{teamId}/pulls/{pullId}/documents/{documentId}/pdf Download a pull document PDF (deprecated) · GET /:documentId/pdf #
Ask an LLM
“Is there a legacy PDF route for downloading a document from a pull?”
“What replaced the deprecated document PDF download endpoint?”
Tell an agent
Download document {document} from pull {pull} on team {team} as a PDF using the deprecated route.
Stream the PDF of document {document} through the older pdf endpoint.
GET /teams/{teamId}/pulls/{pullId}/documents/{documentId} Download a document from a pull · GET /:documentId #
Ask an LLM
“How do I download an insurance document like a declarations page from a pull?”
“Does a document download return a short-lived signed link?”
Tell an agent
Download document {document} from pull {pull} on team {team}.
Get the signed download link for document {document} on pull {pull}.
GET /teams/{teamId}/pulls/{pullId}/answers/{answerId}/files/{fileId} Download a file the consumer uploaded · GET /:fileId #
Ask an LLM
“How can I get a file a consumer uploaded in answer to a question?”
“Where do I download files from a file upload answer on a pull?”
Tell an agent
Download file {file} from answer {answer} on pull {pull} for team {team}.
Get the consumer's uploaded file {file} attached to answer {answer}.
POST /teams/{teamId}/pulls/{pullId}/policyCheck Run a Policy Check on a pull · POST /policyCheck #
Ask an LLM
“How do I evaluate a Policy Check against one specific pull?”
“Can I restrict which entities a Policy Check evaluates on a pull?”
Tell an agent
Run a Policy Check on pull {pull} for team {team}.
Evaluate pull {pull} with Policy Check settings {settings} limited by {filters}.
GET /teams/{teamId}/pulls/{pullId}/policyCheck/pdf Download a pull's Policy Check PDF · GET /policyCheck/pdf #
Ask an LLM
“Can I get the Policy Check results for a pull as a PDF report?”
“Where do I download the Policy Check report for a pull?”
Tell an agent
Download the Policy Check PDF for pull {pull} on team {team}.
Get the Policy Check report PDF of pull {pull}.

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-pulls-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-pulls-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-pulls-api-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: Reference Pulls 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 (320 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/canopy/refs/heads/main/openapi/canopy-pulls-api-api-openapi.yml