Sweep

Sweep Third Party Funnels API

The ThirdPartyFunnels API from Sweep — 2 operation(s) for thirdpartyfunnels.

GitHub OpenAPI

Operations 4

GET /third-party-funnels Third party funnels controller get all funnels #
POST /third-party-funnels Third party funnels controller create funnel #
PUT /third-party-funnels/{thirdPartyFunnelId} Third party funnels controller update third party funnel #
DELETE /third-party-funnels/{thirdPartyFunnelId} Third party funnels controller delete third party funnel #

Documentation

📖
APIReference
https://api.sweep.io/api
📖
Authentication
https://artifacts.apis.io/sweep/authentication/sweep-authentication.yml

Specifications

⚙
OpenAPI
https://artifacts.apis.io/sweep/openapi/sweep-thirdpartyfunnels-api-openapi.yml

Other Resources

🔗
Conventions
https://artifacts.apis.io/sweep/conventions/sweep-conventions.yml
🔗
DataModel
https://artifacts.apis.io/sweep/data-model/sweep-data-model.yml
🔗
ErrorCatalog
https://artifacts.apis.io/sweep/errors/sweep-problem-types.yml

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/sweep:sweep-thirdpartyfunnels-api"
All apis 
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.

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

sweep-thirdpartyfunnels-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: Sweep Third Party 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: ThirdPartyFunnels
paths:
  /third-party-funnels:
    get:
      operationId: ThirdPartyFunnelsController_getAllFunnels
      parameters: []
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/ThirdPartyFunnelDto'
      security:
      - bearer: []
      tags:
      - ThirdPartyFunnels
      summary: Third party funnels controller get all funnels
      x-summary-source: derived
    post:
      operationId: ThirdPartyFunnelsController_createFunnel
      parameters: []
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpsertThirdPartyFunnelDto'
      responses:
        '201':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ThirdPartyFunnelDto'
      security:
      - bearer: []
      tags:
      - ThirdPartyFunnels
      summary: Third party funnels controller create funnel
      x-summary-source: derived
  /third-party-funnels/{thirdPartyFunnelId}:
    put:
      operationId: ThirdPartyFunnelsController_updateThirdPartyFunnel
      parameters:
      - name: thirdPartyFunnelId
        required: true
        in: path
        schema:
          type: string
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpsertThirdPartyFunnelDto'
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ThirdPartyFunnelDto'
      security:
      - bearer: []
      tags:
      - ThirdPartyFunnels
      summary: Third party funnels controller update third party funnel
      x-summary-source: derived
    delete:
      operationId: ThirdPartyFunnelsController_deleteThirdPartyFunnel
      parameters:
      - name: thirdPartyFunnelId
        required: true
        in: path
        schema:
          type: string
      responses:
        '200':
          description: ''
      security:
      - bearer: []
      tags:
      - ThirdPartyFunnels
      summary: Third party funnels controller delete third party funnel
      x-summary-source: derived
components:
  schemas:
    StepPositionDto:
      type: object
      properties:
        row:
          type: number
        column:
          type: number
      required:
      - row
      - column
    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
    ThirdPartySystemDto:
      type: object
      properties:
        name:
          type: string
        domain:
          type: string
      required:
      - name
      - domain
    ThirdPartyStepsDto:
      type: object
      properties:
        id:
          type: string
        name:
          type: string
        stepConnections:
          type: array
          items:
            $ref: '#/components/schemas/StepConnectionDto'
        funnelLinks:
          type: array
          items:
            $ref: '#/components/schemas/FunnelLinkDto'
        position:
          $ref: '#/components/schemas/StepPositionDto'
      required:
      - id
      - name
      - stepConnections
      - funnelLinks
      - position
    UpsertThirdPartyFunnelDto:
      type: object
      properties:
        name:
          type: string
        description:
          type: string
        system:
          $ref: '#/components/schemas/ThirdPartySystemDto'
        steps:
          type: array
          items:
            $ref: '#/components/schemas/ThirdPartyStepsDto'
        funnelLinks:
          type: array
          items:
            $ref: '#/components/schemas/FunnelLinkDto'
      required:
      - name
      - description
      - steps
      - funnelLinks
    StepConnectionDto:
      type: object
      properties:
        _id:
          type: string
        targetId:
          type: string
      required:
      - _id
      - targetId
    ThirdPartyFunnelDto:
      type: object
      properties:
        id:
          type: string
        name:
          type: string
        description:
          type: string
        system:
          $ref: '#/components/schemas/ThirdPartySystemDto'
        steps:
          type: array
          items:
            $ref: '#/components/schemas/ThirdPartyStepsDto'
        funnelLinks:
          type: array
          items:
            $ref: '#/components/schemas/FunnelLinkDto'
      required:
      - id
      - name
      - description
      - steps
      - funnelLinks
  securitySchemes:
    bearer:
      scheme: bearer
      bearerFormat: JWT
      type: http