How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Need help?

Contact us
Sweep

Sweep Funnels API

The Funnels API from Sweep — 9 operation(s) for funnels.

Documentation Provider Profile APIs.io OpenAPI GitHub

Sweep Funnels API is one of 70 APIs that Sweep publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Funnels. The published artifact set on APIs.io includes an OpenAPI specification, an API reference, and authentication docs.

This API exposes 14 operations across 9 paths, and defines 22 schemas. It is described by OpenAPI 3.2.0, at version 0.1.

Requests are made against a single base URL, https://api.sweep.io.

14 operations 9 paths 22 schemas 1 DELETE6 GET2 PATCH3 POST2 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
0.1
Base URL
https://api.sweep.io
Authentication
HTTP Bearer
Resource Areas
1

Authentication & Security 1

Sweep Funnels API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (JWT) (bearer).

Paths & Operations 14

Across 9 paths, the API surfaces 14 operations — 1 DELETE, 6 GET, 2 PATCH, 3 POST, 2 PUT. Each is listed below with its method, path, parameters, and response codes.

Funnels 14
GET
/funnels/funnel-name-availability
Returns all funnels.
FunnelsController_checkFunnelNameAvailability 3 params → 200
POST
/funnels
Creates a new funnel. New funnel is created with default version name - V1
FunnelsController_createFunnel 1 param body → 201
POST
/funnels/convert-record-type
Creates a new funnel from a record type.
FunnelsController_convertRecordTypeToFunnel body → 201
GET
/funnels/funnel-from-record-type
Given a record type, Returns a funnel id if the funnel exists and its snapshot and deployment id if it's deployed
FunnelsController_getFunnelAndSnapshotIdFromRecordType 3 params → 200
GET
/funnels/{funnelId}/snapshots
get all snapshots of a specific funnel
FunnelsController_getFunnelSnapshots 1 param → 200
POST
/funnels/{funnelId}/snapshots
@body - either a funnel id or a funnelDto for saving
FunnelsController_createFunnelSnapshot 1 param → 201
GET
/funnels/{funnelId}/snapshots/{snapshotId}
get a snapshot
FunnelsController_getFunnelSnapshot 2 params → 200
PATCH
/funnels/{funnelId}/snapshots/{snapshotId}
rename a snapshot
FunnelsController_setSnapshotName 2 params body → 200
GET
/funnels/{funnelId}
Returns a single funnel.
FunnelsController_getFunnel 1 param → 200
PATCH
/funnels/{funnelId}
Will replace Update funnel properties. For example, if we want to create a snapshot of a previous state and restore state form If funnelDetails is included in the payload it is overridden. if it's //…
FunnelsController_updateFunnel 1 param body → 200
PUT
/funnels/{funnelId}
For Restoring snapshots. Resets a funnel's details/state. The override request contains a reference to a past snapshot.
FunnelsController_restoreSnapshot 1 param body → 200
DELETE
/funnels/{funnelId}
Delete a funnel.
FunnelsController_deleteFunnel 1 param → 200
GET
/funnels/{funnelId}/recordTypes
FunnelsController_getRecordTypes 1 param → 200
PUT
/funnels/{funnelId}/biSettings
Update BI settings of funnel.
FunnelsController_updateBISettings 1 param body → 200

Schemas 22

The contract defines 22 schemas that model the data the API accepts and returns. The most detailed are FunnelDto (18 properties), FunnelDeploymentDto (13 properties), SweepStage (12 properties), FunnelSnapshotDto (8 properties). Each schema is shown below with its type and property counts.

SweepFieldReference
object
2 properties 1 required
FunnelDetailsDto
object
6 properties 3 required
FunnelRecordTypeDto
object
4 properties 4 required
SweepAssignmentRule
object
6 properties 6 required
LeadingFieldDto
object
3 properties 3 required
SweepExitCriteria
object
6 properties 3 required
RestoreFunnelDto
object
2 properties 2 required
FunnelLinkDto
object
4 properties 3 required
LeadingObjectDto
object
4 properties 3 required
ConvertRecordTypeToFunnelDto
object
6 properties 5 required
CreateFunnelDto
object
2 properties 2 required
FunnelRecordTypesDto
object
1 property 1 required
FunnelDeploymentDto
object
13 properties 13 required
SweepStage
object
12 properties 5 required
BIFlagDto
object
2 properties 2 required
FunnelSnapshotDto
object
8 properties 8 required
UpdateFunnelDto
object
3 properties 3 required
RecordTypeDto
object
4 properties 4 required
FunnelDto
object
18 properties 17 required
BISettingsDto
object
1 property 1 required
UpdateFunnelSnapshotDto
object
1 property 1 required
FunnelPluginsDto
object

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

sweep-funnels-api-openapi.yml Raw ↑

Other APIs Sweep publishes across the network.

Sweep MCP Server
AE Profile APIs.io
Sweep Account Selection API
AE Profile APIs.io
Sweep Agentic Features API
AE Profile APIs.io
Sweep Ai Agents API
AE Profile APIs.io
Sweep AI Artifacts (unauthenticated) API
AE Profile APIs.io
Sweep AI Attachments API
AE Profile APIs.io
Sweep AI Prompts API
AE Profile APIs.io
Sweep AI Retrievers API
AE Profile APIs.io
Sweep AI Session API
AE Profile APIs.io
Sweep AI Stream API
AE Profile APIs.io
Sweep AI User Skills API
AE Profile APIs.io
Sweep Assignment Groups API
AE Profile APIs.io
#Funnels
← Back to S APIs
API Details
ID
sweep:sweep-funnels-api
Base URL
https://api.sweep.io
Docs
https://api.sweep.io/api
Provider
Sweep
APIs.io →  GitHub →
Explore more
All APIs Providers APIs.io Network
Work with this as data

Every API here is available over the API and to AI agents over MCP. APIs is not yet its own endpoint on the v1 API. Reach this content through network search and the tag graph, or the MCP server below.

Installs https://mcp.apievangelist.com/mcp in Claude, Cursor, VS Code and the rest — one button, every client.

MCP tools for apis
4 tools reach this content
  • search_api_evangelistSearch every content type across the network at once.
  • find_relatedThe shared-tag relevance graph — what else covers this.
  • get_tagEverything one tag labels, across all content types.
  • guide_topicPRO — a curated bundle for a topic: area, guidance, rules, papers, stories, services.
All tools & prompts
Call it yourself
curl for this page
Search the network for this 
curl "https://api.apievangelist.com/v1/search?q=sweep-funnels-api&limit=10"
Everything under a tag 
curl "https://api.apievangelist.com/v1/tags/sweep-funnels-api"

Discovery needs no key. Full bodies and the synthesis endpoints are Pro.

Get an API key

Free tier, no email required. Sign in with whichever identity you already have.

GitHub Google LinkedIn

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

Where this information came from

This is an independent, third-party profile of Sweep Funnels API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.