The Funnels API from Sweep — 9 operation(s) for funnels.
Every API here is available over the APIs.io API and to AI agents over MCP.
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
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.curl "https://apis.io/api/v1/apis/sweep:sweep-funnels-api"curl "https://apis.io/api/v1/apis?limit=25"Calls without X-API-Key need no key. Calls with it need a paid plan — get a 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.
A second provider on the same verified email joins the account you already have.
openapi: 3.2.0
info:
title: Sweep Funnels API
description: This is a publicly available Sweep API.
version: '0.1'
contact: {}
servers:
- url: https://api.sweep.io
description: Sweep production API — the host this document was harvested from (GET /api-json); /health responds here
tags:
- name: Funnels
paths:
/funnels/funnel-name-availability:
get:
operationId: FunnelsController_checkFunnelNameAvailability
parameters:
- name: funnelName
required: true
in: query
schema:
type: string
- name: objectName
required: true
in: query
schema:
type: string
- name: funnelId
required: true
in: query
schema:
type: string
responses:
'200':
description: ''
security:
- bearer: []
summary: Returns all funnels
tags:
- Funnels
/funnels:
post:
operationId: FunnelsController_createFunnel
parameters:
- name: crmOrgId
required: true
in: query
schema:
type: string
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/CreateFunnelDto'
responses:
'201':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/FunnelDto'
security:
- bearer: []
summary: Creates a new funnel. New funnel is created with default version name - V1
tags:
- Funnels
/funnels/convert-record-type:
post:
operationId: FunnelsController_convertRecordTypeToFunnel
parameters: []
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/ConvertRecordTypeToFunnelDto'
responses:
'201':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/FunnelDto'
security:
- bearer: []
summary: Creates a new funnel from a record type
tags:
- Funnels
/funnels/funnel-from-record-type:
get:
operationId: FunnelsController_getFunnelAndSnapshotIdFromRecordType
parameters:
- name: recordTypeName
required: true
in: query
schema:
type: string
- name: objectName
required: true
in: query
schema:
type: string
- name: crmOrgId
required: true
in: query
schema:
type: string
responses:
'200':
description: ''
content:
application/json:
schema:
type: object
security:
- bearer: []
summary: Given a record type, Returns a funnel id if the funnel exists and its snapshot…
tags:
- Funnels
/funnels/{funnelId}/snapshots:
get:
operationId: FunnelsController_getFunnelSnapshots
parameters:
- name: funnelId
required: true
in: path
schema:
type: string
responses:
'200':
description: ''
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/FunnelSnapshotDto'
security:
- bearer: []
summary: get all snapshots of a specific funnel
tags:
- Funnels
post:
operationId: FunnelsController_createFunnelSnapshot
parameters:
- name: funnelId
required: true
in: path
schema:
type: string
responses:
'201':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/FunnelSnapshotDto'
security:
- bearer: []
summary: '@body - either a funnel id or a funnelDto for saving'
tags:
- Funnels
/funnels/{funnelId}/snapshots/{snapshotId}:
get:
operationId: FunnelsController_getFunnelSnapshot
parameters:
- name: funnelId
required: true
in: path
schema:
type: string
- name: snapshotId
required: true
in: path
schema:
type: string
responses:
'200':
description: ''
content:
application/json:
schema:
type: object
security:
- bearer: []
summary: get a snapshot
tags:
- Funnels
patch:
operationId: FunnelsController_setSnapshotName
parameters:
- name: funnelId
required: true
in: path
schema:
type: string
- name: snapshotId
required: true
in: path
schema:
type: string
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/UpdateFunnelSnapshotDto'
responses:
'200':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/FunnelSnapshotDto'
security:
- bearer: []
summary: rename a snapshot
tags:
- Funnels
/funnels/{funnelId}:
get:
operationId: FunnelsController_getFunnel
parameters:
- name: funnelId
required: true
in: path
schema:
type: string
responses:
'200':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/FunnelDto'
security:
- bearer: []
summary: Returns a single funnel
tags:
- Funnels
patch:
operationId: FunnelsController_updateFunnel
parameters:
- name: funnelId
required: true
in: path
schema:
type: string
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/UpdateFunnelDto'
responses:
'200':
description: ''
content:
application/json:
schema:
type: object
security:
- bearer: []
summary: Will replace Update funnel properties.
tags:
- Funnels
put:
operationId: FunnelsController_restoreSnapshot
parameters:
- name: funnelId
required: true
in: path
schema:
type: string
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/RestoreFunnelDto'
responses:
'200':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/FunnelDto'
security:
- bearer: []
summary: For Restoring snapshots.
tags:
- Funnels
delete:
operationId: FunnelsController_deleteFunnel
parameters:
- name: funnelId
required: true
in: path
schema:
type: string
responses:
'200':
description: ''
security:
- bearer: []
summary: Delete a funnel
tags:
- Funnels
/funnels/{funnelId}/recordTypes:
get:
operationId: FunnelsController_getRecordTypes
parameters:
- name: funnelId
required: true
in: path
schema:
type: string
responses:
'200':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/FunnelRecordTypesDto'
security:
- bearer: []
tags:
- Funnels
summary: Funnels controller get record types
x-summary-source: derived
/funnels/{funnelId}/biSettings:
put:
operationId: FunnelsController_updateBISettings
parameters:
- name: funnelId
required: true
in: path
schema:
type: string
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/BISettingsDto'
responses:
'200':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/BISettingsDto'
security:
- bearer: []
summary: Update BI settings of funnel
tags:
- Funnels
components:
schemas:
BIFlagDto:
type: object
properties:
name:
type: string
enum:
- TIMESTAMP
- OWNER
- OWNER_ROLE
value:
type: boolean
required:
- name
- value
UpdateFunnelDto:
type: object
properties:
name:
type: string
description:
type: string
funnelDetails:
$ref: '#/components/schemas/FunnelDetailsDto'
required:
- name
- description
- funnelDetails
FunnelRecordTypesDto:
type: object
properties:
recordTypes:
type: array
items:
$ref: '#/components/schemas/RecordTypeDto'
required:
- recordTypes
FunnelSnapshotDto:
type: object
properties:
apiName:
type: string
id:
type: string
name:
type: string
createdAt:
format: date-time
type: string
createdById:
type: string
ord:
type: number
funnelDetails:
$ref: '#/components/schemas/FunnelDetailsDto'
deployments:
type: array
items:
$ref: '#/components/schemas/FunnelDeploymentDto'
required:
- apiName
- id
- name
- createdAt
- createdById
- ord
- funnelDetails
- deployments
FunnelDetailsDto:
type: object
properties:
leadingObject:
$ref: '#/components/schemas/LeadingObjectDto'
stages:
type: array
items:
$ref: '#/components/schemas/SweepStage'
_firstStageId:
type: string
plugins:
default: {}
allOf:
- $ref: '#/components/schemas/FunnelPluginsDto'
funnelLinks:
type: array
items:
$ref: '#/components/schemas/FunnelLinkDto'
stageMetadata:
type: array
items:
type: object
required:
- leadingObject
- stages
- plugins
CreateFunnelDto:
type: object
properties:
funnelName:
type: string
templateDetails:
$ref: '#/components/schemas/FunnelDetailsDto'
required:
- funnelName
- templateDetails
ConvertRecordTypeToFunnelDto:
type: object
properties:
funnelName:
type: string
recordTypeName:
type: string
recordTypeDescription:
type: string
objectName:
type: string
leadingField:
$ref: '#/components/schemas/LeadingFieldDto'
defaultCrmOrgId:
type: string
required:
- funnelName
- recordTypeName
- objectName
- leadingField
- defaultCrmOrgId
FunnelDto:
type: object
properties:
id:
type: string
apiName:
type: string
accountId:
type: string
crmOrgId:
type: string
name:
type: string
funnelDetails:
$ref: '#/components/schemas/FunnelDetailsDto'
restoredFromSnapshot:
type: number
createdById:
type: string
updatedById:
type: string
createdAt:
format: date-time
type: string
updatedAt:
format: date-time
type: string
biSettings:
$ref: '#/components/schemas/BISettingsDto'
pendingChanges:
type: boolean
isDeployed:
type: boolean
recordType:
deprecated: true
allOf:
- $ref: '#/components/schemas/FunnelRecordTypeDto'
description:
type: string
sweepFields:
type: object
fieldUsage:
type: object
required:
- id
- apiName
- accountId
- crmOrgId
- name
- funnelDetails
- restoredFromSnapshot
- createdById
- updatedById
- createdAt
- updatedAt
- biSettings
- pendingChanges
- isDeployed
- recordType
- description
- fieldUsage
RecordTypeDto:
type: object
properties:
name:
type: string
objectName:
type: string
label:
type: string
description:
type: string
required:
- name
- objectName
- label
- description
LeadingFieldDto:
type: object
properties:
name:
type: string
label:
type: string
values:
type: array
items:
type: object
required:
- name
- label
- values
FunnelDeploymentDto:
type: object
properties:
id:
type: string
crmOrgId:
type: string
crmOrgName:
type: string
crmOrgIsSandbox:
type: boolean
snapshotName:
type: string
deployedById:
type: string
deployedAt:
format: date-time
type: string
snapshot:
$ref: '#/components/schemas/FunnelSnapshotDto'
apiName:
type: string
name:
type: string
moreAdvancedDraft:
type: boolean
moreAdvancedSnapshots:
type: number
status:
type: object
required:
- id
- crmOrgId
- crmOrgName
- crmOrgIsSandbox
- snapshotName
- deployedById
- deployedAt
- snapshot
- apiName
- name
- moreAdvancedDraft
- moreAdvancedSnapshots
- status
FunnelLinkDto:
type: object
properties:
_id:
type: string
_type:
type: string
enum:
- salesforce
- thirdParty
- recordType
- hubspot
- metadataElement
funnelId:
type: string
stageId:
type: string
required:
- _id
- _type
- funnelId
UpdateFunnelSnapshotDto:
type: object
properties:
name:
type: string
required:
- name
SweepAssignmentRule:
type: object
properties:
assignmentId:
type: string
ruleName:
type: string
assignedTo:
type: string
assignedToType:
type: string
criteriaLogic:
type: string
criteria:
type: array
items:
type: object
required:
- assignmentId
- ruleName
- assignedTo
- assignedToType
- criteriaLogic
- criteria
SweepStage:
type: object
properties:
stageName:
type: string
_stageId:
type: string
stageDescription:
type: string
_branchIndex:
type: number
_stageColumnIndex:
type: number
exitCriteria:
type: array
items:
$ref: '#/components/schemas/SweepExitCriteria'
assignmentRules:
type: array
items:
$ref: '#/components/schemas/SweepAssignmentRule'
_team:
type: string
stageType:
type: string
enum:
- regular
- lost
- nurturing
preventBackwardStages:
type: boolean
funnelLinks:
type: array
items:
$ref: '#/components/schemas/FunnelLinkDto'
additionalFields:
default: []
type: array
items:
$ref: '#/components/schemas/SweepFieldReference'
required:
- stageName
- _stageId
- stageDescription
- exitCriteria
- assignmentRules
SweepExitCriteria:
type: object
properties:
_exitCriteriaId:
type: string
_nextStageId:
type: string
isAutoMoveToNextStage:
type: boolean
guidance:
type: string
criteria:
type: array
items:
type: object
criteriaLogic:
type: string
required:
- _exitCriteriaId
- criteria
- criteriaLogic
FunnelPluginsDto:
type: object
properties: {}
BISettingsDto:
type: object
properties:
flags:
type: array
items:
$ref: '#/components/schemas/BIFlagDto'
required:
- flags
LeadingObjectDto:
type: object
properties:
objectName:
type: string
fieldName:
type: string
_leadingFieldLabels:
type: array
items:
type: string
_leadingFieldId:
type: string
required:
- objectName
- fieldName
- _leadingFieldId
SweepFieldReference:
type: object
properties:
fieldIds:
type: array
items:
type: string
fieldSource:
type: string
required:
- fieldIds
FunnelRecordTypeDto:
type: object
properties:
name:
type: string
objectName:
type: string
label:
type: string
description:
type: string
required:
- name
- objectName
- label
- description
RestoreFunnelDto:
type: object
properties:
sourceSnapshotId:
type: string
preserveCurrent:
type: boolean
required:
- sourceSnapshotId
- preserveCurrent
securitySchemes:
bearer:
scheme: bearer
bearerFormat: JWT
type: http